Peoplemon  0.1.0
Peoplemon 3 game source documentation
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
game::menu::MoveInfoRow Class Reference

Menu row item for moves on the peoplemon info screen. More...

#include <MoveInfoRow.hpp>

+ Inheritance diagram for game::menu::MoveInfoRow:

Public Member Functions

virtual ~MoveInfoRow ()=default
 Destroy the Move Info Row object. More...
 
virtual glm::vec2 getSize () const override
 Returns the size of the menu item. More...
 

Static Public Member Functions

static bl::menu::Item::Ptr create (core::pplmn::MoveId move)
 Create a new move row. More...
 

Protected Member Functions

virtual void doCreate (bl::engine::Engine &engine) override
 Called at least once when the item is added to a menu. Should create required graphics primitives and return the transform to use. More...
 
virtual void doSceneAdd (bl::rc::Scene *overlay) override
 Called when the item should be added to the overlay. More...
 
virtual void doSceneRemove () override
 Called when the item should be removed from the overlay. More...
 
virtual bl::ecs::Entity getEntity () const override
 Returns the entity (or top level entity) of the item. More...
 
virtual void draw (bl::rc::scene::CodeScene::RenderContext &ctx) override
 Renders the item. More...
 

Detailed Description

Menu row item for moves on the peoplemon info screen.

Definition at line 17 of file MoveInfoRow.hpp.

Constructor & Destructor Documentation

◆ ~MoveInfoRow()

virtual game::menu::MoveInfoRow::~MoveInfoRow ( )
virtualdefault

Destroy the Move Info Row object.

Member Function Documentation

◆ create()

bl::menu::Item::Ptr game::menu::MoveInfoRow::create ( core::pplmn::MoveId  move)
static

Create a new move row.

Parameters
moveThe move to represent
Returns
bl::menu::Item::Ptr The new row

Definition at line 11 of file MoveInfoRow.cpp.

◆ doCreate()

void game::menu::MoveInfoRow::doCreate ( bl::engine::Engine &  engine)
overrideprotectedvirtual

Called at least once when the item is added to a menu. Should create required graphics primitives and return the transform to use.

Parameters
engineThe game engine instance

Definition at line 23 of file MoveInfoRow.cpp.

◆ doSceneAdd()

void game::menu::MoveInfoRow::doSceneAdd ( bl::rc::Scene *  overlay)
overrideprotectedvirtual

Called when the item should be added to the overlay.

Parameters
overlayThe overlay to add to

Definition at line 43 of file MoveInfoRow.cpp.

◆ doSceneRemove()

void game::menu::MoveInfoRow::doSceneRemove ( )
overrideprotectedvirtual

Called when the item should be removed from the overlay.

Definition at line 48 of file MoveInfoRow.cpp.

◆ draw()

void game::menu::MoveInfoRow::draw ( bl::rc::scene::CodeScene::RenderContext &  ctx)
overrideprotectedvirtual

Renders the item.

Parameters
ctxThe render context

Definition at line 56 of file MoveInfoRow.cpp.

◆ getEntity()

bl::ecs::Entity game::menu::MoveInfoRow::getEntity ( ) const
overrideprotectedvirtual

Returns the entity (or top level entity) of the item.

Definition at line 50 of file MoveInfoRow.cpp.

◆ getSize()

glm::vec2 game::menu::MoveInfoRow::getSize ( ) const
overridevirtual

Returns the size of the menu item.

Definition at line 21 of file MoveInfoRow.cpp.


The documentation for this class was generated from the following files: