PLRenderer::TextureAni Class Reference

Texture animation resource class. More...

#include <TextureAni.h>

Inheritance diagram for PLRenderer::TextureAni:

List of all members.

Classes
struct	ColorFrame
	Color animation. More...
struct	MatrixFrame
	Matrix animation. More...
struct	TextureFrame
	Texture animation. More...
Public Member Functions
virtual PLRENDERER_API	~TextureAni ()
	Destructor.
PLRENDERER_API TextureAni &	operator= (const TextureAni &cSource)
	Copy operator.
AniInfoManager &	GetTextureAnimationManager ()
	Returns the texture animation manager.
const AniInfoManager &	GetTextureAnimationManager () const
PLRENDERER_API void	CreateStandardTextureAnimation ()
	Create standard texture animation.
PLCore::Array< TextureFrame * > &	GetTextureFrames ()
	Returns the texture frames array.
const PLCore::Array < TextureFrame * > &	GetTextureFrames () const
AniInfoManager &	GetMatrixAnimationManager ()
	Returns the matrix animation manager.
const AniInfoManager &	GetMatrixAnimationManager () const
PLRENDERER_API void	CreateStandardMatrixAnimation ()
	Create standard matrix animation.
PLCore::Array< MatrixFrame * > &	GetMatrixFrames ()
	Returns the matrix frames array.
const PLCore::Array < MatrixFrame * > &	GetMatrixFrames () const
AniInfoManager &	GetColorAnimationManager ()
	Returns the color animation manager.
const AniInfoManager &	GetColorAnimationManager () const
PLRENDERER_API void	CreateStandardColorAnimation ()
	Create standard color animation.
PLCore::Array< ColorFrame * > &	GetColorFrames ()
	Returns the color frames array.
const PLCore::Array < ColorFrame * > &	GetColorFrames () const
virtual PLRENDERER_API bool	IsAnimated () const override
	Returns whether or not this texture is animated.
virtual PLRENDERER_API bool	LoadByFilename (const PLCore::String &sFilename, const PLCore::String &sParams="", const PLCore::String &sMethod="") override
	Loads the loadable from a file given by filename.
virtual PLRENDERER_API bool	SaveByFilename (const PLCore::String &sFilename, const PLCore::String &sParams="", const PLCore::String &sMethod="") override
	Saves the loadable to a file given by filename.
virtual PLRENDERER_API bool	SaveByFile (PLCore::File &cFile, const PLCore::String &sParams="", const PLCore::String &sMethod="") override
	Saves the loadable to a file given by reference.
virtual PLRENDERER_API bool	Unload () override
	Unloads the loadable.
virtual PLRENDERER_API PLCore::String	GetLoadableTypeName () const override
	Returns the loadable type name.

---

Detailed Description

Texture animation resource class.

---

Constructor & Destructor Documentation

virtual PLRENDERER_API PLRenderer::TextureAni::~TextureAni

(

)

[virtual]

Destructor.

---

Member Function Documentation

PLRENDERER_API TextureAni& PLRenderer::TextureAni::operator=

(

const TextureAni &

cSource

)

Copy operator.

Parameters:

[in]

cSource

Source to copy from

Returns:

This instance

AniInfoManager & PLRenderer::TextureAni::GetTextureAnimationManager

(

)

[inline]

Returns the texture animation manager.

Returns:

The texture handlers texture animation manager

const AniInfoManager & PLRenderer::TextureAni::GetTextureAnimationManager

(

)

const [inline]

PLRENDERER_API void PLRenderer::TextureAni::CreateStandardTextureAnimation

(

)

Create standard texture animation.

Note:

• A standard animation in only added if there are at the moment no animations at all

PLCore::Array< TextureAni::TextureFrame * > & PLRenderer::TextureAni::GetTextureFrames

(

)

[inline]

Returns the texture frames array.

Returns:

The texture frames array

const PLCore::Array< TextureAni::TextureFrame * > & PLRenderer::TextureAni::GetTextureFrames

(

)

const [inline]

AniInfoManager & PLRenderer::TextureAni::GetMatrixAnimationManager

(

)

[inline]

Returns the matrix animation manager.

Returns:

The texture handlers matrix animation manager

const AniInfoManager & PLRenderer::TextureAni::GetMatrixAnimationManager

