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/a03088.html | 1740 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 1740 insertions(+) create mode 100644 docs/doxygen/nel/a03088.html (limited to 'docs/doxygen/nel/a03088.html') diff --git a/docs/doxygen/nel/a03088.html b/docs/doxygen/nel/a03088.html new file mode 100644 index 00000000..a8492b1f --- /dev/null +++ b/docs/doxygen/nel/a03088.html @@ -0,0 +1,1740 @@ + + +NeL: NL3D::CPlayListUser class Reference + + + +
+Main Page | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages | Search for 
+

NL3D::CPlayListUser Class Reference

#include <play_list_user.h> +

+

Inheritance diagram for NL3D::CPlayListUser: +

+ +NL3D::UPlayList + +

Detailed Description

+UPlayList implementation. Basicly, this is a playlist, plus a ChannelMixer.
Author:
Lionel Berenguier

+Nevrax France

+
Date:
2001
+ +

+ +

+Definition at line 50 of file play_list_user.h. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Types

enum  { empty = 0xffffffff + }
enum  TWrapMode { Clamp = 0, +Repeat, +Disable, +WrapModeCount + }
 Wrap mode for the play list. More...


Public Member Functions

 CPlayListUser (NLMISC::CSmartPtr< CAnimationSet > animationSet)
 Constructor.

void evalPlayList (double playTime)
 Tool function. setup the mixer, and eval global channels.

Animation Setup.
virtual void emptyPlayList ()
virtual uint getAnimation (uint8 slot) const
virtual void setAnimation (uint8 slot, uint animation)
Special channel operation.
virtual void enableChannel (uint channelId, bool enable)
virtual bool isChannelEnabled (uint channelId) const
Animation Weight Setup.
virtual float getEndWeight (uint8 slot, TGlobalAnimationTime &time) const
virtual TAnimationTime getLocalTime (uint8 slot, TGlobalAnimationTime globalTime, const UAnimationSet &animSet) const
virtual float getLocalWeight (uint8 slot, TGlobalAnimationTime globalTime) const
virtual float getStartWeight (uint8 slot, TGlobalAnimationTime &time) const
virtual float getWeightSmoothness (uint8 slot) const
virtual void setEndWeight (uint8 slot, float endWeight, TGlobalAnimationTime time)
virtual void setStartWeight (uint8 slot, float startWeight, TGlobalAnimationTime time)
virtual void setWeight (uint8 slot, float weight)
virtual void setWeightSmoothness (uint8 slot, float smoothness)
Skeleton Weight Setup.
virtual uint getSkeletonWeight (uint8 slot, bool &inverted) const
virtual void setSkeletonWeight (uint8 slot, uint skeletonId, bool inverted=false)
Animation Time Setup.
virtual float getSpeedFactor (uint8 slot) const
virtual TGlobalAnimationTime getTimeOrigin (uint8 slot) const
virtual TWrapMode getWrapMode (uint8 slot) const
virtual void setSpeedFactor (uint8 slot, float speedFactor)
virtual void setTimeOrigin (uint8 slot, TGlobalAnimationTime timeOrigin)
virtual void setWrapMode (uint8 slot, TWrapMode wrapMode)
Animatable Link.
virtual void registerTransform (UTransform *object, const char *prefix)
virtual void resetAllChannels ()

Private Attributes

NLMISC::CSmartPtr< CAnimationSet > _AnimationSet
CChannelMixer _ChannelMixer
CAnimationPlaylist _PlayList

Friends

class CPlayListManagerUser
+

Member Enumeration Documentation

+

+ + + + +
+ + +
anonymous enum [inherited] +
+
+ + + + + +
+   + + +

+

Enumeration values:
+ + +
empty  +
+
+ +

+Definition at line 63 of file u_play_list.h. +

+

00064         { 
+00065                 // 
+00066                 empty=0xffffffff
+00067         };
+
+

+ + + + +
+ + +
enum NL3D::UPlayList::TWrapMode [inherited] +
+
+ + + + + +
+   + + +

+Wrap mode for the play list. +

+

Enumeration values:
+ + + + + +
Clamp  +Clamp the animation time. (default).
Repeat  +Repeat the animation.
Disable  +Disable the animation.
WrapModeCount  +
+
+ +

+Definition at line 70 of file u_play_list.h. +

+

