castor3d::TextureAnimationKeyFrame Class Reference

#include <TextureAnimationKeyFrame.hpp>

Inheritance diagram for castor3d::TextureAnimationKeyFrame:

Collaboration diagram for castor3d::TextureAnimationKeyFrame:

Public Member Functions
C3D_API	TextureAnimationKeyFrame (TextureAnimation &parent, castor::Milliseconds const &timeIndex)
	Constructor.
C3D_API AnimationKeyFrameUPtr	clone (Animation &parent) const override
void	setTile (castor::Point2ui tile) noexcept
castor::Point2ui const &	getTile () const noexcept
Public Member Functions inherited from castor3d::AnimationKeyFrame
	AnimationKeyFrame (castor::Milliseconds const &timeIndex=0_ms)
	Constructor.
virtual C3D_API	~AnimationKeyFrame () noexcept=default
	Destructor.
virtual C3D_API void	initialise ()
	Initialises the keyframe.
castor::Milliseconds const &	getTimeIndex () const
void	setTimeIndex (castor::Milliseconds const &timeIndex)
castor::BoundingBox const &	getBoundingBox () const
Public Member Functions inherited from castor::OwnedBy< TextureAnimation >
TextureAnimation *	getOwner () const noexcept
void	setOwner (TextureAnimation &owner) noexcept

Friends
class	BinaryParser< TextureAnimationKeyFrame >

Additional Inherited Members
Protected Member Functions inherited from castor3d::AnimationKeyFrame
C3D_API void	doCloneInto (AnimationKeyFrame &output) const
Protected Member Functions inherited from castor::OwnedBy< TextureAnimation >
	OwnedBy (TextureAnimation &owner) noexcept
	Constructor.
Protected Attributes inherited from castor3d::AnimationKeyFrame
castor::Milliseconds	m_timeIndex
castor::BoundingBox	m_boundingBox

Constructor & Destructor Documentation

TextureAnimationKeyFrame()

C3D_API castor3d::TextureAnimationKeyFrame::TextureAnimationKeyFrame	(	TextureAnimation &	parent,
		castor::Milliseconds const &	timeIndex )

Constructor.

Parameters

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

Member Function Documentation

clone()

C3D_API AnimationKeyFrameUPtr castor3d::TextureAnimationKeyFrame::clone ( Animation & parent ) const

overridevirtual

Returns

A clone of this object.

Implements castor3d::AnimationKeyFrame.

getTile()

castor::Point2ui const & castor3d::TextureAnimationKeyFrame::getTile ( ) const

inlinenoexcept

setTile()

void castor3d::TextureAnimationKeyFrame::setTile ( castor::Point2ui tile )

inlinenoexcept

Friends And Related Symbol Documentation

BinaryParser< TextureAnimationKeyFrame >

friend class BinaryParser< TextureAnimationKeyFrame >

friend

---

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

• Castor3D/Material/Texture/Animation/TextureAnimationKeyFrame.hpp