From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- .../nel/classNL3D_1_1CAnimationSetUser.html | 762 +++++++++++++++++++++ 1 file changed, 762 insertions(+) create mode 100644 docs/doxygen/nel/classNL3D_1_1CAnimationSetUser.html (limited to 'docs/doxygen/nel/classNL3D_1_1CAnimationSetUser.html') diff --git a/docs/doxygen/nel/classNL3D_1_1CAnimationSetUser.html b/docs/doxygen/nel/classNL3D_1_1CAnimationSetUser.html new file mode 100644 index 00000000..8daa48b3 --- /dev/null +++ b/docs/doxygen/nel/classNL3D_1_1CAnimationSetUser.html @@ -0,0 +1,762 @@ + + + + nevrax.org : docs + + + + + + + + + + + + + + +
# Home   # nevrax.com   
+ + + + +
Nevrax
+ + + + + + + + + + +
+ + +
+ Nevrax.org
+ + + + + + + +
#News
#Mailing-list
#Documentation
#CVS
#Bugs
#License
+
+ + + 		+ + +
+Docs + +
+  + + + + + +
Documentation 
+ +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages   Search  
+

NL3D::CAnimationSetUser Class Reference

UAnimationSet implementation. +More... +

+#include <animation_set_user.h> +

+

Inheritance diagram for NL3D::CAnimationSetUser: +

+ +NL3D::UAnimationSet + +List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Methods

 CAnimationSetUser ()
 Constructor. More...

 CAnimationSetUser (NLMISC::IStream &f)
 Constructor. More...

uint addAnimation (const char *fileName, const char *animName)
 Add an animation in the animation set. More...

virtual void build ()
 Build the animation set. More...

virtual uint addSkeletonWeight (const char *fileName, const char *skelName)
 Add a skeleton weight in the animation set. More...

const CAnimationSet * getAnimationSet () const
Animations mgt.
virtual uint getNumAnimation () const
 Get animations count. More...

virtual uint getAnimationIdByName (const std::string &name) const
 Get a animation ID by name. More...

virtual const std::string & getAnimationName (uint animationId) const
 Get animation name. More...

virtual UAnimation * getAnimation (uint animationId)
 Get a writable animation pointer. More...

SkeletonWeight mgt.
virtual uint getNumSkeletonWeight () const
 Get skeleton weight count. More...

virtual uint getSkeletonWeightIdByName (const std::string &name) const
 Get a SkeletonWeight ID by name. More...

virtual const std::string & getSkeletonWeightName (uint skeletonId) const
 Get skeleton template name. More...

Channel mgt.
virtual uint getChannelIdByName (const std::string &name) const
 Get a channel ID with its name. More...


Private Attributes

NLMISC::CSmartPtr< CAnimationSet > _AnimationSet

Friends

class CPlayListManagerUser
class CSceneUser
+

Detailed Description

+UAnimationSet implementation. +

+

+Author:
+Lionel Berenguier , Nevrax France
+Date:
+2001
+

+ +

+Definition at line 55 of file animation_set_user.h.

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + +
NL3D::CAnimationSetUser::CAnimationSetUser (   )  [inline]
+
+ + + + + +
+   + + +

+Constructor. +

+ +

+Definition at line 65 of file animation_set_user.h. +

+References NL3D_MEM_ANIMATION_SET, and nlassert.

+

+ + + + +
+ + + + + + + + + + +
NL3D::CAnimationSetUser::CAnimationSetUser ( NLMISC::IStream &   f )  [inline]
+
+ + + + + +
+   + + +

+Constructor. +

+ +

+Definition at line 76 of file animation_set_user.h. +

+References NL3D_MEM_ANIMATION_SET, and nlassert.

+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
uint NL3D::CAnimationSetUser::addAnimation ( const char *   fileName,
const char *   animName
)  [inline, virtual]
+
+ + + + + +
+   + + +

+Add an animation in the animation set. +

+After adding all your animations, call build().

+Parameters:
+ + + +
fileName  +is the animation filename
animName  +is the name of the animation in the animation set.
+
+Returns:
+NotFound if the file is not found.
+

+Implements NL3D::UAnimationSet. +

+Definition at line 95 of file animation_set_user.h. +

+References file, id, NLMISC::CPath::lookup, NL3D_MEM_ANIMATION_SET, NLMISC::CIFile::open, and NLMISC::IStream::serial.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
virtual uint NL3D::CAnimationSetUser::addSkeletonWeight ( const char *   fileName,
const char *   skelName
)  [inline, virtual]
+
+ + + + + +
+   + + +

+Add a skeleton weight in the animation set. +

+This method use CPath to search the skeleton file.

+Parameters:
+ + + +
fileName  +is the skeleton weight filename
animName  +is the name of the skeleton weight in the animation set.
+
+Returns:
+the id of the new skeleton or NotFound if the file is not found.
+

+Implements NL3D::UAnimationSet. +

+Definition at line 139 of file animation_set_user.h. +

