CzUIVideoOverlay Class Reference

#include <CzUIVideoOverlay.h>

Inheritance diagram for CzUIVideoOverlay:

List of all members.

Public Member Functions
void	setAutoPlay (bool auto_play)
bool	isAutoPlay () const
void	setVideo (CzVideo *video)
CzVideo *	getVideo ()
bool	isPlaying () const
bool	isStarted () const
bool	setProperty (unsigned int property_name, const CzXomlProperty &data, bool delta)
	Sets the named property of the UIVideoOverlay.
bool	setProperty (unsigned int property_name, const CzString &data, bool delta)
	Sets the named property of the actor.
bool	getProperty (unsigned int property_name, CzXomlProperty &prop)
	Gets the named property of the actor.
	CzUIVideoOverlay ()
bool	Update (float dt)
	Updates this actors logic.
int	LoadFromXoml (IzXomlResource *parent, bool load_children, CzXmlNode *node)
	Creates an instance of this class from XML.
bool	UpdateFromAnimation (CzAnimInstance *animation)
	Updates actor property from supplied animation.
bool	Play ()
void	Stop ()
void	Pause ()
void	Resume ()
Static Public Member Functions
static void	InitClass ()
	Initialises the class.
static void	ReleaseClass ()
static bool	_setVideo (IzXomlResource *target, const CzXomlProperty &prop, bool add)
static CzXomlProperty	_getVideo (IzXomlResource *target)
static bool	_setAutoPlay (IzXomlResource *target, const CzXomlProperty &prop, bool add)
static CzXomlProperty	_getAutoPlay (IzXomlResource *target)
static bool	_setRepeat (IzXomlResource *target, const CzXomlProperty &prop, bool add)
static CzXomlProperty	_getRepeat (IzXomlResource *target)
static bool	_setVolume (IzXomlResource *target, const CzXomlProperty &prop, bool add)
static CzXomlProperty	_getVolume (IzXomlResource *target)
static bool	_setCommand (IzXomlResource *target, const CzXomlProperty &prop, bool add)
static CzXomlProperty	_getIsPlaying (IzXomlResource *target)
static CzXomlProperty	_getStarted (IzXomlResource *target)
static bool	_setOnStart (IzXomlResource *target, const CzXomlProperty &prop, bool add)
static bool	_setOnEnd (IzXomlResource *target, const CzXomlProperty &prop, bool add)
static bool	_setOnPause (IzXomlResource *target, const CzXomlProperty &prop, bool add)
static bool	_setOnResume (IzXomlResource *target, const CzXomlProperty &prop, bool add)
static bool	_setOnError (IzXomlResource *target, const CzXomlProperty &prop, bool add)
Protected Member Functions
bool	UpdateBinding (unsigned int property_name, CzXomlVariable *var)
	Updates an actor property from the supplied XOML variable.
Protected Attributes
bool	AutoPlay
CzVideo *	Video
bool	Playing
bool	Started
Static Protected Attributes
static CzXomlClassDef *	VideoOverlayClassDef = NULL

---

Constructor & Destructor Documentation

CzUIVideoOverlay::CzUIVideoOverlay

(

)

[inline]

---

Member Function Documentation

CzXomlProperty CzUIVideoOverlay::_getAutoPlay

(

IzXomlResource *

target

)

[static]

CzXomlProperty CzUIVideoOverlay::_getIsPlaying

(

IzXomlResource *

target

)

[static]

CzXomlProperty CzUIVideoOverlay::_getRepeat

(

IzXomlResource *

target

)

[static]

CzXomlProperty CzUIVideoOverlay::_getStarted

(

IzXomlResource *

target

)

[static]

CzXomlProperty CzUIVideoOverlay::_getVideo

(

IzXomlResource *

target

)

[static]

CzXomlProperty CzUIVideoOverlay::_getVolume

(

IzXomlResource *

target

)

[static]

