Emma::Renderable Class Reference

RenderObject implements IRenderObject. More...

#include <EmmaRenderable.h>

Inheritance diagram for Emma::Renderable:

List of all members.


Public Member Functions
	Renderable (Fusion::IObject , RenderableType, IRenderable )
virtual	~Renderable ()
virtual Fusion::ResultType	initialize ()
virtual Fusion::ResultType	finalize ()
virtual Fusion::ResultType	beginFieldFiring (const char *property, const Fusion::Value &value)
	When an Emma object changes, this method should be called on the corresponding Emma Renderable object.
virtual Fusion::ResultType	endFieldFiring (const char *property, const Fusion::Value &value)
	When an Emma object changes, this method should be called on the corresponding Emma Renderable object.
virtual Fusion::ResultType	processAssets (RenderManager *)
	called after creation to create the internal ogre structure for this renderable
virtual void *	getMovableObject ()
	get the ogre object pointer of this object
virtual void	setMovableObject (void *m)
	set the ogre object pointer of this object
virtual Fusion::UTF8String	getMaterialName ()
	material renderables return their name
virtual void	setMaterialName (const Fusion::UTF8String &)
	set the material name for an ogre mesh
virtual void	setToResourceGroupMaterialName ()
	set the active resource group to the resource group name of this renderable
virtual void	setParent (IRenderableGroup *g)
	set the parent to which this renderable is attached.
virtual IRenderableGroup *	getParent ()
	Return the IRenderableGroup to which this renderable is attached.
virtual Fusion::UTF8String	getOverallMaterialName ()
	mesh material names can be overridden using this
virtual void	cleanup ()
	this is called to release the resources created by this Renderable
virtual uint8_t *	lockBuffer ()
	gets the pointer to the material texture buffer to draw into
virtual void	unlockBuffer ()
	unlocks the material texture buffer
Fusion::ResultType	setUserObject ()
virtual long	getTypeID (void) const
virtual const Ogre::String &	getTypeName (void) const
Fusion::IObject *	getIObject ()
Emma::Node *	getNode ()
RenderableType	getType ()
Protected Member Functions
Fusion::ResultType	_loadAssetURLs (Fusion::Value &val)
Fusion::ResultType	_setCustomParameters (Fusion::Value &val)
Fusion::ResultType	_setPathAndExtractFilename (Fusion::UTF8String &url)
Protected Attributes
Fusion::IObject *	myObject
Emma::Node *	myNode
Ogre::MovableObject *	myMovableObject
RenderableType	myType
IRenderable *	myParentRenderable
Ogre::String	myOgreTypeName
IRenderableGroup *	myParent

Detailed Description

RenderObject implements IRenderObject.

Constructor & Destructor Documentation

Emma::Renderable::Renderable ( Fusion::IObject * ,

RenderableType ,

IRenderable *

)

virtual Emma::Renderable::~Renderable ( ) [virtual]

Member Function Documentation

Fusion::ResultType Emma::Renderable::_loadAssetURLs ( Fusion::Value & val ) [protected]

Fusion::ResultType Emma::Renderable::_setCustomParameters ( Fusion::Value & val ) [protected]

Fusion::ResultType Emma::Renderable::_setPathAndExtractFilename ( Fusion::UTF8String & url ) [protected]

virtual Fusion::ResultType Emma::Renderable::beginFieldFiring ( const char * property,

const Fusion::Value & value

) [inline, virtual]

When an Emma object changes, this method should be called on the corresponding Emma Renderable object.

Implements Emma::IRenderable.
Reimplemented in Emma::RenderableMaterial, Emma::RenderableMaterialBuffer, Emma::RenderableMesh, Emma::RenderableOgre, Emma::RenderableOgreCamera, Emma::RenderableOgreLight, Emma::RenderableOgreMaterialInline, Emma::RenderableOgreMeshAnimation, Emma::RenderableOgreMeshInline, and Emma::RenderableOgreParticleInline.

virtual void Emma::Renderable::cleanup ( ) [inline, virtual]

this is called to release the resources created by this Renderable

Implements Emma::IRenderable.
Reimplemented in Emma::RenderableMaterial, and Emma::RenderableMaterialBuffer.

virtual Fusion::ResultType Emma::Renderable::endFieldFiring ( const char * property,

const Fusion::Value & value

) [inline, virtual]

