castor3d::AnimationKeyFrame Class Reference

#include <AnimationKeyFrame.hpp>

Inheritance diagram for castor3d::AnimationKeyFrame:

Collaboration diagram for castor3d::AnimationKeyFrame:

Public Member Functions
	AnimationKeyFrame (castor::Milliseconds const &timeIndex=0_ms)
	Constructor.
virtual C3D_API	~AnimationKeyFrame () noexcept=default
	Destructor.
virtual C3D_API void	initialise ()
	Initialises the keyframe.
virtual C3D_API AnimationKeyFrameUPtr	clone (Animation &parent) const =0
castor::Milliseconds const &	getTimeIndex () const
void	setTimeIndex (castor::Milliseconds const &timeIndex)
castor::BoundingBox const &	getBoundingBox () const

Protected Member Functions
C3D_API void	doCloneInto (AnimationKeyFrame &output) const

Protected Attributes
castor::Milliseconds	m_timeIndex
castor::BoundingBox	m_boundingBox

Constructor & Destructor Documentation

AnimationKeyFrame()

castor3d::AnimationKeyFrame::AnimationKeyFrame ( castor::Milliseconds const & timeIndex = 0_ms )

inlineexplicit

Constructor.

Parameters

[in]

timeIndex

When the key frame starts.

~AnimationKeyFrame()

virtual C3D_API castor3d::AnimationKeyFrame::~AnimationKeyFrame ( )

virtualdefaultnoexcept

Destructor.

Member Function Documentation

clone()

virtual C3D_API AnimationKeyFrameUPtr castor3d::AnimationKeyFrame::clone ( Animation & parent ) const

pure virtual

Returns

A clone of this object.

Implemented in castor3d::TextureAnimationKeyFrame, castor3d::MeshMorphTarget, castor3d::SkeletonAnimationKeyFrame, and castor3d::SceneNodeAnimationKeyFrame.

doCloneInto()

C3D_API void castor3d::AnimationKeyFrame::doCloneInto ( AnimationKeyFrame & output ) const

inlineprotected

References m_boundingBox.

getBoundingBox()

castor::BoundingBox const & castor3d::AnimationKeyFrame::getBoundingBox ( ) const

inline

Returns

The keyframe's bounding box.

References m_boundingBox.

getTimeIndex()

castor::Milliseconds const & castor3d::AnimationKeyFrame::getTimeIndex ( ) const

inline

Returns

The start time index.

References m_timeIndex.

Referenced by castor3d::SkeletonAnimationInstanceKeyFrame::getTimeIndex().

Here is the caller graph for this function:

initialise()

virtual C3D_API void castor3d::AnimationKeyFrame::initialise ( )

inlinevirtual

Initialises the keyframe.

Reimplemented in castor3d::SkeletonAnimationKeyFrame.

setTimeIndex()

void castor3d::AnimationKeyFrame::setTimeIndex ( castor::Milliseconds const & timeIndex )

inline

Parameters

[in]

timeIndex

The start time index.

References m_timeIndex.

Member Data Documentation

m_boundingBox

castor::BoundingBox castor3d::AnimationKeyFrame::m_boundingBox

protected

The bounding box.

Referenced by doCloneInto(), and getBoundingBox().

m_timeIndex

castor::Milliseconds castor3d::AnimationKeyFrame::m_timeIndex

protected

The start time index.

Referenced by getTimeIndex(), and setTimeIndex().

---

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

• Castor3D/Animation/AnimationKeyFrame.hpp