[TODO: Description] More...

#include <FadeAudioGainBy.hpp>

Inheritance diagram for nom::FadeAudioGainBy:

Public Types
typedef FadeAudioGainBy	self_type
Public Types inherited from nom::IActionObject
enum	FrameState { COMPLETED , PLAYING }
	The update status of the action. More...
typedef IActionObject	self_type
typedef std::function< real32(real32, real32, real32, real32)>	timing_curve_func
	A function pointer to a timing mode.

Public Member Functions
	FadeAudioGainBy (audio::IOAudioEngine dev, const char filename, real32 delta, real32 duration)
	Default constructor; create the action from an audio file on disk.
	FadeAudioGainBy (audio::IOAudioEngine dev, audio::SoundBuffer buffer, real32 delta, real32 duration)
	Construct the action from a pre-initialized audio buffer.
virtual	~FadeAudioGainBy ()
	Destructor.
virtual std::unique_ptr< IActionObject >	clone () const override
	Create a deep copy instance of the action.
virtual IActionObject::FrameState	next_frame (real32 delta_time) override
	Play the action forward in time by one time step.
virtual IActionObject::FrameState	prev_frame (real32 delta_time) override
	Play the action backwards in time by one time step.
virtual void	pause (real32 delta_time) override
	Freeze the action's internal state.
virtual void	resume (real32 delta_time) override
	Resume logic for the animation object.
virtual void	rewind (real32 delta_time) override
	Reset the internal state of the action back to its initial starting values.
virtual void	release () override
	Free externally referenced resources held by the action.
Public Member Functions inherited from nom::IActionObject
const std::string &	name () const
	Get the unique identifier of the action.
real32	duration () const
	Get the duration of the action.
real32	speed () const
	Get the speed modifier of the action.
const IActionObject::timing_curve_func &	timing_curve () const
	Get the timing mode function used by the action.
void	set_name (const std::string &action_id)
	Set the unique identifier of the action.
virtual void	set_speed (real32 speed)
	Set the speed factor of the action.
virtual void	set_timing_curve (const IActionObject::timing_curve_func &mode)
	Set the timing mode of the action.

Private Member Functions
IActionObject::FrameState	update (real32 t, uint8 b, int16 c, real32 d)
	Execute the alpha blending logic for the animation.
void	first_frame (real32 delta_time)
void	last_frame (real32 delta_time)

Private Attributes
real32	initial_volume_
	The initial alpha blending value.
const real32	total_displacement_
	The total change in the alpha blending value.
audio::IOAudioEngine *	impl_ = nullptr
audio::SoundBuffer *	audible_ = nullptr
	The animation proxy object used to perform alpha blending on.

Static Private Attributes
static const char *	DEBUG_CLASS_NAME

Friends
class	ActionTest
	Allow access into our private parts for unit testing.

Additional Inherited Members
Protected Member Functions inherited from nom::IActionObject
IActionObject::FrameState	status () const
	Get the current state of the action.
void	set_duration (real32 seconds)
	Set the duration of the action.
void	set_status (FrameState state)
	Set the state of the action.
Protected Attributes inherited from nom::IActionObject
real32	elapsed_frames_ = 0.0f
	Internal frames counter.
Timer	timer_
	Internal time clock (milliseconds resolution).
Related Symbols inherited from nom::IActionObject
typedef std::vector< std::shared_ptr< IActionObject > >	action_list
	A collection of actions.
template<typename ObjectType, typename... ObjectArgs>
std::shared_ptr< ObjectType >	create_action (ObjectArgs &&... args)
	Constructor function for creating an action.
template<typename ObjectType>
std::shared_ptr< ObjectType >	create_action (const action_list &actions)
	Constructor function for creating an action that uses a collection of actions.

Detailed Description

[TODO: Description]

Definition at line 48 of file FadeAudioGainBy.hpp.

Member Typedef Documentation

◆ self_type

typedef FadeAudioGainBy nom::FadeAudioGainBy::self_type

Definition at line 54 of file FadeAudioGainBy.hpp.

Member Function Documentation

◆ clone()

virtual std::unique_ptr< IActionObject > nom::FadeAudioGainBy::clone ( ) const

