PixelLightAPI  .
Public Member Functions
PLMesh::Skeleton Class Reference

Hierarchical skeleton class. More...

#include <Skeleton.h>

Inheritance diagram for PLMesh::Skeleton:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual PLMESH_API ~Skeleton ()
 Destructor.
PLMESH_API const PLCore::Array
< PLCore::uint32 > & 
GetRootJoints () const
 Returns the skeleton root joint indices.
PLMESH_API void UpdateJointInformation ()
 Updates the joint information.
PLMESH_API Skeletonoperator= (const Skeleton &cSource)
virtual PLMESH_API PLCore::String GetSourceName () const override
 Get the animation source name.
virtual PLMESH_API bool Unload () override
 Unloads the loadable.
virtual PLMESH_API PLCore::String GetLoadableTypeName () const override
 Returns the loadable type name.

Detailed Description

Hierarchical skeleton class.


Constructor & Destructor Documentation

virtual PLMESH_API PLMesh::Skeleton::~Skeleton ( ) [virtual]

Destructor.


Member Function Documentation

PLMESH_API const PLCore::Array<PLCore::uint32>& PLMesh::Skeleton::GetRootJoints ( ) const

Returns the skeleton root joint indices.

Returns:
Skeleton root joint indices
Note:
Must be called after joint parent/child manipulation

Updates the joint information.

See also:
PLMESH_API Skeleton& PLMesh::Skeleton::operator= ( const Skeleton cSource)
virtual PLMESH_API PLCore::String PLMesh::Skeleton::GetSourceName ( ) const [override, virtual]

Get the animation source name.

Returns:
Animation source name, empty on error
Note:
  • If this is a skeleton animation, the source name is the name of a skeleton. (SkeletonManager::Get(...))
  • If this is a vertex animation, the source name is the name of a morph target animation. (pMyMesh->GetMorphTargetAnimationManager().Get(...))

Reimplemented from PLRenderer::AnimationInfo.

virtual PLMESH_API bool PLMesh::Skeleton::Unload ( ) [override, virtual]

Unloads the loadable.

Returns:
'true' if all went fine, else 'false'

Reimplemented from PLCore::Loadable.

virtual PLMESH_API PLCore::String PLMesh::Skeleton::GetLoadableTypeName ( ) const [override, virtual]

Returns the loadable type name.

Returns:
The loadable type name

Reimplemented from PLCore::Loadable.


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


PixelLight PixelLight 0.9.11-R1
Copyright (C) 2002-2012 by The PixelLight Team
Last modified Thu Feb 23 2012 14:09:37
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported