castor3d::SkeletonAnimationKeyFrame Class Reference

#include <SkeletonAnimationKeyFrame.hpp>

Inheritance diagram for castor3d::SkeletonAnimationKeyFrame:

Collaboration diagram for castor3d::SkeletonAnimationKeyFrame:

Public Member Functions
C3D_API	SkeletonAnimationKeyFrame (SkeletonAnimation &skeletonAnimation, castor::Milliseconds const &timeIndex)
	Constructor.
C3D_API void	addAnimationObject (SkeletonAnimationObject &object, castor::Point3f const &translate, castor::Quaternion const &rotate, castor::Point3f const &scale)
	Adds an animation object.
C3D_API bool	hasObject (SkeletonAnimationObject const &object) const
C3D_API TransformArray::const_iterator	find (SkeletonAnimationObject const &object) const
C3D_API TransformArray::const_iterator	find (BoneNode const &bone) const
C3D_API TransformArray::iterator	find (SkeletonAnimationObject const &object)
C3D_API TransformArray::iterator	find (BoneNode const &bone)
C3D_API SubmeshBoundingBoxList const &	computeBoundingBoxes (Mesh const &mesh, Skeleton const &skeleton) const
C3D_API void	initialise () override
	Initialises the keyframe.
TransformArray::const_iterator	begin () const
TransformArray::iterator	begin ()
TransformArray::const_iterator	end () const
TransformArray::iterator	end ()
Public Member Functions inherited from castor3d::AnimationKeyFrame
	AnimationKeyFrame (castor::Milliseconds const &timeIndex=0_ms)
	Constructor.
virtual C3D_API	~AnimationKeyFrame () noexcept=default
	Destructor.
castor::Milliseconds const &	getTimeIndex () const
castor::BoundingBox const &	getBoundingBox () const
Public Member Functions inherited from castor::OwnedBy< SkeletonAnimation >
SkeletonAnimation *	getOwner () const

Friends
class	BinaryParser< SkeletonAnimationKeyFrame >
class	BinaryWriter< SkeletonAnimationKeyFrame >

Additional Inherited Members
Protected Member Functions inherited from castor::OwnedBy< SkeletonAnimation >
	OwnedBy (SkeletonAnimation &owner)
	Constructor.
Protected Attributes inherited from castor3d::AnimationKeyFrame
castor::Milliseconds	m_timeIndex
castor::BoundingBox	m_boundingBox

Constructor & Destructor Documentation

SkeletonAnimationKeyFrame()

C3D_API castor3d::SkeletonAnimationKeyFrame::SkeletonAnimationKeyFrame	(	SkeletonAnimation &	skeletonAnimation,
		castor::Milliseconds const &	timeIndex )

Constructor.

Parameters

[in]	skeletonAnimation	The parent animation.
[in]	timeIndex	When the key frame starts.

Member Function Documentation

addAnimationObject()

C3D_API void castor3d::SkeletonAnimationKeyFrame::addAnimationObject	(	SkeletonAnimationObject &	object,
		castor::Point3f const &	translate,
		castor::Quaternion const &	rotate,
		castor::Point3f const &	scale )

Adds an animation object.

Parameters

[in]	object	The animation object.
[in]	translate	The translation at start time.
[in]	rotate	The rotation at start time.
[in]	scale	The scaling at start time.

begin() [1/2]

TransformArray::iterator castor3d::SkeletonAnimationKeyFrame::begin ( )

inline

Returns

The beginning of the cumulative transforms map.

begin() [2/2]

TransformArray::const_iterator castor3d::SkeletonAnimationKeyFrame::begin ( ) const

inline

Returns

The beginning of the cumulative transforms map.

computeBoundingBoxes()

C3D_API SubmeshBoundingBoxList const & castor3d::SkeletonAnimationKeyFrame::computeBoundingBoxes	(	Mesh const &	mesh,
		Skeleton const &	skeleton ) const

Returns

The keyframe's bounding box.

end() [1/2]

TransformArray::iterator castor3d::SkeletonAnimationKeyFrame::end ( )

inline

Returns

The end of the cumulative transforms map.

end() [2/2]

TransformArray::const_iterator castor3d::SkeletonAnimationKeyFrame::end ( ) const

inline

Returns

The end of the cumulative transforms map.

find() [1/4]

C3D_API TransformArray::iterator castor3d::SkeletonAnimationKeyFrame::find

(

BoneNode const &

bone

)

Returns

The iterator matching given bone, into cumulative transforms map.

find() [2/4]

C3D_API TransformArray::const_iterator castor3d::SkeletonAnimationKeyFrame::find

(

BoneNode const &

bone

)

const

Returns

The iterator matching given bone, into cumulative transforms map.

find() [3/4]

C3D_API TransformArray::iterator castor3d::SkeletonAnimationKeyFrame::find

(

SkeletonAnimationObject const &

object

)

Returns

The iterator matching given animation object, into cumulative transforms map.

find() [4/4]

C3D_API TransformArray::const_iterator castor3d::SkeletonAnimationKeyFrame::find

(

SkeletonAnimationObject const &

object

)

const

Returns

The iterator matching given animation object, into cumulative transforms map.

hasObject()

C3D_API bool castor3d::SkeletonAnimationKeyFrame::hasObject

(

SkeletonAnimationObject const &

object

)

const

Returns

true if the given object is into the transforms map (not the cumulative one).

initialise()

C3D_API void castor3d::SkeletonAnimationKeyFrame::initialise ( )

overridevirtual

Initialises the keyframe.

Reimplemented from castor3d::AnimationKeyFrame.

Friends And Related Symbol Documentation

BinaryParser< SkeletonAnimationKeyFrame >

friend class BinaryParser< SkeletonAnimationKeyFrame >

friend

BinaryWriter< SkeletonAnimationKeyFrame >

friend class BinaryWriter< SkeletonAnimationKeyFrame >

friend

---

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

• Castor3D/Model/Skeleton/Animation/SkeletonAnimationKeyFrame.hpp