gf::ValueActivity Class Reference

An activity for a simple float value. More...

#include <gf/Activities.h>

Inheritance diagram for gf::ValueActivity:

Public Member Functions
	ValueActivity (float origin, float target, float &value, Time duration, Easing easing=Ease::linear)
	Constructor. More...
void	setOrigin (float origin)
	Change the origin of the activity. More...
float	getOrigin () const noexcept
	Get the origin of the activity. More...
void	setTarget (float target)
	Change the target of the activity. More...
float	getTarget () const noexcept
	Get the target of the activity. More...
void	setDuration (Time duration)
	Change the duration of the activity. More...
Time	getDuration () const noexcept
	Get the duration of the activity. More...
ActivityStatus	run (Time time) override
	Run the activity. More...
void	restart () override
	Restart the activity. More...
Public Member Functions inherited from gf::Activity
virtual	~Activity ()
	Destructor. More...

Detailed Description

An activity for a simple float value.

See also

gf::Tween

Constructor & Destructor Documentation

ValueActivity()

gf::ValueActivity::ValueActivity	(	float	origin,
		float	target,
		float &	value,
		Time	duration,
		Easing	easing = Ease::linear
	)

Constructor.

Parameters

origin	The origin value
target	The target value
value	A reference on the value
duration	The duration of the tween
easing	The easing for the interpolation

Member Function Documentation

getDuration()

Time gf::ValueActivity::getDuration ( ) const

inlinenoexcept

Get the duration of the activity.

Returns

The current duration

getOrigin()

float gf::ValueActivity::getOrigin ( ) const

inlinenoexcept

Get the origin of the activity.

Returns

The current origin

getTarget()

float gf::ValueActivity::getTarget ( ) const

inlinenoexcept

Get the target of the activity.

Returns

The current target

restart()

void gf::ValueActivity::restart ( )

overridevirtual

Restart the activity.

Reimplemented from gf::Activity.

run()

ActivityStatus gf::ValueActivity::run ( Time  time )

overridevirtual

Run the activity.

Parameters

time	The time since the last run

Returns

The status of the activity (running or finished)

Implements gf::Activity.

setDuration()

void gf::ValueActivity::setDuration ( Time  duration )

inline

Change the duration of the activity.

Parameters

duration

The new duration

setOrigin()

void gf::ValueActivity::setOrigin ( float  origin )

inline

Change the origin of the activity.

Parameters

origin

The new origin

setTarget()

void gf::ValueActivity::setTarget ( float  target )

inline

Change the target of the activity.

Parameters

target

The new target