Selector Class Reference

An indicator that loops through a parents' nodes children and can "select" them on keypress. More...

#include <Selector.h>

Inheritance diagram for Selector:

Collaboration diagram for Selector:

Public Member Functions
	Selector ()
	Selector (const Selector &)
auto	operator= (const Selector &) -> Selector &=default
	~Selector () override=default
	Selector (Selector &&other) noexcept
auto	operator= (Selector &&other) noexcept -> Selector &=default
auto	clone () const -> std::unique_ptr< GameObject > override
	makes a copy a GameObject even if it's held polymorphically
auto	componentShowMenu () -> void override
auto	onUpdate (float dt) -> void override
	called once every frame.
auto	onEnterEngine () -> void override
	hook that is called when a GameObject enters the Engine tree.
auto	endWindow () -> void override
	currently unused, but intended to but was assumed to be necessary for a proper ImGui editor
auto	onRender () -> void override
	called every frame after update has been called for every object.
auto	load (const Stream &stream) -> void override
	Implementations will load the state of a GameObject from a th::Json Object.
auto	save (Stream &stream) const -> void override
	Implementations will load the state of a GameObject to a th::Json object.
virtual auto	isValidID (int id) -> bool
	Virtual function used by FilteredSelector. Always returns true in Selector.
auto	select () -> void
	Selects the button that the selector is hovering over.
auto	setEnabled (bool state) -> void
virtual auto	linkMessages () -> void
virtual auto	receiveLeftKeyPressed (const Message *message) -> Message
virtual auto	receiveRightKeyPressed (const Message *message) -> Message
virtual auto	receiveUpKeyPressed (const Message *message) -> Message
virtual auto	receiveDownKeyPressed (const Message *message) -> Message
virtual auto	receiveSelectKeyPressed (const Message *message) -> Message
auto	moveUp (Menu *menu) -> void
	Helper function that actually moves the selector up in a menu.
auto	moveDown (Menu *menu) -> void
	Helper function that actually moves the selector down in a menu.
auto	moveLeft (Menu *menu) -> void
	Helper function that actually moves the selector left in a menu.
auto	moveRight (Menu *menu) -> void
	Helper function that actually moves the selector right in a menu.
Public Member Functions inherited from Component
auto	getType () const -> ComponentTypeEnum
auto	getKey () const -> Key override
	Generates a unique Key that corresponds to the GameObject.
auto	showMenu () -> void override
	Called before update each frame, for calling ImGui editor code relevant to the gameObject.
auto	getEntityParent () const -> Entity *
	gets the parent as an Entity.
Public Member Functions inherited from GameObject
	GameObject (std::string typeName, gobj::Type parentType, gobj::Type type)
	constructor for gameobject.
virtual	~GameObject ()
	destructor for GameObject.
	GameObject (const GameObject &other)
	Copy Constructor.
auto	operator= (const GameObject &other) -> GameObject &
	copy assignment operator
	GameObject (GameObject &&other) noexcept
	Move constructor.
auto	operator= (GameObject &&other) noexcept -> GameObject &
	Move assignment operator.
virtual auto	update (float dt) -> void
	called once every frame.
virtual auto	render () -> void
	called every frame after update has been called for every object.
virtual auto	destroy () -> void
	Marks an GameObject to be destroyed.
virtual auto	onSceneStart (const std::string &sceneName) -> void
	Hook that is called before the first frame a scene is run, but after the entire scene is loaded into the engine To receive the hook, simply override the function in your class.
virtual auto	onSceneExit (const std::string &sceneName) -> void
	Hook that is called right before a scene is unloaded To receive the hook, simply override the function in your class.
virtual auto	for_each (std::function< void(GameObject &)> func) -> void
	applies a function to every child.
virtual auto	for_each (std::function< void(const GameObject &)> func) const -> void
	applies a const function to every child.
virtual auto	getParent () const -> GameObject *
	Gets the parent of a GameObject.
virtual auto	parentTo (GameObject *newParent) -> bool
	Sets the GameObject as a child of another GameObject.
auto	getInternalParent () const -> GameObject *
	returns the actual owning parent of the GameObject
virtual auto	addChild (std::unique_ptr< GameObject > newChild) -> bool
	Adds a child to a GameObject.
auto	destroyed () const -> bool
auto	getUUID () const -> gobj::UUID
auto	isUUID (gobj::UUID compareUUID) const -> bool
auto	getName () const -> const std::string &
	Gets the type of the object as a string.
auto	getNickname () const -> const std::string &
	Gets the nickname (custom, writable name) of a GameObject.
auto	getFormattedName () const -> const std::string &
	combines a GameObjects Type, Nickname, and UUID into one string, for use with logging.
auto	nameEquals (const std::string &compareString) const -> bool
	check whether a GameObjects typeName is equivilent to a given string.
