MoveToMenuPositionAction Class Reference

Moves an entity to where it should be positioned based on the menu its inside of. More...

#include <MoveToMenuPositionAction.h>

Inheritance diagram for MoveToMenuPositionAction:

Collaboration diagram for MoveToMenuPositionAction:

Public Member Functions
	MoveToMenuPositionAction ()=default
	MoveToMenuPositionAction (const MoveToMenuPositionAction &)=default
auto	operator= (const MoveToMenuPositionAction &) -> MoveToMenuPositionAction &=default
	~MoveToMenuPositionAction () override=default
	MoveToMenuPositionAction (MoveToMenuPositionAction &&other) noexcept=default
auto	operator= (MoveToMenuPositionAction &&other) noexcept -> MoveToMenuPositionAction &=default
	MoveToMenuPositionAction (Menu *menu)
	MoveToMenuPositionAction (Menu *menu, float duration)
	MoveToMenuPositionAction (Menu *menu, float duration, const th::Bezier &easingFunction, float initialDelay, float endingDelay)
	MoveToMenuPositionAction (Vector4D offset)
	MoveToMenuPositionAction (float duration)
	MoveToMenuPositionAction (Vector4D offset, float duration)
auto	init () -> void override
	Virtual function that is called once, when the Action is first starting up.
auto	execute () -> void override
	Virtual function that is called every frame to change a game object.
auto	end () -> void override
	Virtual function that is called once, when an Action is finished executing.
auto	ActionShowMenu () -> void override
	Displays a window in imgui.
auto	render () const -> void override
	Function used to draw things to screen, useful for things such as debug drawing.
auto	setAdditionalOffset (const Point2D &offset) -> void
auto	setOffsetX (float x) -> void
auto	setOffsetY (float y) -> void
Public Member Functions inherited from Action
	Action ()=default
	Action (const Action &)=default
auto	operator= (const Action &) -> Action &=default
virtual	~Action ()=default
	Action (Action &&other) noexcept=default
auto	operator= (Action &&other) noexcept -> Action &=default
auto	operator== (const Action &other) const -> bool
	Action (std::string name)
	Action (std::string name, float duration)
	Action (std::string name, float duration, const th::Bezier &bezierCurve, float initialDelay, float endingDelay)
auto	update (float dt) -> void
	Universal update function that handles calling init, update, and end at the right time.
auto	shouldRemove () const -> bool
auto	getOwner () const -> Entity *
auto	setOwner (Entity *newObject) -> void
auto	getHasInitialized () const -> bool
auto	getHasExecuted () const -> bool
auto	getHasEnded () const -> bool
auto	isPaused () const -> bool
auto	setPaused (bool newState) -> void
auto	isBlocking () const -> bool
auto	setBlocking (bool newState) -> void
auto	setInitialDelay (float delay) -> void
auto	getInitialDelay () const -> float
auto	setDuration (float duration) -> void
auto	getDuration () const -> float
auto	setEndingDelay (float delay) -> void
auto	getEndingDelay () const -> float
auto	getTotalLifetime () const -> float
auto	getName () -> std::string
	Function used for displaying info about what an Action does.
auto	getCompletionPercentage () const -> float
	Function used to see how much the action has completed.
auto	getCurve () const -> th::Bezier
	Function used to see which type of curve an action has.
auto	setCurve (const th::Bezier &curve) -> void
	set the curve of the function

Private Attributes
Menu *	menu = nullptr
Transform *	transform = nullptr
Point2D	startingPosition
Point2D	endingPosition
Point2D	additionalOffest = {0,0,0,0}

Additional Inherited Members
Protected Member Functions inherited from Action
auto	percentageComplete () const -> float
template<typename T>
auto	lerpBasedOnTime (const T &start, const T &end) -> T
Protected Attributes inherited from Action
Entity *	changingObject = nullptr
std::string	actionName = "BaseAction"
bool	blocking = false
	If an action is blocking, it stops all actions after it in an ActionList from updating.

Detailed Description

Moves an entity to where it should be positioned based on the menu its inside of.

