Detailed Description

This is the base class for implementing animation curves.

It is a pure virtual class that defines the general interface to animation key management and manipulation.

See also:: KFbxAnimCurve and KFbxAnimCurveKFCurve for fully implemented class.

Definition at line 68 of file kfbxanimcurvebase.h.

#include <kfbxanimcurvebase.h>

Inheritance diagram for KFbxAnimCurveBase:

[legend]

List of all members.

Public Member Functions
virtual bool	Store (KFbx *pFileObject)=0
virtual bool	Retrieve (KFbx *pFileObject)=0
Protected Member Functions
	KFbxAnimCurveBase (KFbxSdkManager &pManager, char const *pName)
Friends
class	KFbxObject
Key management.
virtual void	KeyClear ()=0
	Remove all the keys and free buffer memory.
virtual int	KeyGetCount () const =0
	Get the number of keys.
virtual int	KeyAdd (KTime pTime, KFbxAnimCurveKeyBase &pKey, int *pLast=NULL)=0
	Add a key at given time.
virtual bool	KeySet (int pIndex, KFbxAnimCurveKeyBase &pKey)=0
	Set key at given index.
virtual bool	KeyRemove (int pIndex)=0
	Remove key at given index.
virtual bool	KeyRemove (int pStartIndex, int pEndIndex)=0
	Remove all the keys in the given range.
Key Time Manipulation
virtual KTime	KeyGetTime (int pKeyIndex) const
	Get key time.
virtual void	KeySetTime (int pKeyIndex, KTime pTime)=0
	Set key time.
Extrapolation
Extrapolation defines the function curve value before and after the keys.Pre-extrapolation defines the function curve value before first key. Post-extrapolation defines the function curve value after last key. CONSTANT means a constant value matching the first/last key. REPETITION means the entire function curve is looped. MIRROR_REPETITION means the entire function curve is looped once backward, once forward and so on. KEEP_SLOPE means a linear function with a slope matching the first/last key.
enum	EExtrapolationType { eCONSTANT = 1, eREPETITION = 2, eMIRROR_REPETITION = 3, eKEEP_SLOPE = 4 }
void	SetPreExtrapolation (EExtrapolationType pExtrapolation)
	Set pre-extrapolation mode.
EExtrapolationType	GetPreExtrapolation () const
	Get pre-extrapolation mode.
void	SetPreExtrapolationCount (unsigned long pCount)
	Set pre-extrapolation count.
unsigned long	GetPreExtrapolationCount () const
	Get pre-extrapolation count.
void	SetPostExtrapolation (EExtrapolationType pExtrapolation)
	Set post-extrapolation mode.
EExtrapolationType	GetPostExtrapolation () const
	Get post-extrapolation mode.
void	SetPostExtrapolationCount (unsigned long pCount)
	Set post-extrapolation count.
unsigned long	GetPostExtrapolationCount () const
	Get post-extrapolation count.
Evaluation and Analysis
virtual float	Evaluate (KTime pTime, int *pLast=NULL)=0
	Evaluate curve value at a given time.
virtual float	EvaluateIndex (double pIndex)=0
	Evaluate curve value at the given key index.
Utility functions.
virtual bool	GetTimeInterval (KTime &pStart, KTime &pStop)
	Find out start and end time of the animation curve.
virtual bool	GetTimeInterval (KTimeSpan &pTimeInterval)
	Find out start and end time of the animation curve.

Member Enumeration Documentation

enum EExtrapolationType

Search for all occurrences

Enumerator:

eCONSTANT	Search for all occurrences
eREPETITION	Search for all occurrences
eMIRROR_REPETITION	Search for all occurrences
eKEEP_SLOPE	Search for all occurrences

Definition at line 149 of file kfbxanimcurvebase.h.

                     {
            eCONSTANT          = 1,
            eREPETITION        = 2,
            eMIRROR_REPETITION = 3,
            eKEEP_SLOPE        = 4
        } EExtrapolationType;

Constructor & Destructor Documentation

KFbxAnimCurveBase	(	KFbxSdkManager &	pManager,
		char const *	pName
	)		`[protected]`

Member Function Documentation

virtual void KeyClear ( ) [pure virtual]

Search for all occurrences

Remove all the keys and free buffer memory.

Implemented in KFbxAnimCurve, and KFbxAnimCurveKFCurve.

virtual int KeyGetCount ( ) const [pure virtual]

Search for all occurrences

Get the number of keys.

Implemented in KFbxAnimCurve, and KFbxAnimCurveKFCurve.

virtual int KeyAdd	(	KTime	pTime,
		KFbxAnimCurveKeyBase &	pKey,
		int *	pLast = `NULL`
	)		`[pure virtual]`

Search for all occurrences

Add a key at given time.

Parameters:

pTime	Time to add the key.
pKey	Key to add.
pLast	Index of the last processed key to speed up search. If this function is called in a loop, initialize this value to 0 and let it be updated by each call.

Returns:: Index of the key at given time, no matter if it was added or already present.

Implemented in KFbxAnimCurve, and KFbxAnimCurveKFCurve.

virtual bool KeySet	(	int	pIndex,
		KFbxAnimCurveKeyBase &	pKey
	)		`[pure virtual]`

Search for all occurrences