auto	isType (gobj::Type otherType) const -> bool
	check whether the GameObject is the same as a given type.
auto	getObjectType () const -> gobj::Type
	gets the internal type of the GameObject, as an enum
auto	setNickname (const std::string &newNickname) -> void
	sets the GameObjects nickname.
auto	updates () const -> bool
auto	renders () const -> bool
auto	receivesMessages () const -> bool
auto	isActive () const -> bool
virtual auto	setShouldUpdate (bool _shouldUpdate) -> void
	set whether the GameObject should update every frame, and whether all of it's children should update every frame
virtual auto	setShouldRender (bool _shouldRender) -> void
	set whether the GameObject should render every frame, and whether all of it's children should render every frame
virtual auto	setShouldReceiveMessages (bool _shouldReceiveMessages) -> void
	set whether the GameObject should Receive Messags, and whether all of it's children should receive messages
auto	setActive (bool shouldBeActive) -> void
	set the GameObject should update, render, and receive messages

Protected Member Functions
	Selector (const char *typeName)
	Protected constructor so FilteredSelector can set the name.
Protected Member Functions inherited from Component
	Component (ComponentTypeEnum type, const char *typeName)
auto	getComponentJson () const -> json
auto	getChildren () const -> std::shared_ptr< std::vector< GameObject * > > override
	override for component to return a vector of no children
Protected Member Functions inherited from GameObject
auto	setInternalParent (GameObject *parent) -> bool
	sets the internal parent of a GameObject directly, avoiding abstractions provided by ParentTo().
auto	getGameObjectJson () const -> json
	Used for serializing GameObjects.
auto	setGameObjectJson (const json &stream) -> void
	used for deserializing GameObjects
auto	checkAddToSceneHook () -> void
	Determine if the GameObject was recently added to the engine, and if it was, call onEngineEnter.

Protected Attributes
bool	enabled
	If the selector is disabled, it does not move around or select.

Private Member Functions
auto	moveToNewParent (Entity *newParent) -> void

Friends
auto	to_json (json &j, const Selector &s) ->void
auto	from_json (const json &j, Selector &s) ->void

Additional Inherited Members
Public Types inherited from Component
enum	ComponentTypeEnum : unsigned short {   cErrorType = 0 , cPhysics = 100 , cAnimation = 200 , cTransform = 300 ,   cCollider = 400 , cSprite = 500 , cBehavior = 600 , cTable = 650 ,   cCard = 700 , cDeck = 750 , cPlayer = 800 , cBoard = 850 ,   cScene = 900 , cPauseScene = 915 , cMainScene = 920 , cMainMenuScene = 925 ,   cConfirmDestructiveActionScene = 930 , cOptionsScene = 935 , cCreditsScene = 940 , cTutorialScene = 945 ,   cBackground = 950 , cSplashScreenScene = 955 , cWinScreenScene = 960 , cPlayerCountScene = 965 ,   cPlayerJoinScene = 970 , cFlags = 1000 , cSelectable = 1100 , cMenu = 1200 ,   cActionList = 1300 , cEntityMover = 1400 , cMenuItem = 1500 , cMenuPosition = 1525 ,   cSelector = 1600 , cButton = 1700 , cParticleGenerator = 2500 }
	This enum lists out every type of component we have. More...
Public Attributes inherited from GameObject
friend	Entity
friend	Node
friend	ChildrenHandeler
friend	Engine

Detailed Description

An indicator that loops through a parents' nodes children and can "select" them on keypress.

@Selector.h

Constructor & Destructor Documentation

Selector() [1/4]

Selector::Selector

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

Selector() [2/4]

Selector::Selector

(

const Selector &

other

)

Here is the call graph for this function:

~Selector()

Selector::~Selector ( )

overridedefault

Here is the call graph for this function:

Selector() [3/4]

Selector::Selector ( Selector && other )

noexcept

Here is the call graph for this function:

Selector() [4/4]

Selector::Selector ( const char * typeName )

protected

Protected constructor so FilteredSelector can set the name.

Here is the call graph for this function:

Member Function Documentation

clone()

auto Selector::clone ( ) const->std::unique_ptr< GameObject >

inlineoverridevirtual

makes a copy a GameObject even if it's held polymorphically

Warning

When overriding this function, make sure to set the parents object to this

Returns

a unique_ptr to a new stack allocated object that is a copy of the object

Implements GameObject.

Here is the call graph for this function:

componentShowMenu()

auto Selector::componentShowMenu ( ) ->void

overridevirtual

Reimplemented from Component.

Here is the caller graph for this function:

endWindow()

auto Selector::endWindow ( ) ->void

inlineoverridevirtual

currently unused, but intended to but was assumed to be necessary for a proper ImGui editor

Implements GameObject.

