class hiro::Gadget

Overview

Visual part of module. Provides options for visualization, that do not interfere with data stored in Resource. More…

#include <Gadget.h>

class Gadget {
public:
    // fields

    const hiro::ResourceId RESOURCE_ID;

    // construction

    Gadget(const hiro::Resource* res);
    virtual ~Gadget();

    // methods

    virtual void Initialize();
    virtual void Terminate();
    virtual void GenerateGui(hiro::GuiGenerator& gui);
    virtual void Update(const float time_delta);
    virtual bool FocusCamera(glm::vec3& focus_point, glm::vec3& cam_position) const;
    virtual hiro::EventStatus KeyPressed(hiro::Key key, const hiro::ModKeys& mods, hiro::EventStatus status);
    virtual hiro::EventStatus KeyReleased(hiro::Key key, const hiro::ModKeys& mods, hiro::EventStatus status);
    virtual hiro::EventStatus MouseButtonPressed(hiro::MouseButton button, const hiro::ModKeys& mods, hiro::EventStatus status);
    virtual hiro::EventStatus MouseButtonReleased(hiro::MouseButton button, const hiro::ModKeys& mods, hiro::EventStatus status);
    virtual hiro::EventStatus MouseWheel(float offset, hiro::EventStatus status);
    virtual hiro::EventStatus MouseMoved(float x, float y, hiro::EventStatus status);
    virtual hiro::EventStatus ViewResized(uint32_t width, uint32_t height, hiro::EventStatus status);
    virtual void RenderTexts(hiro::draw::TextRenderer& t_renderer);
    hiro::Camera* GetCamera() const;
    virtual int32_t AddRenderer(const hiro::draw::PRenderer& renderer, const hiro::draw::PStyle& style, uint8_t layer = 0u) const;
    virtual void RemoveRenderer(int32_t renderer_id) const;
    hiro::draw::ProjectionParams GetProjectionParams() const;

    template <typename UnitType = Resource>
    const UnitType* GetResource() const;

    void SetViewarea(hiro::Viewarea* viewarea);
    bool SaveState() const;
    void SetNearFar(float near, float far) const;

protected:
    // methods

    void LoadState();
    virtual bool ReadFromStream(std::istream& str);
    virtual void WriteToStream(std::ostream& str) const;
    void DrawOnNextUpdate() const;
    uint32_t GetViewAreaId() const;
    static bool ReadStateVersion(std::istream& str, uint32_t expected_version);
    static void WriteStateVersion(std::ostream& str, uint32_t version);
};

Detailed Documentation

Visual part of module. Provides options for visualization, that do not interfere with data stored in Resource.

To unlock its powers, derive your custom Gadget and override functionality that you require.

Methods

virtual void Initialize()

Function invoked right after object creation to set up all properties.

virtual void Terminate()

Function invoked right before object destruction.

virtual void GenerateGui(hiro::GuiGenerator& gui)

Function invoked right after object initialization to define gui.

virtual void Update(const float time_delta)

Function invoked each time HIRO context is updated.

virtual bool FocusCamera(glm::vec3& focus_point, glm::vec3& cam_position) const

Function invoked when user requests to focus camera at this gadget.

Parameters:

focus_point	Point at which the camera should look at.
cam_position	Position of the camera.

Returns:

When the camera can be set correctly, the method should return true.

virtual hiro::EventStatus KeyPressed(hiro::Key key, const hiro::ModKeys& mods, hiro::EventStatus status)

The function invoked after the key press event, triggered by a user.

Parameters:

key	Identifier of key that was pressed.
mods	Set of modifier keys being held at the time of key press.
status	Whether the event was already processed by other object.

Returns: