ChangeOpacityAction Class Reference

An action that changes the opacity of an entity (as compared to ChangeColorAction, which changes the entire color). More...

#include <ChangeOpacityAction.h>

Inheritance diagram for ChangeOpacityAction:

Collaboration diagram for ChangeOpacityAction:

Public Member Functions
	ChangeOpacityAction ()=default
	ChangeOpacityAction (const ChangeOpacityAction &)=default
auto	operator= (const ChangeOpacityAction &) -> ChangeOpacityAction &=default
	~ChangeOpacityAction () override=default
	ChangeOpacityAction (ChangeOpacityAction &&other) noexcept=default
auto	operator= (ChangeOpacityAction &&other) noexcept -> ChangeOpacityAction &=default
	ChangeOpacityAction (float endingOpacity)
	ChangeOpacityAction (float endingOpacity, float duration)
	ChangeOpacityAction (float endingOpacity, 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	setEndingDelay (float delay) -> void
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.

Private Attributes
Sprite *	sprite = nullptr
float	startingOpacity = 1.f
float	endingOpacity

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"

Detailed Description

An action that changes the opacity of an entity (as compared to ChangeColorAction, which changes the entire color).

@ChangeOpacityAction.h

Constructor & Destructor Documentation

ChangeOpacityAction() [1/6]

ChangeOpacityAction::ChangeOpacityAction ( )

default

Here is the caller graph for this function:

ChangeOpacityAction() [2/6]

ChangeOpacityAction::ChangeOpacityAction ( const ChangeOpacityAction & )

default

Here is the call graph for this function:

~ChangeOpacityAction()

ChangeOpacityAction::~ChangeOpacityAction ( )

overridedefault

ChangeOpacityAction() [3/6]

ChangeOpacityAction::ChangeOpacityAction ( ChangeOpacityAction && other )

defaultnoexcept

Here is the call graph for this function:

ChangeOpacityAction() [4/6]

ChangeOpacityAction::ChangeOpacityAction

(

float

endingOpacity

)

Here is the call graph for this function:

ChangeOpacityAction() [5/6]

ChangeOpacityAction::ChangeOpacityAction	(	float	endingOpacity,
		float	duration )

Here is the call graph for this function:

ChangeOpacityAction() [6/6]

ChangeOpacityAction::ChangeOpacityAction	(	float	endingOpacity,
		float	duration,
		const th::Bezier &	easingFunction,
		float	initialDelay,
		float	endingDelay )

Here is the call graph for this function:

Member Function Documentation

ActionShowMenu()

void ChangeOpacityAction::ActionShowMenu ( ) ->void

overridevirtual

Displays a window in imgui.

Reimplemented from Action.

Here is the call graph for this function:

end()

auto ChangeOpacityAction::end ( ) ->void

overridevirtual

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

Reimplemented from Action.

execute()

auto ChangeOpacityAction::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 ChangeOpacityAction::init ( ) ->void

overridevirtual

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

Reimplemented from Action.

operator=() [1/2]

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

defaultnoexcept

Here is the call graph for this function:

operator=() [2/2]

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

default

Here is the call graph for this function:

render()

void ChangeOpacityAction::render ( ) const->void

overridevirtual

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

Reimplemented from Action.

Here is the call graph for this function:

Member Data Documentation

endingOpacity

float ChangeOpacityAction::endingOpacity

private

sprite

Sprite* ChangeOpacityAction::sprite = nullptr

private

startingOpacity

float ChangeOpacityAction::startingOpacity = 1.f

private

---

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

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