overridevirtual

Create a deep copy instance of the action.

Remarks: A cloned instance is created using the action's attributes at the time of construction. External resources of the action – i.e.: nom::Sprite – are not modified, and you may need to reset the state appropriately if the action has been ran previously.

Implements nom::IActionObject.

◆ next_frame()

virtual IActionObject::FrameState nom::FadeAudioGainBy::next_frame ( real32 delta_time )

overridevirtual

Play the action forward in time by one time step.

Parameters

delta_time Reserved for application-defined implementations.

Note: This method should not normally need to be called externally! Exceptions might include: a) implementing a new action; b) advanced debugging

See also: nom::DispatchQueue

Implements nom::IActionObject.

◆ pause()

virtual void nom::FadeAudioGainBy::pause ( real32 delta_time )

overridevirtual

Freeze the action's internal state.

Parameters

delta_time Reserved for application-defined implementations.

Note: This method should not normally need to be called externally! Exceptions might include: a) implementing a new action; b) advanced debugging

See also: nom::DispatchQueue

Implements nom::IActionObject.

◆ prev_frame()

virtual IActionObject::FrameState nom::FadeAudioGainBy::prev_frame ( real32 delta_time )

overridevirtual

Play the action backwards in time by one time step.

Parameters

delta_time Reserved for application-defined implementations.

Note: This method should not normally need to be called externally! Exceptions might include: a) implementing a new action; b) advanced debugging

Remarks: Not all actions are reversible – see the action's documentation for its implementation details.

See also: nom::ReversedAction

Implements nom::IActionObject.

◆ release()

virtual void nom::FadeAudioGainBy::release ( )

overridevirtual

Free externally referenced resources held by the action.

Note: This method should not normally need to be called externally! Exceptions might include: a) implementing a new action; b) advanced debugging

See also: nom::RemoveAction

Implements nom::IActionObject.

◆ resume()

virtual void nom::FadeAudioGainBy::resume ( real32 delta_time )

overridevirtual

Resume logic for the animation object.

Remarks: Reserved for future implementation.

Implements nom::IActionObject.

◆ rewind()

virtual void nom::FadeAudioGainBy::rewind ( real32 delta_time )

overridevirtual

Reset the internal state of the action back to its initial starting values.

Parameters

delta_time Reserved for application-defined implementations.

Note: This method should not normally need to be called externally! Exceptions might include: a) implementing a new action; b) advanced debugging

See also: nom::RepeatForAction, nom::RepeatForeverAction

Implements nom::IActionObject.

◆ ActionTest

friend class ActionTest

friend

Allow access into our private parts for unit testing.

Definition at line 52 of file FadeAudioGainBy.hpp.

Member Data Documentation

◆ audible_

audio::SoundBuffer* nom::FadeAudioGainBy::audible_ = nullptr

private

The animation proxy object used to perform alpha blending on.

Definition at line 103 of file FadeAudioGainBy.hpp.

◆ DEBUG_CLASS_NAME

const char* nom::FadeAudioGainBy::DEBUG_CLASS_NAME

staticprivate

Definition at line 86 of file FadeAudioGainBy.hpp.

◆ impl_

audio::IOAudioEngine* nom::FadeAudioGainBy::impl_ = nullptr

private

Definition at line 100 of file FadeAudioGainBy.hpp.

◆ initial_volume_

real32 nom::FadeAudioGainBy::initial_volume_

private

The initial alpha blending value.

Definition at line 95 of file FadeAudioGainBy.hpp.

◆ total_displacement_

const real32 nom::FadeAudioGainBy::total_displacement_

private

The total change in the alpha blending value.

Definition at line 98 of file FadeAudioGainBy.hpp.

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

/home/jeff/Projects/nomlib.git/include/nomlib/actions/FadeAudioGainBy.hpp

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ self_type

Member Function Documentation

◆ clone()

◆ next_frame()

◆ pause()

◆ prev_frame()

◆ release()

◆ resume()

◆ rewind()

Friends And Related Symbol Documentation

◆ ActionTest

Member Data Documentation

◆ audible_

◆ DEBUG_CLASS_NAME

◆ impl_

◆ initial_volume_

◆ total_displacement_