NL3D::CTrackKeyFramerLinearInt Class Reference

#include <track_keyframer.h>

Inheritance diagram for NL3D::CTrackKeyFramerLinearInt:

Public Types
typedef std::map< TAnimationTime, CKeyInt >	TMapTimeCKey
Public Member Functions
virtual bool	addBezierFloatKey (const UKeyBezierFloat &key)
	Fail if not A Float Bezier Keyframer.
void	addKey (const CKeyInt &key, TAnimationTime time)
virtual bool	addLinearFloatKey (const UKeyLinearFloat &key)
	Fail if not A Float Linear Keyframer.
virtual bool	addTCBFloatKey (const UKeyTCBFloat &key)
	Fail if not A Float TCB Keyframer.
virtual void	eval (const TAnimationTime &inDate)
	From ITrack.
virtual void	evalKey (const CKeyInt *previous, const CKeyInt *next, TAnimationTime datePrevious, TAnimationTime dateNext, TAnimationTime date)
	From ITrackKeyFramer.
virtual TAnimationTime	getBeginTime () const
virtual std::string	getClassName ()=0
virtual TAnimationTime	getEndTime () const
void	getKeysInRange (TAnimationTime t1, TAnimationTime t2, std::vector< TAnimationTime > &result)
virtual bool	getLoopMode () const
	get LoopMode. From ITrack
TAnimationTime	getRangeDelta () const
	rangeDelta is (length of effective Range) - (length of LastKey-FirstKey). NB: if RangeLock, rangeDelta==0.
virtual const IAnimatedValue &	getValue () const
	From ITrack.
bool	isRangeLocked () const
	return true if Range is locked to first/last key. use getBeginTime and getEndTime to get the effective begin/end range times...
void	lockRange ()
	range is computed from frist and last key time (default).
	NLMISC_DECLARE_CLASS (CTrackKeyFramerLinearInt)
virtual void	serial (NLMISC::IStream &f) throw (NLMISC::EStream)
	Serial the template.
void	setLoopMode (bool loop)
	set LoopMode. 2 mode only: "constant" (<=>false), and "loop" (<=> true). same mode for in and out...
void	unlockRange (TAnimationTime begin, TAnimationTime end)
	set an explicit animation range. (see getBeginTime() / setEndTime() ).
Static Public Member Functions
UTrackKeyframer *	createBezierFloatTrack ()
UTrackKeyframer *	createLinearFloatTrack ()
UTrackKeyframer *	createTCBFloatTrack ()
Protected Member Functions
virtual void	compile ()
float	getCompiledRangeDelta ()
	This is for Deriver compile(), because _RangeDelta (getRangeDelta()) is himself computed in compile().
Protected Attributes
TMapTimeCKey	_MapKey

---

Member Typedef Documentation

typedef std::map<TAnimationTime, CKeyInt > NL3D::ITrackKeyFramer< CKeyInt >::TMapTimeCKey [inherited]

Definition at line 65 of file track_keyframer.h.

---

Member Function Documentation

virtual bool NL3D::UTrackKeyframer::addBezierFloatKey (  const UKeyBezierFloat &  key  )  [inline, virtual, inherited]

Fail if not A Float Bezier Keyframer. Reimplemented in NL3D::CTrackKeyFramerBezierFloat. Definition at line 220 of file u_track.h. {return false;}

void NL3D::ITrackKeyFramer< CKeyInt >::addKey (  const CKeyInt &  key, TAnimationTime  time )  [inline, inherited]

