From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- docs/doxygen/nel/a03542.html | 833 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 833 insertions(+) create mode 100644 docs/doxygen/nel/a03542.html (limited to 'docs/doxygen/nel/a03542.html') diff --git a/docs/doxygen/nel/a03542.html b/docs/doxygen/nel/a03542.html new file mode 100644 index 00000000..d2784bed --- /dev/null +++ b/docs/doxygen/nel/a03542.html @@ -0,0 +1,833 @@ + + +NeL: NL3D::ITrack class Reference + + + +

NL3D::ITrack Class Reference

#include <track.h> +

Inheritance diagram for NL3D::ITrack: +

+ + + + + + + + + + + + + + + + + + + + + +

Detailed Description

+The track store an animation of an animated value. This animation can be interpolated by several ways.

+The ITrack and animated value types MUST match else assertions will be raised.

Author:: Cyril 'Hulud' Corvazier
+Nevrax France

Date:: 2001

+ +

+Definition at line 58 of file track.h. + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions
virtual void eval (const TAnimationTime &date)=0
virtual std::string getClassName ()=0
virtual bool getLoopMode () const=0
virtual const IAnimatedValue & getValue () const=0
virtual void serial (IStream &f)=0
virtual ~ITrack ()
Time range methods.
virtual TAnimationTime getBeginTime () const=0
virtual TAnimationTime getEndTime () const=0
Time range methods.
virtual TAnimationTime getBeginTime () const=0
virtual TAnimationTime getEndTime () const=0
+

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + +
virtual NL3D::ITrack::~ITrack ( ) [inline, virtual]
+
+ + + + + +
+ + + +
+Virtual destructor. +
+Definition at line 64 of file track.h. +
+
00064 {}; +

+

Member Function Documentation

+ + + + +
+ + + + + + + + + +
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().
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
bool NL3D::ITrack::interpolate ( TAnimationTime time,
bool & res
) [virtual]
+
+ + + + + +
+ + + +
+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, eval(), getValue(), NL3D_HAUTO_UTRACK_INTERPOLATE, res, NL3D::TAnimationTime, and value. +
+
00203 { +00204 NL3D_HAUTO_UTRACK_INTERPOLATE; +00205 +00206 // Evaluate it +00207 eval (time); +00208 +00209 // Get a pointer on the value +00210 const CAnimatedValueBool *value=dynamic_cast<const CAnimatedValueBool*>(&getValue ()); +00211 +00212 // Type is good ? +00213 if (value) +00214 { +00215 // Ok, return the value +00216 res=value->Value; +00217 return true; +00218 } +00219 else +00220 // No, return false +00221 return false; +00222 } +

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
bool NL3D::ITrack::interpolate ( TAnimationTime time,
std::string & res
) [virtual]
+
+ + + + + +
+ + + +
+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, eval(), getValue(), NL3D_HAUTO_UTRACK_INTERPOLATE, res, NL3D::TAnimationTime, and value. +
+
00179 { +00180 NL3D_HAUTO_UTRACK_INTERPOLATE; +00181 +00182 // Evaluate it +00183 eval (time); +00184 +00185 // Get a pointer on the value +00186 const CAnimatedValueString *value=dynamic_cast<const CAnimatedValueString*>(&getValue ()); +00187 +00188 // Type is good ? +00189 if (value) +00190 { +00191 // Ok, return the value +00192 res=value->Value; +00193 return true; +00194 } +00195 else +00196 // No, return false +00197 return false; +00198 } +

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
bool NL3D::ITrack::interpolate ( TAnimationTime time,
NLMISC::CQuat & res
) [virtual]
+
+ + + + + +
+ + + +
+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, eval(), getValue(), NL3D_HAUTO_UTRACK_INTERPOLATE, res, NL3D::TAnimationTime, and value. +
+
00155 { +00156 NL3D_HAUTO_UTRACK_INTERPOLATE; +00157 +00158 // Evaluate it +00159 eval (time); +00160 +00161 // Get a pointer on the value +00162 const CAnimatedValueQuat *value=dynamic_cast<const CAnimatedValueQuat*>(&getValue ()); +00163 +00164 // Type is good ? +00165 if (value) +00166 { +00167 // Ok, return the value +00168 res=value->Value; +00169 return true; +00170 } +00171 else +00172 // No, return false +00173 return false; +00174 } +

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
bool NL3D::ITrack::interpolate ( TAnimationTime time,
NLMISC::CVector & res
) [virtual]
+
+ + + + + +
+ + + +
+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, eval(), getValue(), NL3D_HAUTO_UTRACK_INTERPOLATE, res, NL3D::TAnimationTime, and value. +
+
00131 { +00132 NL3D_HAUTO_UTRACK_INTERPOLATE; +00133 +00134 // Evaluate it +00135 eval (time); +00136 +00137 // Get a pointer on the value +00138 const CAnimatedValueVector *value=dynamic_cast<const CAnimatedValueVector*>(&getValue ()); +00139 +00140 // Type is good ? +00141 if (value) +00142 { +00143 // Ok, return the value +00144 res=value->Value; +00145 return true; +00146 } +00147 else +00148 // No, return false +00149 return false; +00150 } +

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
bool NL3D::ITrack::interpolate ( TAnimationTime time,
NLMISC::CRGBA & res
) [virtual]
+
+ + + + + +
+ + + +
+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, eval(), getValue(), NL3D_HAUTO_UTRACK_INTERPOLATE, res, NL3D::TAnimationTime, and value. +
+
00107 { +00108 NL3D_HAUTO_UTRACK_INTERPOLATE; +00109 +00110 // Evaluate it +00111 eval (time); +00112 +00113 // Get a pointer on the value +00114 const CAnimatedValueRGBA *value=dynamic_cast<const CAnimatedValueRGBA*>(&getValue ()); +00115 +00116 // Type is good ? +00117 if (value) +00118 { +00119 // Ok, return the value +00120 res=value->Value; +00121 return true; +00122 } +00123 else +00124 // No, return false +00125 return false; +00126 } +

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
bool NL3D::ITrack::interpolate ( TAnimationTime time,
sint32 & res
) [virtual]
+
+ + + + + +
+ + + +
+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, eval(), getValue(), NL3D_HAUTO_UTRACK_INTERPOLATE, res, sint32, NL3D::TAnimationTime, and value. +
+
00083 { +00084 NL3D_HAUTO_UTRACK_INTERPOLATE; +00085 +00086 // Evaluate it +00087 eval (time); +00088 +00089 // Get a pointer on the value +00090 const CAnimatedValueInt *value=dynamic_cast<const CAnimatedValueInt*>(&getValue ()); +00091 +00092 // Type is good ? +00093 if (value) +00094 { +00095 // Ok, return the value +00096 res=value->Value; +00097 return true; +00098 } +00099 else +00100 // No, return false +00101 return false; +00102 } +

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual bool NL3D::ITrack::interpolate ( TAnimationTime time,
float & res
) [virtual]
+
+ + + + + +
+ + + +
+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.
+

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

track.h
track.cpp

Generated on Tue Mar 16 08:40:29 2004 for NeL by + +

+1.3.6

+ + -- cgit v1.2.1


Public Member Functions
virtual void	eval (const TAnimationTime &date)=0
virtual std::string	getClassName ()=0
virtual bool	getLoopMode () const=0
virtual const IAnimatedValue &	getValue () const=0
virtual void	serial (IStream &f)=0
virtual	~ITrack ()
Time range methods.
virtual TAnimationTime	getBeginTime () const=0
virtual TAnimationTime	getEndTime () const=0
Time range methods.
virtual TAnimationTime	getBeginTime () const=0
virtual TAnimationTime	getEndTime () const=0