00071         { 
+00073                 Clamp=0,
+00074 
+00076                 Repeat,
+00077                 
+00079                 Disable,
+00080 
+00081                 WrapModeCount
+00082         };
+
+

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + + +
NL3D::CPlayListUser::CPlayListUser ( NLMISC::CSmartPtr< CAnimationSet >  animationSet  )  [inline]
+
+ + + + + +
+   + + +

+Constructor. +

+ +

+Definition at line 64 of file play_list_user.h. +

+References _ChannelMixer, NL3D_MEM_PLAYLIST, nlassert, NL3D::CChannelMixer::setAnimationSet(), and uint. +

+

00065         {
+00066                 NL3D_MEM_PLAYLIST
+00067                 nlassert(animationSet!=NULL);
+00068                 _AnimationSet= animationSet;
+00069 
+00070                 _ChannelMixer.setAnimationSet(_AnimationSet);
+00071 
+00072                 nlassert((uint)UPlayList::empty == (uint)CAnimationPlaylist::empty);
+00073                 nlassert((uint)UPlayList::WrapModeCount == (uint)CAnimationPlaylist::WrapModeCount);
+00074         }
+
+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + +
void NL3D::CPlayListUser::emptyPlayList (   )  [virtual]
+
+ + + + + +
+   + + +

+Empty the playlist. Each slot is set to its default value. +

+Implements NL3D::UPlayList. +

+Definition at line 94 of file play_list_user.cpp. +

+References _PlayList, NL3D::CAnimationPlaylist::emptyPlayList(), NL3D_HAUTO_UI_PLAY_LIST, and NL3D_MEM_PLAYLIST. +

+