(

)

const [inline]

PLRENDERER_API void PLRenderer::TextureAni::CreateStandardMatrixAnimation

(

)

Create standard matrix animation.

Note:

• A standard animation in only added if there are at the moment no animations at all

PLCore::Array< TextureAni::MatrixFrame * > & PLRenderer::TextureAni::GetMatrixFrames

(

)

[inline]

Returns the matrix frames array.

Returns:

The matrix frames array

const PLCore::Array< TextureAni::MatrixFrame * > & PLRenderer::TextureAni::GetMatrixFrames

(

)

const [inline]

AniInfoManager & PLRenderer::TextureAni::GetColorAnimationManager

(

)

[inline]

Returns the color animation manager.

Returns:

The texture handlers color animation manager

const AniInfoManager & PLRenderer::TextureAni::GetColorAnimationManager

(

)

const [inline]

PLRENDERER_API void PLRenderer::TextureAni::CreateStandardColorAnimation

(

)

Create standard color animation.

Note:

• A standard animation in only added if there are at the moment no animations at all

PLCore::Array< TextureAni::ColorFrame * > & PLRenderer::TextureAni::GetColorFrames

(

)

[inline]

Returns the color frames array.

Returns:

The color frames array

const PLCore::Array< TextureAni::ColorFrame * > & PLRenderer::TextureAni::GetColorFrames

(

)

const [inline]

virtual PLRENDERER_API bool PLRenderer::TextureAni::IsAnimated

(

)

const [override, virtual]

Returns whether or not this texture is animated.

Returns:

'true' if this texture is animated, else 'false'

Remarks:

If this is an animated texture (tani filename extension) you can cast to 'TextureAni' to get the texture animation data.

Reimplemented from PLRenderer::Texture.

virtual PLRENDERER_API bool PLRenderer::TextureAni::LoadByFilename	(	const PLCore::String &	sFilename,
		const PLCore::String &	sParams = "",
		const PLCore::String &	sMethod = ""
	)		[override, virtual]

Loads the loadable from a file given by filename.

Parameters:

[in]	sFilename	Loadable filename
[in]	sParams	Optional load method parameters, can be an empty string
[in]	sMethod	Optional name of the load method to use, can be an empty string

Returns:

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

Note:

• If no method name was provided, 'Load' if sParams is empty, or 'LoadParams' if sParams is not empty is used automatically

Reimplemented from PLRenderer::Texture.

virtual PLRENDERER_API bool PLRenderer::TextureAni::SaveByFilename	(	const PLCore::String &	sFilename,
		const PLCore::String &	sParams = "",
		const PLCore::String &	sMethod = ""
	)		[override, virtual]

Saves the loadable to a file given by filename.

Parameters:

[in]	sFilename	Loadable filename
[in]	sParams	Optional save method parameters, can be an empty string
[in]	sMethod	Optional name of the save method to use, can be an empty string

Returns:

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

Note:

• If no method name was provided, 'Save' if sParams is empty, or 'SaveParams' if sParams is not empty is used automatically

Reimplemented from PLRenderer::Texture.

virtual PLRENDERER_API bool PLRenderer::TextureAni::SaveByFile	(	PLCore::File &	cFile,
		const PLCore::String &	sParams = "",
		const PLCore::String &	sMethod = ""
	)		[override, virtual]

Saves the loadable to a file given by reference.

Parameters:

[in]	cFile	File to save into, must be opened and writable
[in]	sParams	Optional save method parameters, can be an empty string
[in]	sMethod	Optional name of the save method to use, can be an empty string

Returns:

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

Note:

• If no method name was provided, 'Save' if sParams is empty, or 'SaveParams' if sParams is not empty is used automatically

Reimplemented from PLRenderer::Texture.

virtual PLRENDERER_API bool PLRenderer::TextureAni::Unload

(

)

[override, virtual]

Unloads the loadable.

Returns:

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

Reimplemented from PLRenderer::Texture.

virtual PLRENDERER_API PLCore::String PLRenderer::TextureAni::GetLoadableTypeName

(

)

const [override, virtual]

Returns the loadable type name.

Returns:

The loadable type name

Reimplemented from PLRenderer::Texture.

---

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

• TextureAni.h
• TextureAni.inl