@MoveToMenuPositionAction.h

Constructor & Destructor Documentation

MoveToMenuPositionAction() [1/9]

MoveToMenuPositionAction::MoveToMenuPositionAction ( )

default

Here is the caller graph for this function:

MoveToMenuPositionAction() [2/9]

MoveToMenuPositionAction::MoveToMenuPositionAction ( const MoveToMenuPositionAction & )

default

Here is the call graph for this function:

~MoveToMenuPositionAction()

MoveToMenuPositionAction::~MoveToMenuPositionAction ( )

overridedefault

MoveToMenuPositionAction() [3/9]

MoveToMenuPositionAction::MoveToMenuPositionAction ( MoveToMenuPositionAction && other )

defaultnoexcept

Here is the call graph for this function:

MoveToMenuPositionAction() [4/9]

MoveToMenuPositionAction::MoveToMenuPositionAction

(

Menu *

menu

)

Here is the call graph for this function:

MoveToMenuPositionAction() [5/9]

MoveToMenuPositionAction::MoveToMenuPositionAction	(	Menu *	menu,
		float	duration )

Here is the call graph for this function:

MoveToMenuPositionAction() [6/9]

MoveToMenuPositionAction::MoveToMenuPositionAction	(	Menu *	menu,
		float	duration,
		const th::Bezier &	easingFunction,
		float	initialDelay,
		float	endingDelay )

Here is the call graph for this function:

MoveToMenuPositionAction() [7/9]

MoveToMenuPositionAction::MoveToMenuPositionAction

(

Vector4D

offset

)

Here is the call graph for this function:

MoveToMenuPositionAction() [8/9]

MoveToMenuPositionAction::MoveToMenuPositionAction

(

float

duration

)

Here is the call graph for this function:

MoveToMenuPositionAction() [9/9]

MoveToMenuPositionAction::MoveToMenuPositionAction	(	Vector4D	offset,
		float	duration )

Here is the call graph for this function:

Member Function Documentation

ActionShowMenu()

void MoveToMenuPositionAction::ActionShowMenu ( ) ->void

overridevirtual

Displays a window in imgui.

Reimplemented from Action.

Here is the call graph for this function:

end()

auto MoveToMenuPositionAction::end ( ) ->void

overridevirtual

Virtual function that is called once, when an Action is finished executing.

Reimplemented from Action.

execute()

auto MoveToMenuPositionAction::execute ( ) ->void

overridevirtual

Virtual function that is called every frame to change a game object.

Reimplemented from Action.

Here is the call graph for this function:

init()

auto MoveToMenuPositionAction::init ( ) ->void

overridevirtual

Virtual function that is called once, when the Action is first starting up.

Reimplemented from Action.

operator=() [1/2]

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

default

Here is the call graph for this function:

operator=() [2/2]

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

defaultnoexcept

Here is the call graph for this function:

render()

void MoveToMenuPositionAction::render ( ) const->void

overridevirtual

Function used to draw things to screen, useful for things such as debug drawing.

Todo

: Implement debug draw rendering

Reimplemented from Action.

Here is the call graph for this function:

setAdditionalOffset()

auto MoveToMenuPositionAction::setAdditionalOffset

(

const Point2D &

offset

)

->void

setOffsetX()

auto MoveToMenuPositionAction::setOffsetX

(

float

x

)

->void

setOffsetY()

auto MoveToMenuPositionAction::setOffsetY

(

float

y

)

->void

Member Data Documentation

additionalOffest

Point2D MoveToMenuPositionAction::additionalOffest = {0,0,0,0}

private

endingPosition

Point2D MoveToMenuPositionAction::endingPosition

private

menu

Menu* MoveToMenuPositionAction::menu = nullptr

private

startingPosition

Point2D MoveToMenuPositionAction::startingPosition

private

transform

Transform* MoveToMenuPositionAction::transform = nullptr

private

---

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

• /home/egrazil/sites/Brunot/The House/source/Actions/MoveToMenuPositionAction.h
• /home/egrazil/sites/Brunot/The House/source/Actions/MoveToMenuPositionAction.cpp