AnimationSetup Class Reference

Animation setup. More...

#include <tdme/engine/model/AnimationSetup.h>

Collaboration diagram for AnimationSetup:

Public Member Functions
	AnimationSetup (Model *model, const string &id, int32_t startFrame, int32_t endFrame, bool loop, const string &overlayFromNodeId, float speed=1.0)
	Public constructor. More...
Model *	getModel ()
const string &	getId ()
bool	isOverlayAnimationSetup ()
int32_t	getStartFrame ()
void	setStartFrame (int32_t startFrame)
	Set start frame. More...
int32_t	getEndFrame ()
void	setEndFrame (int32_t endFrame)
	Set end frame. More...
int32_t	getFrames ()
bool	isLoop ()
void	setLoop (bool loop)
	Set loop. More...
const string &	getOverlayFromNodeId ()
	If this is a overlay animation this returns a node id from which node the animation will start in the hierarchy. More...
void	setOverlayFromNodeId (const string &overlayFromNodeId)
	Set overlay from node id. More...
int64_t	computeDuration ()
int64_t	computeDuration (int32_t startFrame, int32_t endFrame)
	Compute animation duration. More...
float	getSpeed ()
void	setSpeed (float speed)
	Set up animation speed. More...

Private Member Functions
void	setId (const string &id)
	Set id. More...

Private Attributes
Model *	model { nullptr }
string	id
int32_t	startFrame
int32_t	endFrame
int32_t	frames
bool	loop
string	overlayFromNodeId
float	speed

Friends
class	Model

Detailed Description

Animation setup.

Author

Andreas Drewke

Version

$Id$

Definition at line 17 of file AnimationSetup.h.

Constructor & Destructor Documentation

AnimationSetup()

AnimationSetup	(	Model *	model,
		const string &	id,
		int32_t	startFrame,
		int32_t	endFrame,
		bool	loop,
		const string &	overlayFromNodeId,
		float	speed = 1.0
	)

Public constructor.

Parameters

model	model
id	id
startFrame	start frame
endFrame	end frame
loop	loop
overlayFromNodeId	overlay from node id
speed	speed whereas 1.0 is default speed

Definition at line 9 of file AnimationSetup.cpp.

Member Function Documentation

computeDuration() [1/2]

int64_t computeDuration

(

)

Returns

animation duration in milliseconds

Definition at line 33 of file AnimationSetup.cpp.

computeDuration() [2/2]

int64_t computeDuration	(	int32_t	startFrame,
		int32_t	endFrame
	)

Compute animation duration.

Parameters

startFrame	start frame
endFrame	end frame

Returns

animation duration in milliseconds

Definition at line 38 of file AnimationSetup.cpp.

getEndFrame()

int32_t getEndFrame ( )

inline

Returns

end frame

Definition at line 82 of file AnimationSetup.h.

getFrames()

int32_t getFrames ( )

inline

Returns

frames

Definition at line 95 of file AnimationSetup.h.

getId()

const string & getId ( )

inline

Returns

id

Definition at line 55 of file AnimationSetup.h.

getModel()

Model * getModel ( )

inline

Returns

model this animation belongs to

Definition at line 48 of file AnimationSetup.h.

getOverlayFromNodeId()

const string & getOverlayFromNodeId ( )

inline

If this is a overlay animation this returns a node id from which node the animation will start in the hierarchy.

Returns

node id from which the animation will start in the hierarchy

Definition at line 118 of file AnimationSetup.h.

getSpeed()

float getSpeed ( )

inline

Returns

speed whereas 1.0 is default speed

Definition at line 146 of file AnimationSetup.h.

getStartFrame()

int32_t getStartFrame ( )

inline

Returns

start frame

Definition at line 69 of file AnimationSetup.h.

isLoop()

bool isLoop ( )

inline

Returns

looping enabled

Definition at line 102 of file AnimationSetup.h.

isOverlayAnimationSetup()

bool isOverlayAnimationSetup ( )

inline

Returns

if animation set up is a overlay animation setup

Definition at line 62 of file AnimationSetup.h.

setEndFrame()

void setEndFrame

(

int32_t

endFrame

)

Set end frame.

Parameters

endFrame

end frame

Definition at line 27 of file AnimationSetup.cpp.

setId()

void setId ( const string &  id )

inlineprivate

Set id.

Parameters

id

id

Definition at line 164 of file AnimationSetup.h.

setLoop()

void setLoop ( bool  loop )

inline

Set loop.

Parameters

loop

loop

Definition at line 110 of file AnimationSetup.h.

setOverlayFromNodeId()

void setOverlayFromNodeId ( const string &  overlayFromNodeId )

inline

Set overlay from node id.

Parameters

overlayFromNodeId

overlay from node id

Definition at line 126 of file AnimationSetup.h.

setSpeed()

void setSpeed ( float  speed )

inline

Set up animation speed.

Parameters

speed

speed whereas 1.0 is default speed

Definition at line 154 of file AnimationSetup.h.

setStartFrame()

void setStartFrame

(

int32_t

startFrame

)

Set start frame.

Parameters

startFrame

start frame

Definition at line 21 of file AnimationSetup.cpp.

Friends And Related Function Documentation

Model

friend class Model

friend

Definition at line 19 of file AnimationSetup.h.

Member Data Documentation

endFrame

int32_t endFrame

private

Definition at line 25 of file AnimationSetup.h.

frames

int32_t frames

private

Definition at line 26 of file AnimationSetup.h.

id

string id

private

Definition at line 23 of file AnimationSetup.h.

loop

bool loop

private

Definition at line 27 of file AnimationSetup.h.

model

Model* model { nullptr }

private

Definition at line 22 of file AnimationSetup.h.

overlayFromNodeId

string overlayFromNodeId

private

Definition at line 28 of file AnimationSetup.h.

speed

float speed

private

Definition at line 29 of file AnimationSetup.h.

startFrame

int32_t startFrame

private

Definition at line 24 of file AnimationSetup.h.

---

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

• /home/andreas/Development/drewke.net/tdme2/src/tdme/engine/model/AnimationSetup.h
• /home/andreas/Development/drewke.net/tdme2/src/tdme/engine/model/AnimationSetup.cpp