Castor3D  ..
Classes | Public Member Functions | List of all members
Castor3D::SkeletonAnimationBone Class Reference

Implementation of MovingObjectBase for Bones. More...

+ Inheritance diagram for Castor3D::SkeletonAnimationBone:
+ Collaboration diagram for Castor3D::SkeletonAnimationBone:

Classes

class  BinaryParser
 MovingBone binary loader. More...
 

Public Member Functions

C3D_API SkeletonAnimationBone ()
 Constructor. More...
 
C3D_API ~SkeletonAnimationBone ()
 Destructor. More...
 
virtual Castor::String const & GetName () const
 Retrieves the object name. More...
 
void SetBone (BoneSPtr p_bone)
 Defines the movable object. More...
 
BoneSPtr GetBone () const
 Retrieves the moving object. More...
 
- Public Member Functions inherited from Castor3D::AnimationObject
virtual C3D_API ~AnimationObject ()
 Destructor. More...
 
C3D_API void AddChild (AnimationObjectSPtr p_object)
 Adds a child to this object. More...
 
C3D_API void Update (real p_time, Castor::Matrix4x4r const &p_transformations)
 Updates the object, applies the transformations at given time. More...
 
C3D_API KeyFrameAddKeyFrame (real p_from, Castor::Point3r const &p_translate=Castor::Point3r{}, Castor::Quaternion const &p_rotate=Castor::Quaternion{}, Castor::Point3r const &p_scale=Castor::Point3r{ 1.0_r, 1.0_r, 1.0_r })
 Creates a scaling key frame and adds it to the list. More...
 
C3D_API void RemoveKeyFrame (real p_time)
 Deletes the scaling key frame at time index p_time. More...
 
C3D_API void SetInterpolationMode (eINTERPOLATOR_MODE p_mode)
 
C3D_API AnimationObjectSPtr Clone (Animation &p_animation)
 Clones this moving thing. More...
 
eINTERPOLATOR_MODE GetInterpolationMode () const
 
KeyFrameArray const & GetKeyFrames () const
 
real GetLength () const
 
eANIMATION_OBJECT_TYPE GetType () const
 
void SetLength (real p_length)
 Sets the animation length. More...
 
Castor::Matrix4x4r const & GetFinalTransform () const
 The final object's animations transformation. More...
 
Castor::Matrix4x4r const & GetNodeTransform () const
 Retrieves the animation node transformation. More...
 
void SetNodeTransform (Castor::Matrix4x4r const &p_transform)
 Sets the animation node transformation. More...
 
bool HasKeyFrames () const
 Tells whether or not the object has keyframes. More...
 
AnimationObjectPtrArray const & GetChildren () const
 

Additional Inherited Members

- Protected Member Functions inherited from Castor3D::AnimationObject
C3D_API AnimationObject (eANIMATION_OBJECT_TYPE p_type)
 Constructor. More...
 
C3D_API AnimationObject (AnimationObject const &p_rhs)
 Copy constructor. More...
 
- Protected Attributes inherited from Castor3D::AnimationObject
eANIMATION_OBJECT_TYPE m_type
 The moving thing type. More...
 
eINTERPOLATOR_MODE m_mode = eINTERPOLATOR_MODE_NONE
 The interpolation mode. More...
 
std::unique_ptr< Point3rInterpolatorm_pointInterpolator
 The point interpolator. More...
 
std::unique_ptr< QuaternionInterpolatorm_quaternionInterpolator
 The quaternion interpolator. More...
 
KeyFrameArray m_keyframes
 The key frames. More...
 
KeyFrameArray::const_iterator m_prev
 Iterator to the previous keyframe (when playing the animation). More...
 
KeyFrameArray::const_iterator m_curr
 Iterator to the current keyframe (when playing the animation). More...
 
Castor::Matrix4x4r m_nodeTransform
 Animation node transformations. More...
 
real m_length
 The animation length. More...
 
AnimationObjectPtrArray m_children
 The objects depending on this one. More...
 
Castor::Matrix4x4r m_cumulativeTransform
 The cumulative animation transformations. More...
 
Castor::Matrix4x4r m_finalTransform
 The matrix holding transformation at current time. More...
 

Detailed Description

Implementation of MovingObjectBase for Bones.

Author
Sylvain DOREMUS
Version
0.7.0
Date
09/12/2013

Constructor & Destructor Documentation

◆ SkeletonAnimationBone()

C3D_API Castor3D::SkeletonAnimationBone::SkeletonAnimationBone ( )

Constructor.

◆ ~SkeletonAnimationBone()

C3D_API Castor3D::SkeletonAnimationBone::~SkeletonAnimationBone ( )

Destructor.

Member Function Documentation

◆ GetBone()

BoneSPtr Castor3D::SkeletonAnimationBone::GetBone ( ) const
inline

Retrieves the moving object.

Returns
The moving object

◆ GetName()

virtual Castor::String const& Castor3D::SkeletonAnimationBone::GetName ( ) const
virtual

Retrieves the object name.

Returns
The name

Implements Castor3D::AnimationObject.

◆ SetBone()

void Castor3D::SkeletonAnimationBone::SetBone ( BoneSPtr  p_bone)
inline

Defines the movable object.

Parameters
[in]p_boneThe object

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