bool CzUIVideoOverlay::_setAutoPlay	(	IzXomlResource *	target,
		const CzXomlProperty &	prop,
		bool	add
	)		[static]

bool CzUIVideoOverlay::_setCommand	(	IzXomlResource *	target,
		const CzXomlProperty &	prop,
		bool	add
	)		[static]

bool CzUIVideoOverlay::_setOnEnd	(	IzXomlResource *	target,
		const CzXomlProperty &	prop,
		bool	add
	)		[static]

bool CzUIVideoOverlay::_setOnError	(	IzXomlResource *	target,
		const CzXomlProperty &	prop,
		bool	add
	)		[static]

bool CzUIVideoOverlay::_setOnPause	(	IzXomlResource *	target,
		const CzXomlProperty &	prop,
		bool	add
	)		[static]

bool CzUIVideoOverlay::_setOnResume	(	IzXomlResource *	target,
		const CzXomlProperty &	prop,
		bool	add
	)		[static]

bool CzUIVideoOverlay::_setOnStart	(	IzXomlResource *	target,
		const CzXomlProperty &	prop,
		bool	add
	)		[static]

bool CzUIVideoOverlay::_setRepeat	(	IzXomlResource *	target,
		const CzXomlProperty &	prop,
		bool	add
	)		[static]

bool CzUIVideoOverlay::_setVideo	(	IzXomlResource *	target,
		const CzXomlProperty &	prop,
		bool	add
	)		[static]

bool CzUIVideoOverlay::_setVolume	(	IzXomlResource *	target,
		const CzXomlProperty &	prop,
		bool	add
	)		[static]

bool CzUIVideoOverlay::getProperty	(	unsigned int	property_name,
		CzXomlProperty &	prop
	)		[virtual]

Gets the named property of the actor.

Returns the named property of the actor. The properties value is returned in a CzXomlProperty which is a structure that contains a union of all possible property types. Note that as CzUIVideoOverlay is derived from CzUIBase, all CzUIBase properties will also be checked against.

Parameters:

	property_name	Name of the property.
[out]	prop	The property data that.

Returns:

true if it succeeds, false if property does not exist.

Reimplemented from CzUIBase.

CzVideo* CzUIVideoOverlay::getVideo

(

)

[inline]

void CzUIVideoOverlay::InitClass

(

)

[static]

Initialises the class.

Sets up the classes avaiiable properties. Used by the XOML system to find, set amd get class properties.

Reimplemented from CzUIBase.

bool CzUIVideoOverlay::isAutoPlay

(

)

const [inline]

bool CzUIVideoOverlay::isPlaying

(

)

const [inline]

bool CzUIVideoOverlay::isStarted

(

)

const [inline]

int CzUIVideoOverlay::LoadFromXoml	(	IzXomlResource *	parent,
		bool	load_children,
		CzXmlNode *	node
	)		[virtual]

Creates an instance of this class from XML.

LoadFromXoml is the main method used by all classes that can be instantiated from XOML mark-up. This method creates an instance of this class from the supplied XML node structure specified by node. if parent is not NULL then the created instance will utilise the supplied parent to determine where it should live within the app. For example, if the parent is a scene then the actor will be placed in that scene. if the parent is another actor then this actor will be placed into the scene of the supplied actor and linked as a child to the parent actor. If load_chlldren is true then any child nodes contained within the actor will also be loaded. Note that as CzUIBase is derived from CzActorImage, CzActorImage::LoadFromXoml() will also be called to load CzActor specific properties.

Parameters:

[in]	parent	If non-null, the parent.
	load_children	true to load child nodes.
[in]	node	If non-null, the XOML markup node that defines this object

Returns:

negative value for error. if 0 then processing of further XOML will stop.

Reimplemented from CzUIBase.

void CzUIVideoOverlay::Pause

(

)

bool CzUIVideoOverlay::Play

(

)

void CzUIVideoOverlay::ReleaseClass

(

)

[static]

Reimplemented from CzUIBase.

