TickableComponent.h

Go to the documentation of this file.

#pragma once
 
#include <stdint.h>
#include <memory>
#include <vector>
 
#include "ship/core/Tickable.h"
#include "ship/core/Component.h"
#include "ship/core/Action.h"
#include "ship/events/EventTypes.h"
 
namespace Ship {
 
class Context;
 
enum class TickGroup : uint32_t { TickGroupDefault = 0 };
 
enum class TickPriority : uint32_t { TickPriorityDefault = 0 };
 
class TickableComponent : public Tickable, public Component, public std::enable_shared_from_this<TickableComponent> {
  public:
    TickableComponent(const std::string& name, std::shared_ptr<Context> context,
                      const TickGroup tickGroup = TickGroup::TickGroupDefault,
                      const TickPriority tickPriority = TickPriority::TickPriorityDefault,
                      const std::vector<EventID>& eventIds = {});
 
    TickableComponent(const std::string& name, std::shared_ptr<Context> context, const TickGroup tickGroup,
                      const TickPriority tickPriority, const std::vector<std::shared_ptr<Action>>& actions);
    virtual ~TickableComponent();
 
    bool RegisterWithContext();
 
    void UnregisterFromContext();
 
    std::shared_ptr<Context> GetContext() const;
 
    TickGroup GetTickGroup() const;
 
    TickPriority GetTickPriority() const;
 
    uint64_t GetOrder() const;
 
    TickableComponent& SetTickGroup(const TickGroup tickGroup);
 
    TickableComponent& SetTickPriority(const TickPriority tickPriority);
 
    TickableComponent& SetContext(std::shared_ptr<Context> context);
 
    virtual bool ActionRan(EventID eventId);
 
  private:
    TickGroup mTickGroup;
    TickPriority mTickPriority;
    std::vector<EventID> mPendingEventIds;
    std::vector<std::shared_ptr<Action>> mPendingActions;
};
 
} // namespace Ship