Add a key in the keyframer. The key passed is duplicated in the track. Parameters: key  is the key value to add in the keyframer. time  is the time of the key to add in the keyframer. Definition at line 90 of file track_keyframer.h. { // Insert the key in the map _MapKey.insert (TMapTimeCKey::value_type (time, key)); // must precalc at next eval. _Dirty= true; }

virtual bool NL3D::UTrackKeyframer::addLinearFloatKey (  const UKeyLinearFloat &  key  )  [inline, virtual, inherited]

Fail if not A Float Linear Keyframer. Reimplemented in NL3D::CTrackKeyFramerLinearFloat. Definition at line 218 of file u_track.h. {return false;}

virtual bool NL3D::UTrackKeyframer::addTCBFloatKey (  const UKeyTCBFloat &  key  )  [inline, virtual, inherited]

Fail if not A Float TCB Keyframer. Reimplemented in NL3D::CTrackKeyFramerTCBFloat. Definition at line 222 of file u_track.h. {return false;}

virtual void NL3D::ITrackKeyFramer< CKeyInt >::compile (   )  [inline, protected, virtual, inherited]

Precalc keyframe runtime infos for interpolation (OODTime...). All keys should be processed. This is called by eval when necessary. Deriver should call ITrackKeyFramer::compile() first, to compile basic Key runtime info. Definition at line 302 of file track_keyframer.h. { float timeFirstKey; float timeLastKey; // Compute time of first/last key. if( !_MapKey.empty() ) { typename TMapTimeCKey::const_iterator ite; // Get first key ite=_MapKey.begin (); timeFirstKey= ite->first; // Get last key ite=_MapKey.end (); ite--; timeLastKey= ite->first; } else { timeFirstKey= 0.0f; timeLastKey= 0.0f; } // Compute RangeBegin / RangeEnd. (if not user provided). if(_RangeLock) { _RangeBegin= timeFirstKey; _RangeEnd= timeLastKey; } // Compute _RangeDelta. if(_RangeLock) { _RangeDelta= 0; } else { _RangeDelta= (_RangeEnd - _RangeBegin) - (timeLastKey - timeFirstKey); } // Misc range. _TotalRange= _RangeEnd - _RangeBegin; if(_TotalRange>0.0f) _OOTotalRange= 1.0f/_TotalRange; // start of loop / ned. _LoopStart= timeFirstKey; _LoopEnd= timeFirstKey + _TotalRange; // After _RangeDelta computed, compute OO delta times. typename TMapTimeCKey::iterator it= _MapKey.begin(); for(;it!=_MapKey.end();it++) { typename TMapTimeCKey::iterator next= it; next++; if(next!=_MapKey.end()) it->second.OODeltaTime= 1.0f/(next->first - it->first); else if(_RangeDelta>0.0f) // after last key, must slerp to first key. it->second.OODeltaTime= 1.0f/_RangeDelta; else it->second.OODeltaTime= 0.0f; } }

UTrackKeyframer * NL3D::UTrackKeyframer::createBezierFloatTrack (   )  [static, inherited]

Definition at line 87 of file track_keyframer.cpp. { return new CTrackKeyFramerBezierFloat; }

UTrackKeyframer * NL3D::UTrackKeyframer::createLinearFloatTrack (   )  [static, inherited]

Definition at line 83 of file track_keyframer.cpp. { return new CTrackKeyFramerLinearFloat; }

UTrackKeyframer * NL3D::UTrackKeyframer::createTCBFloatTrack (   )  [static, inherited]

Definition at line 91 of file track_keyframer.cpp. { return new CTrackKeyFramerTCBFloat; }

virtual void NL3D::ITrackKeyFramer< CKeyInt >::eval (  const TAnimationTime &  inDate  )  [inline, virtual, inherited]

From ITrack. Implements NL3D::ITrack. Definition at line 137 of file track_keyframer.h. { float date= inDate; const CKeyT *previous=NULL; const CKeyT *next=NULL; TAnimationTime datePrevious = 0; TAnimationTime dateNext = 0; // must precalc ?? testAndClean(); // No keys? if(_MapKey.empty()) return; // Loop gestion. if(_LoopMode && _MapKey.size()>1 ) { nlassert(_LoopEnd > _LoopStart); // force us to be in interval [_LoopStart, _LoopEnd[. if( date<_LoopStart || date>=_LoopEnd ) { double d= (date-_LoopStart)*_OOTotalRange; // floor(d) is the truncated number of loops. d= date- floor(d)*_TotalRange; date= (float)d; // For precision problems, ensure correct range. if(date<_LoopStart || date >= _LoopEnd) date= _LoopStart; } } // Return upper key typename TMapTimeCKey::iterator ite=_MapKey.upper_bound (date); // First next ? if (ite!=_MapKey.end()) { // Next next= &(ite->second); dateNext=ite->first; } // loop mgt. else if (_LoopMode && _MapKey.size()>1 ) { // loop to first!! next= &(_MapKey.begin()->second); // must slerp from last to first, dateNext= _LoopEnd; } else if (!_LoopMode && _MapKey.size()>=1 ) { // clamp to the last typename TMapTimeCKey::iterator iteLast= ite; iteLast--; next= &(iteLast->second); } // First previous ? if ((!_MapKey.empty())&&(ite!=_MapKey.begin())) { if (ite!=_MapKey.end()) { // Previous ite--; previous= &(ite->second); datePrevious=ite->first; } } else if (!_MapKey.empty()) { // Clamp at beginTime next= &(ite->second); dateNext=ite->first; } // Call evalutation fonction evalKey (previous, next, datePrevious, dateNext, date); }

virtual void NL3D::CTrackKeyFramerLinear< CKeyInt , sint32 >::evalKey (  const CKeyInt *  previous, const CKeyInt *  next, TAnimationTime  datePrevious, TAnimationTime  dateNext, TAnimationTime  date )  [inline, virtual, inherited]

From ITrackKeyFramer. Implements NL3D::ITrackKeyFramer< CKeyInt >. Definition at line 526 of file track_keyframer.h. { if(previous && next) { // lerp from previous to cur. date-= datePrevious; date*= previous->OODeltaTime; NLMISC::clamp(date, 0,1); // NB: in case of <CKeyInt,sint32> important that second terme is a float, so copyToValue(sint32, float) is used. copyToValue(_Value.Value, previous->Value*(1.f-(float)date) + next->Value*(float)date); } else { if (previous) copyToValue(_Value.Value, previous->Value); else if (next) copyToValue(_Value.Value, next->Value); } }

virtual TAnimationTime NL3D::ITrackKeyFramer< CKeyInt >::getBeginTime (   )  const [inline, virtual, inherited]

Get the begin time of the track Implements NL3D::UTrack. Definition at line 224 of file track_keyframer.h. { // must precalc ?? testAndClean(); return _RangeBegin; }

virtual std::string NLMISC::IClassable::getClassName (   )  [pure virtual, inherited]

Implemented in NLAIAGENT::CNumericIndex, NLAIC::IPointerGestion, NLAIC::CIdentType, and CAutomataDesc. Referenced by NLMISC::CClassRegistry::checkObject(), and NL3D::GetTextureSize().

float NL3D::ITrackKeyFramer< CKeyInt >::getCompiledRangeDelta (   )  [inline, protected, inherited]

This is for Deriver compile(), because _RangeDelta (getRangeDelta()) is himself computed in compile(). Definition at line 291 of file track_keyframer.h. { return _RangeDelta; }

virtual TAnimationTime NL3D::ITrackKeyFramer< CKeyInt >::getEndTime (   )  const [inline, virtual, inherited]

Get the end time of the track Implements NL3D::UTrack. Definition at line 231 of file track_keyframer.h. { // must precalc ?? testAndClean(); return _RangeEnd; }

void NL3D::ITrackKeyFramer< CKeyInt >::getKeysInRange (  TAnimationTime  t1, TAnimationTime  t2, std::vector< TAnimationTime > &  result )  [virtual, inherited]

From UTrackKeyframer, retrieve the keys that are in the given range [t1, t2] of the track Parameters: result  a vector that will be cleared, and filled with the date ofthe keys Implements NL3D::UTrackKeyframer.

virtual bool NL3D::ITrackKeyFramer< CKeyInt >::getLoopMode (   )  const [inline, virtual, inherited]

get LoopMode. From ITrack Implements NL3D::ITrack. Definition at line 133 of file track_keyframer.h. {return _LoopMode;}

TAnimationTime NL3D::ITrackKeyFramer< CKeyInt >::getRangeDelta (   )  const [inline, inherited]

rangeDelta is (length of effective Range) - (length of LastKey-FirstKey). NB: if RangeLock, rangeDelta==0. Definition at line 120 of file track_keyframer.h. { // update track. testAndClean(); return _RangeDelta; }

virtual const IAnimatedValue& NL3D::CTrackKeyFramerLinear< CKeyInt , sint32 >::getValue (   )  const [inline, virtual, inherited]

From ITrack. Implements NL3D::ITrack. Definition at line 520 of file track_keyframer.h. { return _Value; }

bool NL3D::ITrack::interpolate (  TAnimationTime  time, bool &  res )  [virtual, inherited]

Interplation a bool value. You should be sure that the track you use to interpolate your value is a bool track! An assertion will be raised in debug if the type is wrong. Parameters: time  is the time you want the evaluate the value. If time higher than the time gived by getEndTime (), the value returned is the interpolation value at getEndTime (). If time smaller than the time gived by getBeginTime (), the value returned is the interpolation value at getBeginTime (). res  is the reference on the value to get the result. Returns: true if interplation is successful. false if the type asked is wrong. Implements NL3D::UTrack. Definition at line 202 of file track.cpp. References NL3D::CAnimatedValueBool, NL3D::ITrack::eval(), NL3D::ITrack::getValue(), NL3D_HAUTO_UTRACK_INTERPOLATE, res, NL3D::TAnimationTime, and value. { NL3D_HAUTO_UTRACK_INTERPOLATE; // Evaluate it eval (time); // Get a pointer on the value const CAnimatedValueBool *value=dynamic_cast<const CAnimatedValueBool*>(&getValue ()); // Type is good ? if (value) { // Ok, return the value res=value->Value; return true; } else // No, return false return false; }

bool NL3D::ITrack::interpolate (  TAnimationTime  time, std::string &  res )  [virtual, inherited]

Interplation a string value. You should be sure that the track you use to interpolate your value is a string track! An assertion will be raised in debug if the type is wrong. Parameters: time  is the time you want the evaluate the value. If time higher than the time gived by getEndTime (), the value returned is the interpolation value at getEndTime (). If time smaller than the time gived by getBeginTime (), the value returned is the interpolation value at getBeginTime (). res  is the reference on the value to get the result. Returns: true if interplation is successful. false if the type asked is wrong. Implements NL3D::UTrack. Definition at line 178 of file track.cpp. References NL3D::CAnimatedValueString, NL3D::ITrack::eval(), NL3D::ITrack::getValue(), NL3D_HAUTO_UTRACK_INTERPOLATE, res, NL3D::TAnimationTime, and value. { NL3D_HAUTO_UTRACK_INTERPOLATE; // Evaluate it eval (time); // Get a pointer on the value const CAnimatedValueString *value=dynamic_cast<const CAnimatedValueString*>(&getValue ()); // Type is good ? if (value) { // Ok, return the value res=value->Value; return true; } else // No, return false return false; }

bool NL3D::ITrack::interpolate (  TAnimationTime  time, NLMISC::CQuat &  res )  [virtual, inherited]

Interplation a CQuat value. You should be sure that the track you use to interpolate your value is a CQuat track! An assertion will be raised in debug if the type is wrong. Parameters: time  is the time you want the evaluate the value. If time higher than the time gived by getEndTime (), the value returned is the interpolation value at getEndTime (). If time smaller than the time gived by getBeginTime (), the value returned is the interpolation value at getBeginTime (). res  is the reference on the value to get the result. Returns: true if interplation is successful. false if the type asked is wrong. Implements NL3D::UTrack. Definition at line 154 of file track.cpp. References NL3D::CAnimatedValueQuat, NL3D::ITrack::eval(), NL3D::ITrack::getValue(), NL3D_HAUTO_UTRACK_INTERPOLATE, res, NL3D::TAnimationTime, and value. { NL3D_HAUTO_UTRACK_INTERPOLATE; // Evaluate it eval (time); // Get a pointer on the value const CAnimatedValueQuat *value=dynamic_cast<const CAnimatedValueQuat*>(&getValue ()); // Type is good ? if (value) { // Ok, return the value res=value->Value; return true; } else // No, return false return false; }

bool NL3D::ITrack::interpolate (  TAnimationTime  time, NLMISC::CVector &  res )  [virtual, inherited]

Interplation a CVector value. You should be sure that the track you use to interpolate your value is a CVector track! An assertion will be raised in debug if the type is wrong. Parameters: time  is the time you want the evaluate the value. If time higher than the time gived by getEndTime (), the value returned is the interpolation value at getEndTime (). If time smaller than the time gived by getBeginTime (), the value returned is the interpolation value at getBeginTime (). res  is the reference on the value to get the result. Returns: true if interplation is successful. false if the type asked is wrong. Implements NL3D::UTrack. Definition at line 130 of file track.cpp. References NL3D::CAnimatedValueVector, NL3D::ITrack::eval(), NL3D::ITrack::getValue(), NL3D_HAUTO_UTRACK_INTERPOLATE, res, NL3D::TAnimationTime, and value. { NL3D_HAUTO_UTRACK_INTERPOLATE; // Evaluate it eval (time); // Get a pointer on the value const CAnimatedValueVector *value=dynamic_cast<const CAnimatedValueVector*>(&getValue ()); // Type is good ? if (value) { // Ok, return the value res=value->Value; return true; } else // No, return false return false; }

bool NL3D::ITrack::interpolate (  TAnimationTime  time, NLMISC::CRGBA &  res )  [virtual, inherited]

Interplation a CRGBA value. You should be sure that the track you use to interpolate your value is an CRGBA track! An assertion will be raised in debug if the type is wrong. Parameters: time  is the time you want the evaluate the value. If time higher than the time gived by getEndTime (), the value returned is the interpolation value at getEndTime (). If time smaller than the time gived by getBeginTime (), the value returned is the interpolation value at getBeginTime (). res  is the reference on the value to get the result. Returns: true if interplation is successful. false if the type asked is wrong. Implements NL3D::UTrack. Definition at line 106 of file track.cpp. References NL3D::CAnimatedValueRGBA, NL3D::ITrack::eval(), NL3D::ITrack::getValue(), NL3D_HAUTO_UTRACK_INTERPOLATE, res, NL3D::TAnimationTime, and value. { NL3D_HAUTO_UTRACK_INTERPOLATE; // Evaluate it eval (time); // Get a pointer on the value const CAnimatedValueRGBA *value=dynamic_cast<const CAnimatedValueRGBA*>(&getValue ()); // Type is good ? if (value) { // Ok, return the value res=value->Value; return true; } else // No, return false return false; }

bool NL3D::ITrack::interpolate (  TAnimationTime  time, sint32 &  res )  [virtual, inherited]

Interplation an integer value. You should be sure that the track you use to interpolate your value is an integer track! An assertion will be raised in debug if the type is wrong. Parameters: time  is the time you want the evaluate the value. If time higher than the time gived by getEndTime (), the value returned is the interpolation value at getEndTime (). If time smaller than the time gived by getBeginTime (), the value returned is the interpolation value at getBeginTime (). res  is the reference on the value to get the result. Returns: true if interplation is successful. false if the type asked is wrong. Implements NL3D::UTrack. Definition at line 82 of file track.cpp. References NL3D::CAnimatedValueInt, NL3D::ITrack::eval(), NL3D::ITrack::getValue(), NL3D_HAUTO_UTRACK_INTERPOLATE, res, sint32, NL3D::TAnimationTime, and value. { NL3D_HAUTO_UTRACK_INTERPOLATE; // Evaluate it eval (time); // Get a pointer on the value const CAnimatedValueInt *value=dynamic_cast<const CAnimatedValueInt*>(&getValue ()); // Type is good ? if (value) { // Ok, return the value res=value->Value; return true; } else // No, return false return false; }

virtual bool NL3D::ITrack::interpolate (  TAnimationTime  time, float &  res )  [virtual, inherited]

Interplation a float value. You should be sure that the track you use to interpolate your value is a float track! An assertion will be raised in debug if the type is wrong. Parameters: time  is the time you want the evaluate the value. If time higher than the time gived by getEndTime (), the value returned is the interpolation value at getEndTime (). If time smaller than the time gived by getBeginTime (), the value returned is the interpolation value at getBeginTime (). res  is the reference on the value to get the result. Returns: true if interplation is successful. false if the type asked is wrong. Implements NL3D::UTrack.

bool NL3D::ITrackKeyFramer< CKeyInt >::isRangeLocked (   )  const [inline, inherited]

return true if Range is locked to first/last key. use getBeginTime and getEndTime to get the effective begin/end range times... Definition at line 116 of file track_keyframer.h. {return _RangeLock;}

void NL3D::ITrackKeyFramer< CKeyInt >::lockRange (   )  [inline, inherited]

range is computed from frist and last key time (default). Definition at line 109 of file track_keyframer.h. { _RangeLock= true; _Dirty= true; }

NL3D::CTrackKeyFramerLinearInt::NLMISC_DECLARE_CLASS (  CTrackKeyFramerLinearInt   )

virtual void NL3D::ITrackKeyFramer< CKeyInt >::serial (  NLMISC::IStream &  f  )  throw (NLMISC::EStream) [inline, virtual, inherited]

Serial the template. Implements NLMISC::IStreamable. Definition at line 241 of file track_keyframer.h. { // Serial version (void)f.serialVersion (0); f.serialCont(_MapKey); f.serial(_RangeLock, _RangeBegin, _RangeEnd); f.serial(_LoopMode); if(f.isReading()) _Dirty= true; }

void NL3D::ITrackKeyFramer< CKeyInt >::setLoopMode (  bool  loop  )  [inline, inherited]

set LoopMode. 2 mode only: "constant" (<=>false), and "loop" (<=> true). same mode for in and out... Definition at line 130 of file track_keyframer.h. {_LoopMode= loop; _Dirty= true;}

void NL3D::ITrackKeyFramer< CKeyInt >::unlockRange (  TAnimationTime  begin, TAnimationTime  end )  [inline, inherited]

set an explicit animation range. (see getBeginTime() / setEndTime() ). Definition at line 100 of file track_keyframer.h. { _RangeLock= false; _RangeBegin= begin; _RangeEnd= end; _Dirty= true; }

---

Field Documentation

TMapTimeCKey NL3D::ITrackKeyFramer< CKeyInt >::_MapKey [protected, inherited]

Definition at line 287 of file track_keyframer.h.

---

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

• track_keyframer.h

---