gpu_coverage::Animation Class Reference

Represents the animation of a scene object. More...

#include <Animation.h>

Public Types
typedef std::vector< Channel * >	Channels

Public Member Functions
	Animation (Scene *const scene, const aiAnimation *const animation, const size_t id)
	Constructor. More...
virtual	~Animation ()
	Destructor.
void	toDot (FILE *dot)
	Write Graphviz Dot node representing this animation to file for debugging. More...
const size_t &	getId () const
	Returns the unique ID of this animation. More...
const std::string &	getName () const
	Returns the name of this animation for logging. More...
const size_t &	getStartFrame () const
	Frame number where this animation starts. More...
const size_t &	getEndFrame () const
	Frame number where this animation ends. More...
const size_t &	getNumFrames () const
	Duration of this animation in frames. More...
const Channels &	getChannels () const
	Vector of Channel pointers that this animation influences. More...
const double &	getDuration () const
	Duration of this animation in seconds. More...

Protected Attributes
const size_t	id
	Unique ID, see getId().
const std::string	name
	Name of this animation, see getName().
const double	duration
	Duration of the animation in seconds.
size_t	startFrame
	Start frame of the animation.
size_t	endFrame
	End frame of the animation.
size_t	numFrames
	Number of frames of the animation.
Channels	channels
	Channels manipulated by this animation.

Detailed Description

Represents the animation of a scene object.

This class is our equivalent of Assimp's aiAnimation class.

Constructor & Destructor Documentation

gpu_coverage::Animation::Animation	(	Scene *const	scene,
		const aiAnimation *const	animation,
		const size_t	id
	)

Constructor.

Parameters

[in]	scene	Scene that contains this animation.
[in]	animation	The Assimp aiAnimation for creating this animation.
[in]	id	Unique ID of this animation.

Member Function Documentation

const Channels& gpu_coverage::Animation::getChannels ( ) const

inline

Vector of Channel pointers that this animation influences.

Returns

Channels.

const double& gpu_coverage::Animation::getDuration ( ) const

inline

Duration of this animation in seconds.

Returns

Duration in seconds.

const size_t& gpu_coverage::Animation::getEndFrame ( ) const

inline

Frame number where this animation ends.

Returns

End frame.

const size_t& gpu_coverage::Animation::getId ( ) const

inline

Returns the unique ID of this animation.

Returns

ID.

const std::string& gpu_coverage::Animation::getName ( ) const

inline

Returns the name of this animation for logging.

Returns

Name of this animation.

If available, the name included in the input file read by Assimp is used, otherwise a generic string is constructed.

const size_t& gpu_coverage::Animation::getNumFrames ( ) const

inline

Duration of this animation in frames.

Returns

Number of frames.

const size_t& gpu_coverage::Animation::getStartFrame ( ) const

inline

Frame number where this animation starts.

Returns

Start frame.

void gpu_coverage::Animation::toDot

(

FILE *

dot

)

Write Graphviz Dot node representing this animation to file for debugging.

Parameters

[in]

dot

Output Dot file.

---

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

• include/gpu_coverage/Animation.h