void CzUIVideoOverlay::Resume

(

)

void CzUIVideoOverlay::setAutoPlay

(

bool

auto_play

)

[inline]

bool CzUIVideoOverlay::setProperty	(	unsigned int	property_name,
		const CzXomlProperty &	data,
		bool	delta
	)		[virtual]

Sets the named property of the UIVideoOverlay.

Sets the named property of this UIVideoOverlay. The properties value supplied will be converted. If delta is set to true then the existing value of the property will be added to instead of replaced.

Parameters:

	property_name	Name of the property as a string hash (faster searching).
[in]	data	The property data.
	delta	true if property should be added to instead of replaced.

Returns:

true if it succeeds, false if property does not exist.

Reimplemented from CzUIBase.

bool CzUIVideoOverlay::setProperty	(	unsigned int	property_name,
		const CzString &	data,
		bool	delta
	)		[virtual]

Sets the named property of the actor.

Sets the named property of this actor. The properties value (data) is supplied as a string and will be converted. If delta is set to true then the existing value of the property will be added to instead of replaced. Note that as CzUIVideoOverlay is derived from CzUIBase, all CzUIBase properties will also be checked against.

Parameters:

	property_name	Name of the property as a string hash (faster searching).
[in]	data	The property data.
	delta	true to property should be added to instead of replaced.

Returns:

true if it succeeds, false if property does not exist.

Reimplemented from CzUIBase.

void CzUIVideoOverlay::setVideo

(

CzVideo *

video

)

[inline]

void CzUIVideoOverlay::Stop

(

)

bool CzUIVideoOverlay::Update

(

float

dt

)

[virtual]

Updates this actors logic.

Updates the UI actors logic, including:

• Processing event actions
• Processing any attached modifiers
• Updating dragging state
• Updating physics
• Updating the attached timeline
• Updating any show / hide timelines
• Updating the scroller
• Checking for an updating layout if dirty

This method should be overriden by derived actors to provide the UI actor specific logic.

Note that dt is used to scale actor internals that rely on time. This value enables the actor run in an environment where time (the frame rate of the device) can vary allowing animation to keep up without slowing down or speeding up when the frame rate varies.

Note that if an actor returns false then it will automatically be removed from the scene.

Parameters:

dt	The number of seconds since the app was last updated

Returns:

true if it succeeds, false if it fails.

Reimplemented from CzUIBase.

bool CzUIVideoOverlay::UpdateBinding	(	unsigned int	property_name,
		CzXomlVariable *	var
	)		[protected, virtual]

Updates an actor property from the supplied XOML variable.

Updates a single property from the value of the bound XOML variable. Note that as CzUIVideoOverlay is derived from CzUIBase, all CzUIBase properties will also be checked against.

Parameters:

	property_name	Name of the property.
[in,out]	var	If non-null, the variable.

Returns:

true if it succeeds, false if property does not exist.

Reimplemented from CzUIBase.

bool CzUIVideoOverlay::UpdateFromAnimation

(

CzAnimInstance *

animation

)

[virtual]

Updates actor property from supplied animation.

Updates the actors property that is specified by the supplied animation. When a timeline animation targets the property of an actor this method will be called by the animation to move the animations frame data into its target property. Note that as CzUIVideoOverlay is derived from CzUIBase, all CzUIBase properties will also be checked against.

Parameters:

[in]

animation

If non-null, the animation.

Returns:

true if it succeeds, false if property does not exist.

Reimplemented from CzUIBase.

---

Member Data Documentation

bool CzUIVideoOverlay::AutoPlay [protected]

bool CzUIVideoOverlay::Playing [protected]

bool CzUIVideoOverlay::Started [protected]

CzVideo* CzUIVideoOverlay::Video [protected]

CzXomlClassDef * CzUIVideoOverlay::VideoOverlayClassDef = NULL [static, protected]

---

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

• CzUIVideoOverlay.h
• CzUIVideoOverlay.cpp