Set key at given index.

Parameters:

pIndex	Index of where the key should be set.
pKey	The key to set.

Returns:: true if key time is superior to previous key and inferior to next key, false otherwise.

Remarks:: Result is undetermined if function curve has no key or index is out of bounds.

Implemented in KFbxAnimCurve, and KFbxAnimCurveKFCurve.

virtual bool KeyRemove ( int pIndex ) [pure virtual]

Search for all occurrences

Remove key at given index.

Parameters:

pIndex Index of key to remove.

Returns:: true on success, false otherwise.

Implemented in KFbxAnimCurve, and KFbxAnimCurveKFCurve.

virtual bool KeyRemove	(	int	pStartIndex,
		int	pEndIndex
	)		`[pure virtual]`

Search for all occurrences

Remove all the keys in the given range.

Parameters:

pStartIndex	Index of the first key to remove (inclusive).
pEndIndex	Index of the last key to remove (inclusive).

Returns:: true on success, false otherwise.

Implemented in KFbxAnimCurve, and KFbxAnimCurveKFCurve.

virtual KTime KeyGetTime ( int pKeyIndex ) const [inline, virtual]

Search for all occurrences

Get key time.

Parameters:

pKeyIndex Key index.

Returns:: Key time (time at which this key is occurring).

Reimplemented in KFbxAnimCurve, and KFbxAnimCurveKFCurve.

Definition at line 128 of file kfbxanimcurvebase.h.

{ return KTIME_INFINITE; }

virtual void KeySetTime	(	int	pKeyIndex,
		KTime	pTime
	)		`[pure virtual]`

Search for all occurrences

Set key time.

Parameters:

pKeyIndex	Key index.
pTime	Key time (time at which this key is occurring).

Implemented in KFbxAnimCurve, and KFbxAnimCurveKFCurve.

void SetPreExtrapolation ( EExtrapolationType pExtrapolation ) [inline]

Search for all occurrences

Set pre-extrapolation mode.

Parameters:

pExtrapolation The pre-extrapolation mode to set.

Definition at line 159 of file kfbxanimcurvebase.h.

{ mPreExtrapolation = pExtrapolation; }

EExtrapolationType GetPreExtrapolation ( ) const [inline]

Search for all occurrences

Get pre-extrapolation mode.

Returns:: The current pre-extrapolation mode.

Definition at line 164 of file kfbxanimcurvebase.h.

{ return mPreExtrapolation; }

void SetPreExtrapolationCount ( unsigned long pCount ) [inline]

Search for all occurrences

Set pre-extrapolation count.

Parameters:

pCount Number of repetitions if pre-extrapolation mode is REPETITION or MIRROR_REPETITION.

Definition at line 170 of file kfbxanimcurvebase.h.

{ mPreExtrapolationCount = pCount; }

unsigned long GetPreExtrapolationCount ( ) const [inline]

Search for all occurrences

Get pre-extrapolation count.

Returns:: Number of repetitions if pre-extrapolation mode is REPETITION or MIRROR_REPETITION.

Definition at line 176 of file kfbxanimcurvebase.h.

{ return mPreExtrapolationCount; }

void SetPostExtrapolation ( EExtrapolationType pExtrapolation ) [inline]

Search for all occurrences

Set post-extrapolation mode.

Parameters:

pExtrapolation The post-extrapolation mode to set.

Definition at line 181 of file kfbxanimcurvebase.h.

{ mPostExtrapolation = pExtrapolation; }

EExtrapolationType GetPostExtrapolation ( ) const [inline]

Search for all occurrences

Get post-extrapolation mode.

Returns:: The current post-extrapolation mode.

Definition at line 186 of file kfbxanimcurvebase.h.

{ return mPostExtrapolation; }

void SetPostExtrapolationCount ( unsigned long pCount ) [inline]

Search for all occurrences

Set post-extrapolation count.

Parameters:

pCount Number of repetitions if post-extrapolation mode is REPETITION or MIRROR_REPETITION.

Definition at line 192 of file kfbxanimcurvebase.h.

{ mPostExtrapolationCount = pCount; }

unsigned long GetPostExtrapolationCount ( ) const [inline]

Search for all occurrences

Get post-extrapolation count.

Returns:: Number of repetitions if post-extrapolation mode is REPETITION or MIRROR_REPETITION.

Definition at line 198 of file kfbxanimcurvebase.h.

{ return mPostExtrapolationCount; }

virtual float Evaluate	(	KTime	pTime,
		int *	pLast = `NULL`
	)		`[pure virtual]`

Search for all occurrences

Evaluate curve value at a given time.

Parameters:

pTime	Time of evaluation.
pLast	Index of the last processed key to speed up search. If this function is called in a loop, initialize this value to 0 and let it be updated by each call.

Returns:: Evaluated curve value.

Remarks:: This function take extrapolation into account.

Implemented in KFbxAnimCurve, and KFbxAnimCurveKFCurve.

virtual float EvaluateIndex ( double pIndex ) [pure virtual]

Search for all occurrences

Evaluate curve value at the given key index.

Parameters:

pIndex Any value from 0 to KFCurve::KeyGetCount() - 1. If this index falls between keys, the curve value will be interpolated based on the surrounding keys.