When an Emma object changes, this method should be called on the corresponding Emma Renderable object.

Implements Emma::IRenderable.
Reimplemented in Emma::RenderableOgreBackground.

virtual Fusion::ResultType Emma::Renderable::finalize ( ) [virtual]

Implements Emma::IRenderable.
Reimplemented in Emma::RenderableMaterial, Emma::RenderableMaterialBuffer, Emma::RenderableMesh, and Emma::RenderableOgreMaterialInline.

Fusion::IObject* Emma::Renderable::getIObject ( ) [inline]

virtual Fusion::UTF8String Emma::Renderable::getMaterialName ( ) [inline, virtual]

material renderables return their name

Implements Emma::IRenderable.
Reimplemented in Emma::RenderableMaterial, Emma::RenderableMaterialBuffer, and Emma::RenderableOgreMaterialInline.

virtual void* Emma::Renderable::getMovableObject ( ) [inline, virtual]

get the ogre object pointer of this object

Implements Emma::IRenderable.
Reimplemented in Emma::RenderableMaterial, Emma::RenderableMaterialBuffer, Emma::RenderableMesh, and Emma::RenderableOgreMaterialInline.

Emma::Node* Emma::Renderable::getNode ( ) [inline]

virtual Fusion::UTF8String Emma::Renderable::getOverallMaterialName ( ) [inline, virtual]

mesh material names can be overridden using this

Implements Emma::IRenderable.
Reimplemented in Emma::RenderableMesh, and Emma::RenderableOgreMeshInline.

virtual IRenderableGroup* Emma::Renderable::getParent ( ) [inline, virtual]

Return the IRenderableGroup to which this renderable is attached.

Implements Emma::IRenderable.

RenderableType Emma::Renderable::getType ( ) [inline]

virtual long Emma::Renderable::getTypeID ( void ) const [inline, virtual]

virtual const Ogre::String& Emma::Renderable::getTypeName ( void ) const [inline, virtual]

virtual Fusion::ResultType Emma::Renderable::initialize ( ) [virtual]

Implements Emma::IRenderable.
Reimplemented in Emma::RenderableMaterial, Emma::RenderableMaterialBuffer, Emma::RenderableMesh, and Emma::RenderableOgreMaterialInline.

virtual uint8_t* Emma::Renderable::lockBuffer ( ) [inline, virtual]

gets the pointer to the material texture buffer to draw into

Implements Emma::IRenderable.
Reimplemented in Emma::RenderableMaterialBuffer.

virtual Fusion::ResultType Emma::Renderable::processAssets ( RenderManager * ) [inline, virtual]

called after creation to create the internal ogre structure for this renderable

Implements Emma::IRenderable.
Reimplemented in Emma::RenderableMaterial, Emma::RenderableMaterialBuffer, Emma::RenderableMesh, Emma::RenderableOgre, Emma::RenderableOgreBackground, Emma::RenderableOgreCamera, Emma::RenderableOgreLight, Emma::RenderableOgreMaterialInline, Emma::RenderableOgreMeshAnimation, Emma::RenderableOgreMeshInline, and Emma::RenderableOgreParticleInline.

virtual void Emma::Renderable::setMaterialName ( const Fusion::UTF8String & ) [inline, virtual]

set the material name for an ogre mesh

Implements Emma::IRenderable.
Reimplemented in Emma::RenderableMesh, Emma::RenderableOgre, and Emma::RenderableOgreMeshInline.

virtual void Emma::Renderable::setMovableObject ( void * m ) [inline, virtual]

set the ogre object pointer of this object

Implements Emma::IRenderable.
Reimplemented in Emma::RenderableOgreCamera.

virtual void Emma::Renderable::setParent ( IRenderableGroup * g ) [inline, virtual]

set the parent to which this renderable is attached.

Implements Emma::IRenderable.

virtual void Emma::Renderable::setToResourceGroupMaterialName ( ) [inline, virtual]

set the active resource group to the resource group name of this renderable

Implements Emma::IRenderable.
Reimplemented in Emma::RenderableMesh.

Fusion::ResultType Emma::Renderable::setUserObject ( )

virtual void Emma::Renderable::unlockBuffer ( ) [inline, virtual]

unlocks the material texture buffer

Implements Emma::IRenderable.
Reimplemented in Emma::RenderableMaterialBuffer.