isValidID()

auto Selector::isValidID ( int id ) ->bool

virtual

Virtual function used by FilteredSelector. Always returns true in Selector.

Reimplemented in FilteredSelector.

linkMessages()

auto Selector::linkMessages ( ) ->void

virtual

Reimplemented in FilteredSelector.

Here is the call graph for this function:

Here is the caller graph for this function:

load()

auto Selector::load ( const Stream & stream ) ->void

overridevirtual

Implementations will load the state of a GameObject from a th::Json Object.

Unimplemented in GameObject

Parameters

stream

th::Json Object

Implements GameObject.

moveDown()

auto Selector::moveDown

(

Menu *

menu

)

->void

Helper function that actually moves the selector down in a menu.

Here is the call graph for this function:

Here is the caller graph for this function:

moveLeft()

auto Selector::moveLeft

(

Menu *

menu

)

->void

Helper function that actually moves the selector left in a menu.

Here is the call graph for this function:

Here is the caller graph for this function:

moveRight()

auto Selector::moveRight

(

Menu *

menu

)

->void

Helper function that actually moves the selector right in a menu.

Here is the call graph for this function:

Here is the caller graph for this function:

moveToNewParent()

auto Selector::moveToNewParent ( Entity * newParent ) ->void

private

Here is the call graph for this function:

Here is the caller graph for this function:

moveUp()

auto Selector::moveUp

(

Menu *

menu

)

->void

Helper function that actually moves the selector up in a menu.

Here is the call graph for this function:

Here is the caller graph for this function:

onEnterEngine()

void Selector::onEnterEngine ( ) ->void

overridevirtual

hook that is called when a GameObject enters the Engine tree.

The hook is called immediately after a GameObject's parent is called. Functionality may not be correct if an object was removed from the engine then re-added. To receive the hook, simply override the function in your class

Reimplemented from GameObject.

Here is the call graph for this function:

onRender()

auto Selector::onRender ( ) ->void

overridevirtual

called every frame after update has been called for every object.

Generally used for rendering an object to the screen, when applicable. Unimplemented in GameObject

Implements GameObject.

Here is the call graph for this function:

Here is the caller graph for this function:

onUpdate()

auto Selector::onUpdate ( float dt ) ->void

overridevirtual

called once every frame.

Generally used for timers, movement, condition checks, etc. Unimplemented in GameObject

Parameters

dt	the time in seconds that has elapsed

Implements GameObject.

Here is the caller graph for this function:

operator=() [1/2]

auto Selector::operator= ( const Selector & ) ->Selector &=default

default

Here is the call graph for this function:

operator=() [2/2]

auto Selector::operator= ( Selector && other ) ->Selector &=default

defaultnoexcept

Here is the call graph for this function:

receiveDownKeyPressed()

auto Selector::receiveDownKeyPressed ( const Message * message ) ->Message

virtual

Reimplemented in FilteredSelector.

Here is the call graph for this function:

Here is the caller graph for this function:

receiveLeftKeyPressed()

auto Selector::receiveLeftKeyPressed ( const Message * message ) ->Message

virtual

Reimplemented in FilteredSelector.

Here is the call graph for this function:

Here is the caller graph for this function:

receiveRightKeyPressed()

auto Selector::receiveRightKeyPressed ( const Message * message ) ->Message

virtual

Reimplemented in FilteredSelector.

Here is the call graph for this function:

Here is the caller graph for this function:

receiveSelectKeyPressed()

auto Selector::receiveSelectKeyPressed ( const Message * message ) ->Message

virtual

Reimplemented in FilteredSelector.

Here is the call graph for this function:

Here is the caller graph for this function:

receiveUpKeyPressed()

auto Selector::receiveUpKeyPressed ( const Message * message ) ->Message

virtual

Reimplemented in FilteredSelector.

Here is the call graph for this function:

Here is the caller graph for this function:

save()

auto Selector::save ( Stream & stream ) const->void

overridevirtual

Implementations will load the state of a GameObject to a th::Json object.

Unimplemented in GameObject

Parameters

stream

th::Json Object

Implements GameObject.

select()

auto Selector::select

(

)

->void

Selects the button that the selector is hovering over.

Here is the call graph for this function:

Here is the caller graph for this function:

setEnabled()

auto Selector::setEnabled ( bool state ) ->void

inline

Friends And Related Symbol Documentation

from_json

auto from_json ( const json & j, Selector & s )->void

friend

to_json

auto to_json ( json & j, const Selector & s )->void

friend

Member Data Documentation

enabled

bool Selector::enabled

protected

If the selector is disabled, it does not move around or select.

---

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

• /home/egrazil/sites/Brunot/The House/source/Component/Selector.h
• /home/egrazil/sites/Brunot/The House/source/Component/Selector.cpp