Loads animations and animation chains from a file and deletes all existing ones. More...

#include <GUILoadAnimationsCmd.h>

Inheritance diagram for CGUILoadAnimationsCmd:

[legend]

Public Member Functions
	CGUILoadAnimationsCmd ()
	Constructor for factory. Do not use this constructor in user code.

	CGUILoadAnimationsCmd (const eC_String &rkFileName, bool bDeleteExistingAnimations=true)
	Constructs a LoadAnimationsCmd. More...

virtual void	ReadFromStream ()

virtual void	WriteToStream (const eC_Bool bWriteClassID=false)

Public Member Functions inherited from CGUICommand
void	AddAdditionalCmd (CGUICommandPtr pkCmd, eC_Bool bOneTime=false)

CGUICommandPtr	GetAdditionalCmd (const eC_UInt &uiIndex) const

eC_UInt	GetNumberOfAdditionalCmds () const

eC_UInt	GetPriority () const

eC_UInt	GetTimeUntilNextExecution () const

eC_Bool	IsFinished () const

virtual void	ReadFromStream ()

void	RemoveAdditionalCmd (CGUICommandPtr pkCmd)

void	RemoveAllAdditionalCmds ()
	Removes all additional commands from this command's list.

void	SetPriority (eC_UInt uiPriority)

void	SetTimeUntilNextExecution (eC_UInt uiTime)

virtual void	WriteToStream (const eC_Bool bWriteClassID=false)

Public Member Functions inherited from CGUIStreamableObject
const eC_String &	GetXMLTag () const

virtual void	ReadFromStream ()

void	SetXMLTag (const eC_String &kXMLTag)

virtual void	WriteToStream (const eC_Bool bWriteClassID=false)

Public Member Functions inherited from NSmartPtr::RefCounted
	RefCounted ()
	Create RefCounted object. The reference count is initialized to 0.

virtual	~RefCounted ()
	Destroy reference counted object.

void	AddRef ()
	Increase reference count.

eC_Int	RefCount () const

void	Release ()

bool	Unique () const

Static Public Attributes
static const eC_Char	XMLTAG_DESTANIMATIONSFILENAME []

Static Public Attributes inherited from CGUICommand
static const eC_Char	XMLTAG_ADDITIONALCMDCOUNT []
	XML tag to be used when writing the additional command count into a stream.

static const eC_Char	XMLTAG_COMMANDCLASSID []
	XML tag to be used when writing the command class ID into a stream.

static const eC_Char	XMLTAG_REMOVE_AFTER_EXECUTION []
	XML tag to be used when writing the remove after execution flag.

Static Public Attributes inherited from CGUIStreamableObject
static const eC_Char	XMLTAG_CLASSVERSION []

Protected Member Functions
virtual void	Do ()

Protected Member Functions inherited from CGUICommand
	CGUICommand (const eC_UInt uiPriority=0, const eC_UInt uiTimeUntilFirstExecution=0, const eC_Bool bFinished=true)

virtual	~CGUICommand ()
	Destructor.

virtual void	Do ()=0

void	SetToBeFinished (eC_Bool bIsFinished)

Protected Member Functions inherited from CGUIStreamableObject
eC_UInt	ReadStreamingHeader (const eC_UInt &uiClassVersion, const eC_UInt &uiClassMinVersion=0) const

void	WriteStreamingFooter (const eC_Bool &bWriteClassID) const

void	WriteStreamingHeader (const eC_Bool &bWriteClassID, const eC_Char *const pkClassIDTag, const eC_Int &iClassID, const eC_UInt &uiClassVersion) const

Protected Attributes
bool	m_bDeleteExistingAnimations
	Used to decide if all animations and animation chains should be deleted before loading.

eC_String	m_kFileName
	File name (full path if needed) of the animations to be loaded.

Detailed Description

Loads animations and animation chains from a file and deletes all existing ones.

This command loads animations and animation chains including their CGUIEasing functions from a file. The loaded objects are all managed by the animation handler. Please respect, that the GUIObjects referenced by the loaded animations have to be existent. If the connection between the animation and the GUIObject is not possible, the animation cannot work. All existing animations and animation chains can be deleted before loading the new ones if specified.

If the given file name is an empty string, this command does not try to load animations but deletes all already existing if specified anyways.

Constructor & Destructor Documentation

◆ CGUILoadAnimationsCmd()

CGUILoadAnimationsCmd::CGUILoadAnimationsCmd	(	const eC_String &	rkFileName,
		bool	bDeleteExistingAnimations = `true`
	)

Constructs a LoadAnimationsCmd.

Parameters

rkFileName	File name (complete path) of the file containing the animations.
bDeleteExistingAnimations	True if all existing animations and animation chains should be deleted.

Member Function Documentation

◆ Do()

virtual void CGUILoadAnimationsCmd::Do ( )

protectedvirtual

Action of the command object. Must be implemented in the derived class.

Implements CGUICommand.

◆ ReadFromStream()

virtual void CGUILoadAnimationsCmd::ReadFromStream ( )

virtual

Reads attributes from the streaming file. Only for use with GUIFactoryManager.

See also: CGUIObject::ReadFromStream()

Reimplemented from CGUICommand.

◆ WriteToStream()

virtual void CGUILoadAnimationsCmd::WriteToStream ( const eC_Bool bWriteClassID = false )

virtual

Writes attributes to the streaming file. A CGUIStreamWriter has to be initialized.

Parameters

bWriteClassID This flag is used to switch writing of the class ID, leading and trailing tags. When implementing a new streamable object, check this flag. If it is true, first write the class ID, then continue with this object's attributes, and finally call the base class implementation with this flag set to false (this is the default).

Reimplemented from CGUICommand.

Member Data Documentation

◆ XMLTAG_DESTANIMATIONSFILENAME

const eC_Char CGUILoadAnimationsCmd::XMLTAG_DESTANIMATIONSFILENAME[]

static

XML tag used to indicate a target dialog filename to load.

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

GUILoadAnimationsCmd.h

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes