Transits from a source dialog to a destination dialog. More...

#include <GUITransitionCmd.h>

Inheritance diagram for CGUITransitionCmd:

[legend]

Public Types
enum	TransitionType_t { BLEND_ONLY , BLEND_FADE , BLEND_AND_SHRINK , BLEND_AND_ZOOM , PUSH_FROM_LEFT , PUSH_FROM_RIGHT , PUSH_FROM_TOP , PUSH_FROM_BOTTOM , ROTATE_X_AXIS_CW , ROTATE_X_AXIS_CCW , ROTATE_Y_AXIS_CW , ROTATE_Y_AXIS_CCW , DISSOLVE , BLEND_ONLY_SIMPLE , BLEND_FADE_SIMPLE , ENTER_FROM_LEFT , ENTER_FROM_RIGHT , ENTER_FROM_TOP , ENTER_FROM_BOTTOM , LEAVE_TO_LEFT , LEAVE_TO_RIGHT , LEAVE_TO_TOP , LEAVE_TO_BOTTOM }
	Transition types.

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

	CGUITransitionCmd (CGUITransitionBase *pkTransition, const ObjectHandle_t &eSource, const eC_String &rkDestFileName)

	CGUITransitionCmd (const TransitionType_t &eTransType, const ObjectHandle_t &eSource, const eC_String &rkDestFileName)

	CGUITransitionCmd (const TransitionType_t &eTransType, const ObjectHandle_t &eSource, const eC_String &rkDestFileName, const eC_UInt &uiTransitionTime)

	CGUITransitionCmd (const TransitionType_t &eTransType, const ObjectHandle_t &eSource, const ObjectHandle_t &eDest)

	CGUITransitionCmd (const TransitionType_t &eTransType, const ObjectHandle_t &eSource, const ObjectHandle_t &eDest, const eC_UInt &uiTransitionTime)

const eC_String &	GetDestinationFileName () const

ObjectHandle_t	GetDestinationObjectID () const

CGUIEasing::EasingType_t	GetEasing () const

ObjectHandle_t	GetSourceObjectID () const

eC_UInt	GetTransitionTime () const

CGUITransitionCmd::TransitionType_t	GetTransitionType () const

virtual void	ReadFromStream ()

void	SetDestinationFileName (const eC_String &kDestFileName)

void	SetDestinationObjectID (const ObjectHandle_t &eDest)

void	SetEasing (const CGUIEasing::EasingType_t &eEasingType)

void	SetSourceObjectID (const ObjectHandle_t &eSource)

void	SetTransitionTime (const eC_UInt &uiTransitionTime)

void	SetTransitionType (const TransitionType_t &eTransitionType)

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_DESTDIALOGFILENAME []

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
void	Do ()

void	Init ()
	Helper for initialization.

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
ObjectHandle_t	m_eDest
	ID of object to be deleted.

CGUIEasing::EasingType_t	m_eEasingType
	Easing Type to be used for dialog change.

ObjectHandle_t	m_eSource
	ID of object to be deleted.

TransitionType_t	m_eTransitionType
	Transition Type to be used for dialog change.

eC_String	m_kDestFileName
	File name of the dialog to be loaded.

CGUITransitionBase *	m_pkTransition
	Transition to be used for dialog change.

eC_UInt	m_uiTransitionTime
	Total duration of transition in ms.

Detailed Description

Transits from a source dialog to a destination dialog.

This command loads a GUI definition which results in a new CGUIObject. The new object will be added to the parent of the source object. A transition is computed from source CGUIObject to the new one. The source object will be deleted when the transition has finished.

If something goes wrong while streaming (loading the GUI definition), this command does not delete any GUI objects.

Constructor & Destructor Documentation

◆ CGUITransitionCmd() [1/5]

CGUITransitionCmd::CGUITransitionCmd	(	CGUITransitionBase *	pkTransition,
		const ObjectHandle_t &	eSource,
		const eC_String &	rkDestFileName
	)

Constructs a TransitionCmd.

Parameters

pkTransition	Transition to be used for dialog change
eSource	ID of an object to transit from. To be deleted when this transition is finished.
rkDestFileName	File name of the dialog to be loaded.

◆ CGUITransitionCmd() [2/5]

CGUITransitionCmd::CGUITransitionCmd	(	const TransitionType_t &	eTransType,
		const ObjectHandle_t &	eSource,
		const eC_String &	rkDestFileName
	)

Constructs a TransitionCmd.

Parameters

eTransType	Transition type to be used for dialog change
eSource	ID of an object to transit from. To be deleted when this transition is finished.
rkDestFileName	File name of the dialog to be loaded.

◆ CGUITransitionCmd() [3/5]

CGUITransitionCmd::CGUITransitionCmd	(	const TransitionType_t &	eTransType,
		const ObjectHandle_t &	eSource,
		const eC_String &	rkDestFileName,
		const eC_UInt &	uiTransitionTime
	)

Constructs a TransitionCmd.

Parameters

