SetPositionAction Class Reference

An Action that sets an entities position to a specific value. More...

#include <SetPositionAction.h>

Inheritance diagram for SetPositionAction:

Collaboration diagram for SetPositionAction:

Public Member Functions
	SetPositionAction ()=default
	SetPositionAction (const SetPositionAction &)=default
auto	operator= (const SetPositionAction &) -> SetPositionAction &=default
	~SetPositionAction () override=default
	SetPositionAction (SetPositionAction &&other) noexcept=default
auto	operator= (SetPositionAction &&other) noexcept -> SetPositionAction &=default
	SetPositionAction (Point2D endingValue)
	SetPositionAction (Point2D endingValue, float duration)
	SetPositionAction (Point2D endingValue, float duration, const th::Bezier &easingFunction, float initialDelay, float endingDelay)
	SetPositionAction (Transform *transformToMoveTo)
	SetPositionAction (Transform *transformToMoveTo, float duration)
	SetPositionAction (Transform *transformToMoveTo, float duration, const th::Bezier &easingFunction, float initialDelay, float endingDelay)
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.
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
Transform *	transform = nullptr
Point2D	newPosition
Transform *	transformToMoveTo = nullptr

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

An Action that sets an entities position to a specific value.

@SetPositionAction.h

Constructor & Destructor Documentation

SetPositionAction() [1/9]

SetPositionAction::SetPositionAction ( )

default

Here is the caller graph for this function:

SetPositionAction() [2/9]

SetPositionAction::SetPositionAction ( const SetPositionAction & )

default

Here is the call graph for this function:

~SetPositionAction()

SetPositionAction::~SetPositionAction ( )

overridedefault

SetPositionAction() [3/9]

SetPositionAction::SetPositionAction ( SetPositionAction && other )

defaultnoexcept

Here is the call graph for this function:

SetPositionAction() [4/9]

SetPositionAction::SetPositionAction

(

Point2D

endingValue

)

Here is the call graph for this function:

SetPositionAction() [5/9]

SetPositionAction::SetPositionAction	(	Point2D	endingValue,
		float	duration )

Here is the call graph for this function:

SetPositionAction() [6/9]

SetPositionAction::SetPositionAction	(	Point2D	endingValue,
		float	duration,
		const th::Bezier &	easingFunction,
		float	initialDelay,
		float	endingDelay )

Here is the call graph for this function:

SetPositionAction() [7/9]

SetPositionAction::SetPositionAction

(

Transform *

transformToMoveTo

)

Here is the call graph for this function:

SetPositionAction() [8/9]

SetPositionAction::SetPositionAction	(	Transform *	transformToMoveTo,
		float	duration )

Here is the call graph for this function:

SetPositionAction() [9/9]

SetPositionAction::SetPositionAction	(	Transform *	transformToMoveTo,
		float	duration,
		const th::Bezier &	easingFunction,
		float	initialDelay,
		float	endingDelay )

Here is the call graph for this function:

Member Function Documentation

ActionShowMenu()

void SetPositionAction::ActionShowMenu ( ) ->void

overridevirtual

Displays a window in imgui.

Reimplemented from Action.

Here is the call graph for this function:

end()

auto SetPositionAction::end ( ) ->void

overridevirtual

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

Reimplemented from Action.

execute()

auto SetPositionAction::execute ( ) ->void

overridevirtual

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

Reimplemented from Action.

init()

auto SetPositionAction::init ( ) ->void

overridevirtual

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

Reimplemented from Action.

operator=() [1/2]

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

default

Here is the call graph for this function:

operator=() [2/2]

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

defaultnoexcept

Here is the call graph for this function:

render()

void SetPositionAction::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:

Member Data Documentation

newPosition

Point2D SetPositionAction::newPosition

private

transform

Transform* SetPositionAction::transform = nullptr

private

transformToMoveTo

Transform* SetPositionAction::transformToMoveTo = nullptr

private

---

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

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