A menu that organizes its parents' children (in the node) either horizontally or vertically. More...

#include <Menu.h>

Inheritance diagram for Menu:

Collaboration diagram for Menu:

Public Member Functions
	Menu (float gapSize, int widthSize, int heightSize, menuType typeMenu)
	Menu ()
	Menu (const Menu &)=default
auto	operator= (const Menu &) -> Menu &=default
	~Menu () override=default
	Menu (Menu &&other) noexcept=default
auto	operator= (Menu &&other) noexcept -> Menu &=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	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	onEnterEngine () -> void override
	hook that is called when a GameObject enters the Engine tree.
auto	load (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.
auto	width () const -> int
	Returns the width of the menu.
auto	height () const -> int
	Returns the height of the menu.
auto	createEmptyButton () -> std::unique_ptr< Entity >
	Creates an empty button, intended for filling the board.
auto	getTranslationOfIndex (int x, int y) -> Point2D
	Returns the translation of an item at given index.
auto	pushEntityHorizontal (Entity *entity) -> void
	Pushes an item to the first row of a menu, intended for the cards.
auto	pushEntity (Entity *entity) -> void
	A universal push function that automatically fills in empty spaces.
auto	removeEntity (int x, int y) -> void
	Removes a specific entity at given index.
auto	getAboveEntity (Entity entity) -> Entity
	When given an entity, it will return the one above in the menu.
auto	getBelowEntity (Entity entity) -> Entity
	When given an entity, it will return the one below in the menu.
auto	getLeftEntity (Entity entity) -> Entity
	When given an entity, it will return the one left in the menu.
auto	getRightEntity (Entity entity) -> Entity
	When given an entity, it will return the one right in the menu.
auto	getGamespacePositionForEntity (Entity *entity) const -> Vector4D
	Gets where an entity is in its gamespace position, based on where it is in the menu.
auto	getMenuElementPosition (Entity *entity) const -> std::pair< int, int >
	Returns the index of the entity in the menu.
auto	updateMenuChildren () -> void
	Resizes menu in memory, allocates new items, and then calls compact menu.
auto	compactMenu () -> void
	Visually shrinks the menu, intended for when an element gets removed.
auto	getButtonEntity (int x, int y) -> Entity *
	takes in a position, and gets the entitiy in the position, blocking overflow by locking to edges, or wrapping, based on type of menu @ todo fully document getButtonEntity
auto	deleteAllEntities () const -> void
	Deletes all entities inside of the grid.
auto	fillMenu () -> void
auto	linkMessages () -> void
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	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.
void	calculateFormattedName () const
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 (const 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 (const 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 (const bool _shouldReceiveMessages) -> void
	set whether the GameObject should Receive Messags, and whether all of it's children should receive messages
auto	setActive (const bool shouldBeActive) -> void
	set the GameObject should update, render, and receive messages

Private Member Functions
auto	arrangeEntityAccordingToPositionInMenu (Entity *entity) const -> void
	Moves an entity to its gamespace position, based on where it is in the menu.
auto	returnWrappedMenuPosition (int x, int y) -> Point2D
	Returns the menu position while accounting for wrapped logic, intended as a helper function for returnMenuPosition.
auto	returnDefaultMenuPosition (int x, int y) -> Point2D
	Returns the menu position while accounting for default logic, intended as a helper function for returnMenuPosition.
auto	returnButtonIndexWrapped (int x, int y) -> Entity *
	Returns the menu position while accounting for wrapped logic, intended as a helper function for getButtonEntity.
auto	returnButtonIndexDefault (int x, int y) -> Entity *
	Returns the menu position while accounting for default logic, intended as a helper function for getButtonEntity.
auto	getButtonPosition (Entity *ent) -> std::pair< int, int >
	takes in the entity and returns the index (x and y) of where it is in the menu
auto	repositionItems (std::vector< Entity * > ent, int column) -> void
	Visually arranges the entities in a given column, intended as a helper function for compactMenu.

Private Attributes
float	gapBetweenObjects = 0.01f
	How much visual space is put between objects in the menu.
int	maxMenuWidth = 3
	How wide menu grid is (how many objects it can hold horizontally).
int	maxMenuHeight = 3
	How tall the menu grid is (how many objects it can hold vertically).
menuType	type = menuType::mDefault
	How to tell if the menu wraps.
std::vector< std::vector< Entity * > >	buttons
	The managed items/entities for the menu.

Friends
auto	to_json (json &j, const Menu &m) ->void
auto	from_json (const json &j, Menu &m) ->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 , cFlags = 1000 , cSelectable = 1100 , cMenu = 1200 , cActionProxy = 1300 , cEntityMover = 1400 , cMenuItem = 1500 , cMenuPosition = 1525 , cSelector = 1600 , cButton = 1700 }
	This enum lists out every type of component we have. More...
Public Attributes inherited from GameObject
friend	Entity
friend	Node
friend	ChildrenHandeler
friend	Engine
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.

Detailed Description

A menu that organizes its parents' children (in the node) either horizontally or vertically.

Inherently supports 2D grids. Typically used with Button s and a Selector, but doesn't depend on them in any way

Author: Bryley Elder (bryle.nosp@m.y.el.nosp@m.der@d.nosp@m.igip.nosp@m.en.ed.nosp@m.u) pair programmed initial set-up, filled out in-depth functionality Aidan Hartman (aidan.nosp@m..har.nosp@m.tman@.nosp@m.digi.nosp@m.pen.e.nosp@m.du) Assisted Bryley with functionality, bug clean-up Ori Balashov (ori.b.nosp@m.alas.nosp@m.hov@d.nosp@m.igip.nosp@m.en.ed.nosp@m.u) pair programmed initial set-up

Date: 2026 / 01 / 23

Copyright: (c) Digipen 2026

Constructor & Destructor Documentation

◆ Menu() [1/4]

Menu::Menu	(	float	gapSize,
		int	widthSize,
		int	heightSize,
		menuType	typeMenu )

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Menu() [2/4]

Menu::Menu ( )

inline

Here is the call graph for this function:

◆ Menu() [3/4]

Menu::Menu ( const Menu & )

default

Here is the call graph for this function:

◆ ~Menu()

Menu::~Menu ( )

overridedefault

◆ Menu() [4/4]

Menu::Menu ( Menu && other )

defaultnoexcept

Here is the call graph for this function:

Member Function Documentation

◆ arrangeEntityAccordingToPositionInMenu()

auto Menu::arrangeEntityAccordingToPositionInMenu ( Entity * entity ) const->void

private

Moves an entity to its gamespace position, based on where it is in the menu.

Parameters

entity an entity in the menu

Here is the call graph for this function:

◆ clone()

auto Menu::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:

◆ compactMenu()

auto Menu::compactMenu ( ) ->void

Visually shrinks the menu, intended for when an element gets removed.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ componentShowMenu()

auto Menu::componentShowMenu ( ) ->void

overridevirtual

Reimplemented from Component.

Here is the call graph for this function:

◆ createEmptyButton()

auto Menu::createEmptyButton ( ) ->std::unique_ptr< Entity >

Creates an empty button, intended for filling the board.

Here is the call graph for this function:

◆ deleteAllEntities()

auto Menu::deleteAllEntities ( ) const->void

Deletes all entities inside of the grid.

Here is the caller graph for this function:

◆ endWindow()

auto Menu::endWindow ( ) ->void

inlineoverridevirtual

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

Implements GameObject.

◆ fillMenu()

auto Menu::fillMenu ( ) ->void

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAboveEntity()

auto Menu::getAboveEntity ( Entity * entity ) ->Entity *

When given an entity, it will return the one above in the menu.

Here is the call graph for this function:

◆ getBelowEntity()

auto Menu::getBelowEntity ( Entity * entity ) ->Entity *

When given an entity, it will return the one below in the menu.

Here is the call graph for this function:

◆ getButtonEntity()

auto Menu::getButtonEntity	(	int	x,
		int	y )->Entity *

takes in a position, and gets the entitiy in the position, blocking overflow by locking to edges, or wrapping, based on type of menu @ todo fully document getButtonEntity

Parameters

x
y

Returns

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getButtonPosition()

auto Menu::getButtonPosition ( Entity * ent ) ->std::pair< int, int >

private

takes in the entity and returns the index (x and y) of where it is in the menu

Returns

◆ getGamespacePositionForEntity()

auto Menu::getGamespacePositionForEntity ( Entity * entity ) const->Vector4D

Gets where an entity is in its gamespace position, based on where it is in the menu.

Parameters

entity an entity in the menu

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLeftEntity()

auto Menu::getLeftEntity ( Entity * entity ) ->Entity *

When given an entity, it will return the one left in the menu.

Here is the call graph for this function:

◆ getMenuElementPosition()

auto Menu::getMenuElementPosition ( Entity * entity ) const->std::pair< int, int >

Returns the index of the entity in the menu.

Here is the caller graph for this function:

◆ getRightEntity()

auto Menu::getRightEntity ( Entity * entity ) ->Entity *

When given an entity, it will return the one right in the menu.

Here is the call graph for this function:

◆ getTranslationOfIndex()

auto Menu::getTranslationOfIndex	(	int	x,
		int	y )->Point2D

Returns the translation of an item at given index.

Here is the call graph for this function:

◆ height()

auto Menu::height ( ) const->int

Returns the height of the menu.

◆ linkMessages()

auto Menu::linkMessages ( ) ->void

Here is the caller graph for this function:

◆ load()

auto Menu::load ( 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.

◆ onEnterEngine()

auto Menu::onEnterEngine ( ) ->void

overridevirtual

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

The hook is called immedietly after a gameobject's parent is called. Functionality may not be correct if an object was removed from the engine then re-added

Reimplemented from GameObject.

Here is the call graph for this function:

◆ onRender()

auto Menu::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.

◆ onUpdate()

auto Menu::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.

◆ operator=() [1/2]

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

default

Here is the call graph for this function:

◆ operator=() [2/2]

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

defaultnoexcept

Here is the call graph for this function:

◆ pushEntity()

auto Menu::pushEntity ( Entity * entity ) ->void

A universal push function that automatically fills in empty spaces.

Here is the call graph for this function:

◆ pushEntityHorizontal()

auto Menu::pushEntityHorizontal ( Entity * entity ) ->void

Pushes an item to the first row of a menu, intended for the cards.

Todo: : this maybe should respect max size now

Here is the call graph for this function:

◆ removeEntity()

auto Menu::removeEntity	(	int	x,
		int	y )->void

Removes a specific entity at given index.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ repositionItems()

auto Menu::repositionItems	(	std::vector< Entity * >	ent,
		int	column )->void

private

Visually arranges the entities in a given column, intended as a helper function for compactMenu.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ returnButtonIndexDefault()

auto Menu::returnButtonIndexDefault	(	int	x,
		int	y )->Entity *

private

Returns the menu position while accounting for default logic, intended as a helper function for getButtonEntity.

Here is the caller graph for this function:

◆ returnButtonIndexWrapped()

auto Menu::returnButtonIndexWrapped	(	int	x,
		int	y )->Entity *

private

Returns the menu position while accounting for wrapped logic, intended as a helper function for getButtonEntity.

Here is the caller graph for this function:

◆ returnDefaultMenuPosition()

auto Menu::returnDefaultMenuPosition	(	int	x,
		int	y )->Point2D

private

Returns the menu position while accounting for default logic, intended as a helper function for returnMenuPosition.

Here is the caller graph for this function:

◆ returnWrappedMenuPosition()

auto Menu::returnWrappedMenuPosition	(	int	x,
		int	y )->Point2D

private

Returns the menu position while accounting for wrapped logic, intended as a helper function for returnMenuPosition.

Here is the caller graph for this function:

◆ save()

auto Menu::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.

◆ updateMenuChildren()

auto Menu::updateMenuChildren ( ) ->void

Resizes menu in memory, allocates new items, and then calls compact menu.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ width()

auto Menu::width ( ) const->int

Returns the width of the menu.

◆ from_json

auto from_json	(	const json &	j,
		Menu &	m )->void

friend

◆ to_json

auto to_json	(	json &	j,
		const Menu &	m )->void

friend

Member Data Documentation

◆ buttons

std::vector<std::vector<Entity*> > Menu::buttons

private

The managed items/entities for the menu.

◆ gapBetweenObjects

float Menu::gapBetweenObjects = 0.01f

private

How much visual space is put between objects in the menu.

◆ maxMenuHeight

int Menu::maxMenuHeight = 3

private

How tall the menu grid is (how many objects it can hold vertically).

◆ maxMenuWidth

int Menu::maxMenuWidth = 3

private

How wide menu grid is (how many objects it can hold horizontally).

◆ type

menuType Menu::type = menuType::mDefault

private

How to tell if the menu wraps.

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

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

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Menu() [1/4]

◆ Menu() [2/4]

◆ Menu() [3/4]

◆ ~Menu()

◆ Menu() [4/4]

Member Function Documentation

◆ arrangeEntityAccordingToPositionInMenu()

◆ clone()

◆ compactMenu()

◆ componentShowMenu()

◆ createEmptyButton()

◆ deleteAllEntities()

◆ endWindow()

◆ fillMenu()

◆ getAboveEntity()

◆ getBelowEntity()

◆ getButtonEntity()

◆ getButtonPosition()

◆ getGamespacePositionForEntity()

◆ getLeftEntity()

◆ getMenuElementPosition()

◆ getRightEntity()

◆ getTranslationOfIndex()

◆ height()

◆ linkMessages()

◆ load()

◆ onEnterEngine()

◆ onRender()

◆ onUpdate()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ pushEntity()

◆ pushEntityHorizontal()

◆ removeEntity()

◆ repositionItems()

◆ returnButtonIndexDefault()

◆ returnButtonIndexWrapped()

◆ returnDefaultMenuPosition()

◆ returnWrappedMenuPosition()

◆ save()

◆ updateMenuChildren()

◆ width()

Friends And Related Symbol Documentation

◆ from_json

◆ to_json

Member Data Documentation

◆ buttons

◆ gapBetweenObjects

◆ maxMenuHeight

◆ maxMenuWidth

◆ type