Entity.h

/*
 * Gamedev Framework (gf)
 * Copyright (C) 2016-2021 Julien Bernard
 *
 * This software is provided 'as-is', without any express or implied
 * warranty.  In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 */
#ifndef GF_ENTITY_H
#define GF_ENTITY_H

#include "GraphicsApi.h"
#include "Time.h"

namespace gf {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
inline namespace v1 {
#endif

  struct RenderStates;
  class RenderTarget;

  class GF_GRAPHICS_API Entity {
  public:
    Entity(int priority = 0)
    : m_priority(priority)
    , m_liveness(Liveness::Alive)
    {
    }

    virtual ~Entity();

    void setPriority(int priority) {
      m_priority = priority;
    }

    int getPriority() const {
      return m_priority;
    }

    bool isAlive() const {
      return m_liveness == Liveness::Alive;
    }

    void setAlive() {
      m_liveness = Liveness::Alive;
    }

    void kill() {
      m_liveness = Liveness::Dead;
    }

    virtual void update(Time time);

    virtual void render(RenderTarget& target, const RenderStates& states);

  private:
    enum class Liveness : int {
      Alive,
      Dead,
    };

    int m_priority;
    Liveness m_liveness;
  };

#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
#endif
}

#endif // GF_ENTITY_H