eTransType	Transition type to be used for dialog change
eSource	ID of an object to transit from. To be deleted when this transition is finished.
rkDestFileName	File name of the dialog to be loaded.
uiTransitionTime	The transition time

◆ CGUITransitionCmd() [4/5]

CGUITransitionCmd::CGUITransitionCmd	(	const TransitionType_t &	eTransType,
		const ObjectHandle_t &	eSource,
		const ObjectHandle_t &	eDest
	)

Constructs a TransitionCmd.

Parameters

eTransType	Transition type to be used for dialog change
eSource	ID of an object to transit from. To be deleted when this transition is finished.
eDest	Dialog to be transitioned to.

◆ CGUITransitionCmd() [5/5]

CGUITransitionCmd::CGUITransitionCmd	(	const TransitionType_t &	eTransType,
		const ObjectHandle_t &	eSource,
		const ObjectHandle_t &	eDest,
		const eC_UInt &	uiTransitionTime
	)

Constructs a TransitionCmd.

Parameters

eTransType	Transition type to be used for dialog change
eSource	ID of an object to transit from. To be deleted when this transition is finished.
eDest	Dialog to be transitioned to.
uiTransitionTime	The transition time

Member Function Documentation

◆ Do()

void CGUITransitionCmd::Do ( )

protectedvirtual

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

Implements CGUICommand.

◆ GetDestinationFileName()

const eC_String & CGUITransitionCmd::GetDestinationFileName ( ) const

Gets tthe destination filename.

Returns: type of transition.

◆ GetDestinationObjectID()

ObjectHandle_t CGUITransitionCmd::GetDestinationObjectID ( ) const

Gets the ObjectID of the transition destination.

Returns: ObjectID of transition destination.

◆ GetEasing()

CGUIEasing::EasingType_t CGUITransitionCmd::GetEasing ( ) const

Gets the easing-type for the transition

Returns: easing-type

◆ GetSourceObjectID()

ObjectHandle_t CGUITransitionCmd::GetSourceObjectID ( ) const

Gets the ObjectID of the transition source.

Returns: ObjectID of transition source.

◆ GetTransitionTime()

eC_UInt CGUITransitionCmd::GetTransitionTime ( ) const

Gets the time a transition takes.

Returns: the transition time.

◆ GetTransitionType()

CGUITransitionCmd::TransitionType_t CGUITransitionCmd::GetTransitionType ( ) const

Gets the transition type of the transition.

Returns: type of transition.

◆ ReadFromStream()

virtual void CGUITransitionCmd::ReadFromStream ( )

virtual

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

See also: CGUIObject::ReadFromStream()

Reimplemented from CGUICommand.

◆ SetDestinationFileName()

void CGUITransitionCmd::SetDestinationFileName ( const eC_String & kDestFileName )

Sets the destination filename.

Parameters

kDestFileName The path to the file containing the destination dialog.

◆ SetDestinationObjectID()

void CGUITransitionCmd::SetDestinationObjectID ( const ObjectHandle_t & eDest )

Sets the ObjectID of the transition destination.

Parameters

eDest ObjectID of transition destination.

◆ SetEasing()

void CGUITransitionCmd::SetEasing ( const CGUIEasing::EasingType_t & eEasingType )

Sets the easing-type of the transition

Parameters

eEasingType

◆ SetSourceObjectID()

void CGUITransitionCmd::SetSourceObjectID ( const ObjectHandle_t & eSource )

Sets the ObjectID of the transition source.

Parameters

eSource ObjectID of transition source.

◆ SetTransitionTime()

void CGUITransitionCmd::SetTransitionTime ( const eC_UInt & uiTransitionTime )

Sets the Time a transition takes.

Parameters

uiTransitionTime Time transition will need to switch from source to destination.

◆ SetTransitionType()

void CGUITransitionCmd::SetTransitionType ( const TransitionType_t & eTransitionType )

Sets the transition type of the transition.

Parameters

eTransitionType type of transition.

◆ WriteToStream()

virtual void CGUITransitionCmd::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_DESTDIALOGFILENAME

const eC_Char CGUITransitionCmd::XMLTAG_DESTDIALOGFILENAME[]

static

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

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

GUITransitionCmd.h

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CGUITransitionCmd() [1/5]

◆ CGUITransitionCmd() [2/5]

◆ CGUITransitionCmd() [3/5]

◆ CGUITransitionCmd() [4/5]

◆ CGUITransitionCmd() [5/5]

Member Function Documentation

◆ Do()

◆ GetDestinationFileName()

◆ GetDestinationObjectID()

◆ GetEasing()

◆ GetSourceObjectID()

◆ GetTransitionTime()

◆ GetTransitionType()

◆ ReadFromStream()

◆ SetDestinationFileName()

◆ SetDestinationObjectID()

◆ SetEasing()

◆ SetSourceObjectID()

◆ SetTransitionTime()

◆ SetTransitionType()

◆ WriteToStream()

Member Data Documentation

◆ XMLTAG_DESTDIALOGFILENAME