00095 {
+00096         NL3D_MEM_PLAYLIST
+00097         NL3D_HAUTO_UI_PLAY_LIST;
+00098 
+00099         _PlayList.emptyPlayList ();
+00100 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NL3D::CPlayListUser::enableChannel ( uint  channelId,
bool  enable
)  [virtual]
+
+ + + + + +
+   + + +

+disabling a channel means it is no more modified during animation. Default is enabled. NB: this channel must have been added (via registerTransform()....).

Parameters:
+ + +
channelId channelId get from UAnimationSet::getChannelIdByName().
+
+ +

+Implements NL3D::UPlayList. +

+Definition at line 246 of file play_list_user.cpp. +

+References _ChannelMixer, NL3D::CChannelMixer::enableChannel(), NL3D_HAUTO_UI_PLAY_LIST, NL3D_MEM_PLAYLIST, and uint. +

+

00247 {
+00248         NL3D_MEM_PLAYLIST
+00249         NL3D_HAUTO_UI_PLAY_LIST;
+00250 
+00251         _ChannelMixer.enableChannel(channelId, enable);
+00252 }
+
+

+ + + + +
+ + + + + + + + + + +
void NL3D::CPlayListUser::evalPlayList ( double  playTime  ) 
+
+ + + + + +
+   + + +

+Tool function. setup the mixer, and eval global channels. +

+ +

+Definition at line 264 of file play_list_user.cpp. +

+References _ChannelMixer, _PlayList, NL3D::CChannelMixer::eval(), NL3D_MEM_PLAYLIST, and NL3D::CAnimationPlaylist::setupMixer(). +

+Referenced by NL3D::CSkeletonUser::computeCurrentBBox(). +

+

00265 {
+00266         NL3D_MEM_PLAYLIST
+00267         _PlayList.setupMixer(_ChannelMixer, playTime);
+00268         _ChannelMixer.eval(false);
+00269 }
+
+

+ + + + +
+ + + + + + + + + + +
uint NL3D::CPlayListUser::getAnimation ( uint8  slot  )  const [virtual]
+
+ + + + + +
+   + + +

+Get the animation of a slot. Default value is empty.

+

Parameters:
+ + +
slot is the id of the slot to set.
+
+
Returns:
the animation number in use in this slot. Return UPlayList::empty if the slot is empty.
+ +

+Implements NL3D::UPlayList. +

+Definition at line 110 of file play_list_user.cpp. +

+References _PlayList, NL3D::CAnimationPlaylist::getAnimation(), NL3D_HAUTO_UI_PLAY_LIST, NL3D_MEM_PLAYLIST, uint, and uint8. +

+

00111 {
+00112         NL3D_MEM_PLAYLIST
+00113         NL3D_HAUTO_UI_PLAY_LIST;
+00114 
+00115         return _PlayList.getAnimation (slot);
+00116 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
float NL3D::CPlayListUser::getEndWeight ( uint8  slot,
TGlobalAnimationTime &  time
)  const [virtual]
+
+ + + + + +
+   + + +

+Get animation end weight. Default value is 1.f.

+

Parameters:
+ + + +
slot is the id to get the slot.
time will get the playlist time for which the start weight is set. Default is 0.f.
+
+
Returns:
the end weight used in the slot.
+ +

+Implements NL3D::UPlayList. +

+Definition at line 193 of file play_list_user.cpp. +

+References _PlayList, NL3D::CAnimationPlaylist::getEndWeight(), NL3D_HAUTO_UI_PLAY_LIST, NL3D_MEM_PLAYLIST, NL3D::TGlobalAnimationTime, and uint8. +

+

00194 {
+00195         NL3D_MEM_PLAYLIST
+00196         NL3D_HAUTO_UI_PLAY_LIST;
+00197 
+00198         return _PlayList.getEndWeight (slot, time);
+00199 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
virtual TAnimationTime NL3D::CPlayListUser::getLocalTime ( uint8  slot,
TGlobalAnimationTime  globalTime,
const UAnimationSet &  animSet
)  const [virtual]
+
+ + + + + +
+   + + +

+Convert a playlist global time in local time in a slot animation including wrap evaluation.

+

Parameters:
+ + + +
slot is the slot in which the local time must be computed
time is the global time of the playlist
+
+
Returns:
the local time in the slot. If no animation are set in the slot, globalTime is returned.
+ +

+Implements NL3D::UPlayList.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
float NL3D::CPlayListUser::getLocalWeight ( uint8  slot,
TGlobalAnimationTime  globalTime
)  const [virtual]
+
+ + + + + +
+   + + +

+Compute weight of a slot at a given global playlist time

+

Parameters:
+ + + +
slot is the slot in which the weight must be computed
time is the global time of the playlist
+
+
Returns:
the weight of the slot for the given time.
+ +

+Implements NL3D::UPlayList. +

+Definition at line 63 of file play_list_user.cpp. +

+References _PlayList, NL3D::CAnimationPlaylist::getLocalWeight(), NL3D_HAUTO_UI_PLAY_LIST, NL3D_MEM_PLAYLIST, NL3D::TGlobalAnimationTime, and uint8. +

+

00064 {
+00065         NL3D_MEM_PLAYLIST
+00066         NL3D_HAUTO_UI_PLAY_LIST;
+00067 
+00068         return _PlayList.getLocalWeight (slot, globalTime);
+00069 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
uint NL3D::CPlayListUser::getSkeletonWeight ( uint8  slot,
bool &  inverted
)  const [virtual]
+
+ + + + + +
+   + + +

+Get the skeleton weight of a slot. Default value is empty.

+

Parameters:
+ + + +
slot is the id of the slot to set.
inverted will receive the invert flag.
+
+
Returns:
the skeleton weight number in use in this slot. Return UPlayList::empty if the slot is empty.
+ +

+Implements NL3D::UPlayList. +

+Definition at line 236 of file play_list_user.cpp. +

+References _PlayList, NL3D::CAnimationPlaylist::getSkeletonWeight(), NL3D_HAUTO_UI_PLAY_LIST, NL3D_MEM_PLAYLIST, uint, and uint8. +

+

00237 {
+00238         NL3D_MEM_PLAYLIST
+00239         NL3D_HAUTO_UI_PLAY_LIST;
+00240 
+00241         return _PlayList.getSkeletonWeight (slot, inverted);
+00242 }
+
+

+ + + + +
+ + + + + + + + + + +
float NL3D::CPlayListUser::getSpeedFactor ( uint8  slot  )  const [virtual]
+
+ + + + + +
+   + + +

+Get animation speed factor. Default value is 1.f.

+

Parameters:
+ + +
slot is the id to get the slot.
+
+
Returns:
the speed factor used in the slot.
+ +

+Implements NL3D::UPlayList. +

+Definition at line 143 of file play_list_user.cpp. +

+References _PlayList, NL3D::CAnimationPlaylist::getSpeedFactor(), NL3D_HAUTO_UI_PLAY_LIST, NL3D_MEM_PLAYLIST, and uint8. +

+

00144 {
+00145         NL3D_MEM_PLAYLIST
+00146         NL3D_HAUTO_UI_PLAY_LIST;
+00147 
+00148         return _PlayList.getSpeedFactor (slot);
+00149 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
float NL3D::CPlayListUser::getStartWeight ( uint8  slot,
TGlobalAnimationTime &  time
)  const [virtual]
+
+ + + + + +
+   + + +

+Get animation start weight. Default value is 1.f.

+

Parameters:
+ + + +
slot is the id to get the slot.
time will get the playlist time for which the start weight is set. Default is 0.f.
+
+
Returns:
the start weight used in the slot.
+ +

+Implements NL3D::UPlayList. +

+Definition at line 177 of file play_list_user.cpp. +

+References _PlayList, NL3D::CAnimationPlaylist::getStartWeight(), NL3D_HAUTO_UI_PLAY_LIST, NL3D_MEM_PLAYLIST, NL3D::TGlobalAnimationTime, and uint8. +

+

00178 {
+00179         NL3D_MEM_PLAYLIST
+00180         NL3D_HAUTO_UI_PLAY_LIST;
+00181 
+00182         return _PlayList.getStartWeight(slot, time);
+00183 }
+
+

+ + + + +
+ + + + + + + + + + +
TGlobalAnimationTime NL3D::CPlayListUser::getTimeOrigin ( uint8  slot  )  const [virtual]
+
+ + + + + +
+   + + +

+Get animation time origin, ie, the time in the playlist for which slot time is the startTime of the slot animation. Default value is 0.f.

+

Parameters:
+ + +
slot is the id to get the slot.
+
+
Returns:
time origin used in the slot.
+ +

+Implements NL3D::UPlayList. +

+Definition at line 128 of file play_list_user.cpp. +

+References _PlayList, NL3D::CAnimationPlaylist::getTimeOrigin(), NL3D_HAUTO_UI_PLAY_LIST, NL3D::TGlobalAnimationTime, and uint8. +

+

00129 {
+00130         NL3D_HAUTO_UI_PLAY_LIST;
+00131 
+00132         return _PlayList.getTimeOrigin (slot);
+00133 }
+
+

+ + + + +
+ + + + + + + + + + +
float NL3D::CPlayListUser::getWeightSmoothness ( uint8  slot  )  const [virtual]
+
+ + + + + +
+   + + +

+Get weight smoothness. This is the smoothness of the weight interpolation. Must be between 0.f and 1.f. 0.f is a sharp interpolation (linear), 1.f is a smooth interpolation (quadratic). Default value is 0.f.

+

Parameters:
+ + +
slot is the id of the slot to set.
+
+
Returns:
the smoothness value.
+ +

+Implements NL3D::UPlayList. +

+Definition at line 209 of file play_list_user.cpp. +

+References _PlayList, NL3D::CAnimationPlaylist::getWeightSmoothness(), NL3D_HAUTO_UI_PLAY_LIST, NL3D_MEM_PLAYLIST, and uint8. +

+

00210 {
+00211         NL3D_MEM_PLAYLIST
+00212         NL3D_HAUTO_UI_PLAY_LIST;
+00213 
+00214         return _PlayList.getWeightSmoothness (slot);
+00215 }
+
+

+ + + + +
+ + + + + + + + + + +
UPlayList::TWrapMode NL3D::CPlayListUser::getWrapMode ( uint8  slot  )  const [virtual]
+
+ + + + + +
+   + + +

+Get the wrap mode in use in the play list.

+Wrap mode tells the play list how to use an animation when current time is not in the animation.

Returns:
the wrap mode in use.
+ +

+Implements NL3D::UPlayList. +

+Definition at line 159 of file play_list_user.cpp. +

+References _PlayList, NL3D::CAnimationPlaylist::getWrapMode(), NL3D_HAUTO_UI_PLAY_LIST, NL3D_MEM_PLAYLIST, uint, and uint8. +

+

00160 {
+00161         NL3D_MEM_PLAYLIST
+00162         NL3D_HAUTO_UI_PLAY_LIST;
+00163 
+00164         return (UPlayList::TWrapMode)(uint)_PlayList.getWrapMode (slot);
+00165 }
+
+

+ + + + +
+ + + + + + + + + + +
bool NL3D::CPlayListUser::isChannelEnabled ( uint  channelId  )  const [virtual]
+
+ + + + + +
+   + + +

+see enableChannel(). return false if channel do not exist... NB: this channel must have been added (via registerTransform()....).

Parameters:
+ + +
channelId channelId get from UAnimationSet::getChannelIdByName().
+
+ +

+Implements NL3D::UPlayList. +

+Definition at line 254 of file play_list_user.cpp. +

+References _ChannelMixer, NL3D::CChannelMixer::isChannelEnabled(), NL3D_HAUTO_UI_PLAY_LIST, NL3D_MEM_PLAYLIST, and uint. +

+

00255 {
+00256         NL3D_MEM_PLAYLIST
+00257         NL3D_HAUTO_UI_PLAY_LIST;
+00258 
+00259         return _ChannelMixer.isChannelEnabled (channelId) ;
+00260 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NL3D::CPlayListUser::registerTransform ( UTransform *  object,
const char *  prefix
)  [virtual]
+
+ + + + + +
+   + + +

+register an Animatable object (UTransform, UCamera, UInstance...) to the playlist. Before deleting this Animatable object, you SHOULD UPlayList::resetAllChannels() or delete the playlist from the playlistmanager.

+

Parameters:
+ + +
object is the object which will be affected by this animation playlist.
+
+ +

+Implements NL3D::UPlayList. +

+Definition at line 73 of file play_list_user.cpp. +

+References _ChannelMixer, NL3D::CTransformUser::getTransform(), NL3D_HAUTO_UI_PLAY_LIST, NL3D_MEM_PLAYLIST, nlassert, and NL3D::CTransform::registerToChannelMixer(). +

+

00074 {
+00075         NL3D_MEM_PLAYLIST
+00076         NL3D_HAUTO_UI_PLAY_LIST;
+00077 
+00078         CTransformUser  *obj= dynamic_cast<CTransformUser*>(object);
+00079         nlassert(obj);
+00080 
+00081         // Register the transform to the channel mixer.
+00082         obj->getTransform()->registerToChannelMixer(&_ChannelMixer, prefix);
+00083 }
+
+

+ + + + +
+ + + + + + + + + +
void NL3D::CPlayListUser::resetAllChannels (   )  [virtual]
+
+ + + + + +
+   + + +

+Reset all channels so that no more Animatable object (Transforms etc...) are linked to this PLayList. Hence, the playlist has no effect on anything. +

+Implements NL3D::UPlayList. +

+Definition at line 84 of file play_list_user.cpp. +

+References _ChannelMixer, NL3D_HAUTO_UI_PLAY_LIST, NL3D_MEM_PLAYLIST, and NL3D::CChannelMixer::resetChannels(). +

+

00085 {
+00086         NL3D_MEM_PLAYLIST
+00087         NL3D_HAUTO_UI_PLAY_LIST;
+00088 
+00089         _ChannelMixer.resetChannels();
+00090 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NL3D::CPlayListUser::setAnimation ( uint8  slot,
uint  animation
)  [virtual]
+
+ + + + + +
+   + + +

+Set the animation of a slot. Default value is empty.

+

Parameters:
+ + + +
slot is the id of the slot to set.
animation is the animation number to use in this slot. To empty the slot, use UPlayList::empty.
+
+ +

+Implements NL3D::UPlayList. +

+Definition at line 102 of file play_list_user.cpp. +

+References _PlayList, NL3D_HAUTO_UI_PLAY_LIST, NL3D_MEM_PLAYLIST, NL3D::CAnimationPlaylist::setAnimation(), uint, and uint8. +

+

00103 {
+00104         NL3D_MEM_PLAYLIST
+00105         NL3D_HAUTO_UI_PLAY_LIST;
+00106 
+00107         _PlayList.setAnimation (slot, animation);
+00108 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
void NL3D::CPlayListUser::setEndWeight ( uint8  slot,
float  endWeight,
TGlobalAnimationTime  time
)  [virtual]
+
+ + + + + +
+   + + +

+Set animation end weight. This is the weight for this animation use at the end of the animation slot. Default value is 1.f.

+

Parameters:
+ + + + +
slot is the id of the slot to set.
time is the playlist time for which the start weight is set. Default is 1.f.
endWeight is the factor to use in this slot.
+
+ +

+Implements NL3D::UPlayList. +

+Definition at line 185 of file play_list_user.cpp. +

+References _PlayList, NL3D_HAUTO_UI_PLAY_LIST, NL3D_MEM_PLAYLIST, NL3D::CAnimationPlaylist::setEndWeight(), NL3D::TGlobalAnimationTime, and uint8. +

+

00186 {
+00187         NL3D_MEM_PLAYLIST
+00188         NL3D_HAUTO_UI_PLAY_LIST;
+00189 
+00190         _PlayList.setEndWeight (slot, endWeight, time);
+00191 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
void NL3D::CPlayListUser::setSkeletonWeight ( uint8  slot,
uint  skeletonId,
bool  inverted = false
)  [virtual]
+
+ + + + + +
+   + + +

+Set the skeleton weight animation of a slot. Default value is empty.

+

Parameters:
+ + + + +
slot is the id of the slot to set.
skeletonId is the skeleton weight number to use in this slot. To empty the slot, use UPlayList::empty.
inverted is false if the weights must be used as they are, true if the weights to used are 1.f - weight.
+
+ +

+Implements NL3D::UPlayList. +

+Definition at line 228 of file play_list_user.cpp. +

+References _PlayList, NL3D_HAUTO_UI_PLAY_LIST, NL3D_MEM_PLAYLIST, NL3D::CAnimationPlaylist::setSkeletonWeight(), uint, and uint8. +

+

00229 {
+00230         NL3D_MEM_PLAYLIST
+00231         NL3D_HAUTO_UI_PLAY_LIST;
+00232 
+00233         _PlayList.setSkeletonWeight (slot, skeletonId, inverted);
+00234 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NL3D::CPlayListUser::setSpeedFactor ( uint8  slot,
float  speedFactor
)  [virtual]
+
+ + + + + +
+   + + +

+Set animation speed factor. Default value is 1.f.

+

Parameters:
+ + + +
slot is the id of the slot to set.
speedFactor is the factor to use in this slot. The animation will go speedFactor* faster.
+
+ +

+Implements NL3D::UPlayList. +

+Definition at line 135 of file play_list_user.cpp. +

+References _PlayList, NL3D_HAUTO_UI_PLAY_LIST, NL3D_MEM_PLAYLIST, NL3D::CAnimationPlaylist::setSpeedFactor(), and uint8. +

+

00136 {
+00137         NL3D_MEM_PLAYLIST
+00138         NL3D_HAUTO_UI_PLAY_LIST;
+00139 
+00140         _PlayList.setSpeedFactor (slot, speedFactor);
+00141 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
void NL3D::CPlayListUser::setStartWeight ( uint8  slot,
float  startWeight,
TGlobalAnimationTime  time
)  [virtual]
+
+ + + + + +
+   + + +

+Set animation start weight. This is the weight for this animation use at the beginning of the animation slot. Default value is 1.f.

+

Parameters:
+ + + + +
slot is the id of the slot to set.
startWeight is the factor to use in this slot.
time is the playlist time for which the start weight is set. Default is 0.f.
+
+ +

+Implements NL3D::UPlayList. +

+Definition at line 169 of file play_list_user.cpp. +

+References _PlayList, NL3D_HAUTO_UI_PLAY_LIST, NL3D_MEM_PLAYLIST, NL3D::CAnimationPlaylist::setStartWeight(), NL3D::TGlobalAnimationTime, and uint8. +

+

00170 {
+00171         NL3D_MEM_PLAYLIST
+00172         NL3D_HAUTO_UI_PLAY_LIST;
+00173 
+00174         _PlayList.setStartWeight (slot, startWeight, time);
+00175 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NL3D::CPlayListUser::setTimeOrigin ( uint8  slot,
TGlobalAnimationTime  timeOrigin
)  [virtual]
+
+ + + + + +
+   + + +

+Set animation time origin, ie, the time in the playlist for which slot time is the startTime of the slot animation. Default value is 0.f.

+

Parameters:
+ + + +
slot is the id of the slot to set.
timeOrigin time origin to use in the slot.
+
+ +

+Implements NL3D::UPlayList. +

+Definition at line 120 of file play_list_user.cpp. +

+References _PlayList, NL3D_HAUTO_UI_PLAY_LIST, NL3D_MEM_PLAYLIST, NL3D::CAnimationPlaylist::setTimeOrigin(), NL3D::TGlobalAnimationTime, and uint8. +

+

00121 {
+00122         NL3D_MEM_PLAYLIST
+00123         NL3D_HAUTO_UI_PLAY_LIST;
+00124 
+00125         _PlayList.setTimeOrigin (slot, timeOrigin);
+00126 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NL3D::CPlayListUser::setWeight ( uint8  slot,
float  weight
)  [virtual]
+
+ + + + + +
+   + + +

+Setup a constant animation weight. NB: this is equivalent as following code:

    +
  • setStartWeight(slot, weight, 0);
  • setEndWeight(slot, weight, 0);
+

+

Parameters:
+ + + +
slot is the id of the slot to set.
weight is the factor to use in this slot.
+
+ +

+Implements NL3D::UPlayList. +

+Definition at line 217 of file play_list_user.cpp. +

+References _PlayList, NL3D_HAUTO_UI_PLAY_LIST, NL3D_MEM_PLAYLIST, NL3D::CAnimationPlaylist::setEndWeight(), NL3D::CAnimationPlaylist::setStartWeight(), and uint8. +

+

00218 {
+00219         NL3D_MEM_PLAYLIST
+00220         NL3D_HAUTO_UI_PLAY_LIST;
+00221 
+00222         _PlayList.setStartWeight (slot, weight, 0);
+00223         _PlayList.setEndWeight (slot, weight, 0);
+00224 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NL3D::CPlayListUser::setWeightSmoothness ( uint8  slot,
float  smoothness
)  [virtual]
+
+ + + + + +
+   + + +

+Set weight smoothness. This is the smoothness of the weight interpolation. Must be between 0.f and 1.f. 0.f is a sharp interpolation (linear), 1.f is a smooth interpolation (quadratic). Default value is 0.f.

+

Parameters:
+ + + +
slot is the id of the slot to set.
smoothness is the smoothness value.
+
+ +

+Implements NL3D::UPlayList. +

+Definition at line 201 of file play_list_user.cpp. +

+References _PlayList, NL3D_HAUTO_UI_PLAY_LIST, NL3D_MEM_PLAYLIST, NL3D::CAnimationPlaylist::setWeightSmoothness(), and uint8. +

+

00202 {
+00203         NL3D_MEM_PLAYLIST
+00204         NL3D_HAUTO_UI_PLAY_LIST;
+00205 
+00206         _PlayList.setWeightSmoothness (slot, smoothness);
+00207 }
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NL3D::CPlayListUser::setWrapMode ( uint8  slot,
TWrapMode  wrapMode
)  [virtual]
+
+ + + + + +
+   + + +

+Set the wrap mode to use in the play list.

+Wrap mode tells the play list how to use an animation when current time is not in the animation.

Parameters:
+ + +
wrapMode is the mode to use.
+
+ +

+Implements NL3D::UPlayList. +

+Definition at line 151 of file play_list_user.cpp. +

+References _PlayList, NL3D_HAUTO_UI_PLAY_LIST, NL3D_MEM_PLAYLIST, NL3D::CAnimationPlaylist::setWrapMode(), uint, and uint8. +

+

00152 {
+00153         NL3D_MEM_PLAYLIST
+00154         NL3D_HAUTO_UI_PLAY_LIST;
+00155 
+00156         _PlayList.setWrapMode (slot, (CAnimationPlaylist::TWrapMode)(uint)wrapMode);
+00157 }
+
+

Friends And Related Function Documentation

+

+ + + + +
+ + +
friend class CPlayListManagerUser [friend] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 58 of file play_list_user.h.

+

Field Documentation

+

+ + + + +
+ + +
NLMISC::CSmartPtr<CAnimationSet> NL3D::CPlayListUser::_AnimationSet [private] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 56 of file play_list_user.h.

+

+ + + + +
+ + +
CChannelMixer NL3D::CPlayListUser::_ChannelMixer [private] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 54 of file play_list_user.h. +

+Referenced by CPlayListUser(), NL3D::CPlayListManagerUser::createPlayList(), enableChannel(), evalPlayList(), isChannelEnabled(), registerTransform(), and resetAllChannels().

+

+ + + + +
+ + +
CAnimationPlaylist NL3D::CPlayListUser::_PlayList [private] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 53 of file play_list_user.h. +

+Referenced by NL3D::CPlayListManagerUser::createPlayList(), emptyPlayList(), evalPlayList(), getAnimation(), getEndWeight(), getLocalWeight(), getSkeletonWeight(), getSpeedFactor(), getStartWeight(), getTimeOrigin(), getWeightSmoothness(), getWrapMode(), setAnimation(), setEndWeight(), setSkeletonWeight(), setSpeedFactor(), setStartWeight(), setTimeOrigin(), setWeight(), setWeightSmoothness(), and setWrapMode().

+

The documentation for this class was generated from the following files: +
Generated on Tue Mar 16 07:01:28 2004 for NeL by + +doxygen +1.3.6
+ + -- cgit v1.2.1