Ogre::OgreVideoManager Class Reference

#include <OgreVideoManager.h>

Inheritance diagram for Ogre::OgreVideoManager:

Classes
struct	ClipTexture

Public Member Functions
	OgreVideoManager (int num_worker_threads=1)
	~OgreVideoManager ()
void	createDefinedTexture (const String &material_name, const String &group_name=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME)
TheoraVideoClip *	createVideoTexture (const String &video_file_name, const String &material_name, const String &video_group_name=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME, const String &group_name=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME)
void	destroyAdvancedTexture (const String &material_name, const String &group_name=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME)
void	destroyAllVideoTextures ()
	destroy all video textures More...
void	pauseAllVideoClips ()
	pause all video More...
void	unpauseAllVideoClips ()
	unpause all video More...
TheoraVideoClip *	getVideoClipByMaterialName (const String &material_name)
Public Member Functions inherited from Ogre::ExternalTextureSource
	ExternalTextureSource ()
virtual	~ExternalTextureSource ()
void	addBaseParams ()
const String &	getDictionaryStringName (void) const
int	getFPS () const
const String &	getInputName () const
eTexturePlayMode	getPlayMode () const
const String &	getPluginStringName (void) const
void	getTextureTecPassStateLevel (int &t, int &p, int &s) const
void	setFPS (int iFPS)
void	setInputName (const String &sIN)
void	setPlayMode (eTexturePlayMode eMode)
void	setTextureTecPassStateLevel (int t, int p, int s)
Public Member Functions inherited from Ogre::StringInterface
	StringInterface ()
virtual	~StringInterface ()
void	copyParametersTo (StringInterface *dest) const
ParamDictionary *	getParamDictionary (void)
const ParamDictionary *	getParamDictionary (void) const
String	getParameter (const String &name) const
const ParameterList &	getParameters (void) const
bool	setParameter (const String &name, const String &value)
void	setParameterList (const NameValuePairList &paramList)
Public Member Functions inherited from Ogre::FrameListener
virtual	~FrameListener ()
virtual bool	frameEnded (const FrameEvent &evt)
virtual bool	frameRenderingQueued (const FrameEvent &evt)

Private Member Functions
bool	frameStarted (const FrameEvent &evt)
bool	initialise ()
void	shutDown ()

Private Attributes
std::map< String, ClipTexture >	mClipsTextures
bool	mbInit
bool	mbPaused

Additional Inherited Members
Static Public Member Functions inherited from Ogre::StringInterface
static void	cleanupDictionary ()

Constructor & Destructor Documentation

OgreVideoManager()

Ogre::OgreVideoManager::OgreVideoManager

(

int

num_worker_threads = 1

)

~OgreVideoManager()

Ogre::OgreVideoManager::~OgreVideoManager

(

)

Member Function Documentation

createDefinedTexture()

void Ogre::OgreVideoManager::createDefinedTexture ( const String &  material_name, const String &  group_name = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME  )

virtual

Remarks

Creates video clip and a texture into an already defined material. All setting should have been set before calling this. Refer to base class ( ExternalTextureSource ) for details

Parameters

material_name	Material you are attaching a movie to.
group_name	Resource group where the texture is registered

Implements Ogre::ExternalTextureSource.

createVideoTexture()

TheoraVideoClip* Ogre::OgreVideoManager::createVideoTexture	(	const String &	video_file_name,
		const String &	material_name,
		const String &	video_group_name = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME,
		const String &	group_name = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME
	)

Remarks

Creates video clip and a texture into an already defined material.

Parameters

video_file_name	Video input file name.
material_name	Material you are attaching a movie to.
video_group_name	Resource group where the video file is registered
group_name	Resource group where the texture is registered

destroyAdvancedTexture()

void Ogre::OgreVideoManager::destroyAdvancedTexture ( const String &  material_name, const String &  group_name = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME  )

virtual

Remarks

Destroys a Video Texture based on material name. Mostly Ogre uses this, you should use destroyVideoClip()

Parameters

material_name	Material Name you are looking to remove a video clip from
group_name	Resource group where the texture is registered

Implements Ogre::ExternalTextureSource.

destroyAllVideoTextures()

void Ogre::OgreVideoManager::destroyAllVideoTextures

(

)

destroy all video textures

frameStarted()

bool Ogre::OgreVideoManager::frameStarted ( const FrameEvent &  evt )

privatevirtual

Reimplemented from Ogre::FrameListener.

getVideoClipByMaterialName()

TheoraVideoClip* Ogre::OgreVideoManager::getVideoClipByMaterialName

(

const String &

material_name

)

Remarks

Return video clip based on material name

Parameters

material_name

Material Name you are looking to remove a video clip from

initialise()

bool Ogre::OgreVideoManager::initialise ( )

privatevirtual

Implements Ogre::ExternalTextureSource.

pauseAllVideoClips()

void Ogre::OgreVideoManager::pauseAllVideoClips

(

)

pause all video

shutDown()

void Ogre::OgreVideoManager::shutDown ( )

privatevirtual

Implements Ogre::ExternalTextureSource.

unpauseAllVideoClips()

void Ogre::OgreVideoManager::unpauseAllVideoClips

(

)

unpause all video

Member Data Documentation

mbInit

bool Ogre::OgreVideoManager::mbInit

private

mbPaused

bool Ogre::OgreVideoManager::mbPaused

private

mClipsTextures

std::map<String,ClipTexture> Ogre::OgreVideoManager::mClipsTextures

private

---

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

• OgreVideoManager.h