GuiTheoraCtrl Class Reference

#include <guiTheoraCtrl.h>

Inheritance diagram for GuiTheoraCtrl:

Inheritance graph

[legend]List of all members.

Detailed Description

Play back a Theora video file.

Public Member Functions

DECLARE_CONOBJECT (GuiTheoraCtrl)

GuiTheoraCtrl ()

~GuiTheoraCtrl ()

void inspectPostApply ()

Called after any property of the object is changed in the world editor.

void setFile (const char *filename)

void stop ()

bool onWake ()

Called when this object is asked to wake up returns true if it's actually awake at the end.

void onSleep ()

Called when this object is asked to sleep.

void onRender (Point2I offset, const RectI &updateRect)

Called when this control is to render itself.

F32 getCurrentTime ()

Static Public Member Functions

static void initPersistFields ()

Register dynamic fields in a subclass of ConsoleObject.

Public Attributes

bool mStopOnSleep

If true, stop video playback when the control goes to sleep.

bool mDone

Are we done with playback?

ColorI mBackgroundColor

Our background color.

Protected Attributes

const char * mFilename

TheoraTexture mTheoraTexture

Private Types

typedef GuiControl Parent

Member Typedef Documentation

typedef GuiControl GuiTheoraCtrl::Parent [private]

Reimplemented from GuiControl.

Constructor & Destructor Documentation

GuiTheoraCtrl::GuiTheoraCtrl ( )

GuiTheoraCtrl::~GuiTheoraCtrl ( )

Member Function Documentation

GuiTheoraCtrl::DECLARE_CONOBJECT ( GuiTheoraCtrl )

static void GuiTheoraCtrl::initPersistFields ( ) [static]

Register dynamic fields in a subclass of ConsoleObject.

See also:: addField(), addFieldV(), addDeprecatedField(), addGroup(), endGroup()

Reimplemented from GuiControl.

void GuiTheoraCtrl::inspectPostApply ( ) [virtual]

Called after any property of the object is changed in the world editor.

See also:: inspectPreApply

Reimplemented from GuiControl.

void GuiTheoraCtrl::setFile ( const char * filename )

void GuiTheoraCtrl::stop ( )

bool GuiTheoraCtrl::onWake ( ) [virtual]

Called when this object is asked to wake up returns true if it's actually awake at the end.

Reimplemented from GuiControl.

void GuiTheoraCtrl::onSleep ( ) [virtual]

Called when this object is asked to sleep.

Reimplemented from GuiControl.

void GuiTheoraCtrl::onRender	(	Point2I	offset,
		const RectI &	updateRect
	)			`[virtual]`

Called when this control is to render itself.

Parameters:

	offset	The location this control is to begin rendering
	updateRect	The screen area this control has drawing access to

Reimplemented from GuiControl.

F32 GuiTheoraCtrl::getCurrentTime ( ) [inline]

Member Data Documentation

const char* GuiTheoraCtrl::mFilename [protected]

TheoraTexture GuiTheoraCtrl::mTheoraTexture [protected]

bool GuiTheoraCtrl::mStopOnSleep

If true, stop video playback when the control goes to sleep.

bool GuiTheoraCtrl::mDone

Are we done with playback?

ColorI GuiTheoraCtrl::mBackgroundColor

Our background color.