+References file, id, NLMISC::CPath::lookup, NL3D_MEM_ANIMATION_SET, NLMISC::CIFile::open, and NLMISC::IStream::serial.

+

+ + + + +
+ + + + + + + + + +
virtual void NL3D::CAnimationSetUser::build (   )  [inline, virtual]
+
+ + + + + +
+   + + +

+Build the animation set. +

+Call build after adding all your animations. +

+Implements NL3D::UAnimationSet. +

+Definition at line 124 of file animation_set_user.h. +

+References NL3D_MEM_ANIMATION_SET.

+

+ + + + +
+ + + + + + + + + + +
UAnimation * NL3D::CAnimationSetUser::getAnimation ( uint   animationId )  [virtual]
+
+ + + + + +
+   + + +

+Get a writable animation pointer. +

+

+Returns:
+the end time.
+

+Implements NL3D::UAnimationSet. +

+Definition at line 36 of file animation_set_user.cpp. +

+References _AnimationSet, and NL3D_MEM_ANIMATION_SET.

+

+ + + + +
+ + + + + + + + + + +
virtual uint NL3D::CAnimationSetUser::getAnimationIdByName ( const std::string &   name )  const [inline, virtual]
+
+ + + + + +
+   + + +

+Get a animation ID by name. +

+If no animation is found, method returns NotFound. +

+Implements NL3D::UAnimationSet. +

+Definition at line 177 of file animation_set_user.h. +

+References NL3D_MEM_ANIMATION_SET.

+

+ + + + +
+ + + + + + + + + + +
virtual const std::string& NL3D::CAnimationSetUser::getAnimationName ( uint   animationId )  const [inline, virtual]
+
+ + + + + +
+   + + +

+Get animation name. +

+ +

+Implements NL3D::UAnimationSet. +

+Definition at line 187 of file animation_set_user.h. +

+References getNumAnimation, NL3D_MEM_ANIMATION_SET, and nlerror.

+

+ + + + +
+ + + + + + + + + +
const CAnimationSet * NL3D::CAnimationSetUser::getAnimationSet (   )  const
+
+ + + + + +
+   + + +

+ +

+Definition at line 45 of file animation_set_user.cpp. +

+References _AnimationSet, and NL3D_MEM_ANIMATION_SET.

+

+ + + + +
+ + + + + + + + + + +
virtual uint NL3D::CAnimationSetUser::getChannelIdByName ( const std::string &   name )  const [inline, virtual]
+
+ + + + + +
+   + + +

+Get a channel ID with its name. +

+If no channel is found, method returns NotFound. +

+Implements NL3D::UAnimationSet. +

+Definition at line 246 of file animation_set_user.h. +

+References NL3D_MEM_ANIMATION_SET.

+

+ + + + +
+ + + + + + + + + +
virtual uint NL3D::CAnimationSetUser::getNumAnimation (   )  const [inline, virtual]
+
+ + + + + +
+   + + +

+Get animations count. +

+ +

+Implements NL3D::UAnimationSet. +

+Definition at line 167 of file animation_set_user.h. +

+References NL3D_MEM_ANIMATION_SET. +

+Referenced by getAnimationName.

+

+ + + + +
+ + + + + + + + + +
virtual uint NL3D::CAnimationSetUser::getNumSkeletonWeight (   )  const [inline, virtual]
+
+ + + + + +
+   + + +

+Get skeleton weight count. +

+ +

+Implements NL3D::UAnimationSet. +

+Definition at line 211 of file animation_set_user.h. +

+References NL3D_MEM_ANIMATION_SET. +

+Referenced by getSkeletonWeightName.

+

+ + + + +
+ + + + + + + + + + +
virtual uint NL3D::CAnimationSetUser::getSkeletonWeightIdByName ( const std::string &   name )  const [inline, virtual]
+
+ + + + + +
+   + + +

+Get a SkeletonWeight ID by name. +

+If no SkeletonWeight is found, method returns NotFound. +

+Implements NL3D::UAnimationSet. +

+Definition at line 221 of file animation_set_user.h. +

+References NL3D_MEM_ANIMATION_SET.

+

+ + + + +
+ + + + + + + + + + +
virtual const std::string& NL3D::CAnimationSetUser::getSkeletonWeightName ( uint   skeletonId )  const [inline, virtual]
+
+ + + + + +
+   + + +

+Get skeleton template name. +

+ +

+Implements NL3D::UAnimationSet. +

+Definition at line 231 of file animation_set_user.h. +

+References getNumSkeletonWeight, NL3D_MEM_ANIMATION_SET, and nlerror.

+

Friends And Related Function Documentation

+

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

+ +

+Definition at line 59 of file animation_set_user.h.

+

+ + + + +
+ + +
friend class CSceneUser [friend] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 60 of file animation_set_user.h.

+

Member Data Documentation

+

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

+ +

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

+Referenced by getAnimation, and getAnimationSet.

+

The documentation for this class was generated from the following files: + + + +
                                                                                                                                                                    +
+ + -- cgit v1.2.1