Emma::IRenderable Class Reference

#include <EmmaIRenderable.h>

Inheritance diagram for Emma::IRenderable:

List of all members.

Public Member Functions
virtual Fusion::ResultType	initialize ()=0
virtual Fusion::ResultType	finalize ()=0
virtual Fusion::ResultType	beginFieldFiring (const char *property, const Fusion::Value &value)=0
	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)=0
	When an Emma object changes, this method should be called on the corresponding Emma Renderable object.
virtual Fusion::ResultType	processAssets (RenderManager *)=0
	called after creation to create the internal ogre structure for this renderable
virtual void *	getMovableObject ()=0
	get the ogre object pointer of this object
virtual void	setMovableObject (void *)=0
	set the ogre object pointer of this object
virtual Fusion::UTF8String	getMaterialName ()=0
	material renderables return their name
virtual void	setMaterialName (const Fusion::UTF8String &)=0
	set the material name for an ogre mesh
virtual void	setToResourceGroupMaterialName ()=0
	set the active resource group to the resource group name of this renderable
virtual Fusion::UTF8String	getOverallMaterialName ()=0
	mesh material names can be overridden using this
virtual uint8_t *	lockBuffer ()=0
	gets the pointer to the material texture buffer to draw into
virtual void	unlockBuffer ()=0
	unlocks the material texture buffer
virtual void	cleanup ()=0
	this is called to release the resources created by this Renderable
virtual void	setParent (IRenderableGroup *g)=0
	set the parent to which this renderable is attached.
virtual IRenderableGroup *	getParent ()=0
	Return the IRenderableGroup to which this renderable is attached.

---

Member Function Documentation

virtual Fusion::ResultType Emma::IRenderable::beginFieldFiring (  const char *  property, const Fusion::Value &  value )  [pure virtual]

When an Emma object changes, this method should be called on the corresponding Emma Renderable object. Implemented in Emma::Renderable, Emma::RenderableMaterial, Emma::RenderableMaterialBuffer, Emma::RenderableMesh, Emma::RenderableOgre, Emma::RenderableOgreCamera, Emma::RenderableOgreLight, Emma::RenderableOgreMaterialInline, Emma::RenderableOgreMeshAnimation, Emma::RenderableOgreMeshInline, and Emma::RenderableOgreParticleInline.

virtual void Emma::IRenderable::cleanup (   )  [pure virtual]

this is called to release the resources created by this Renderable Implemented in Emma::Renderable, Emma::RenderableMaterial, and Emma::RenderableMaterialBuffer.

virtual Fusion::ResultType Emma::IRenderable::endFieldFiring (  const char *  property, const Fusion::Value &  value )  [pure virtual]

When an Emma object changes, this method should be called on the corresponding Emma Renderable object. Implemented in Emma::Renderable, and Emma::RenderableOgreBackground.

virtual Fusion::ResultType Emma::IRenderable::finalize (   )  [pure virtual]

Implemented in Emma::Renderable, Emma::RenderableMaterial, Emma::RenderableMaterialBuffer, Emma::RenderableMesh, and Emma::RenderableOgreMaterialInline.

virtual Fusion::UTF8String Emma::IRenderable::getMaterialName (   )  [pure virtual]

material renderables return their name Implemented in Emma::Renderable, Emma::RenderableMaterial, Emma::RenderableMaterialBuffer, and Emma::RenderableOgreMaterialInline.

virtual void* Emma::IRenderable::getMovableObject (   )  [pure virtual]

get the ogre object pointer of this object Implemented in Emma::Renderable, Emma::RenderableMaterial, Emma::RenderableMaterialBuffer, Emma::RenderableMesh, and Emma::RenderableOgreMaterialInline.

virtual Fusion::UTF8String Emma::IRenderable::getOverallMaterialName (   )  [pure virtual]

mesh material names can be overridden using this Implemented in Emma::Renderable, Emma::RenderableMesh, and Emma::RenderableOgreMeshInline.

virtual IRenderableGroup* Emma::IRenderable::getParent (   )  [pure virtual]

Return the IRenderableGroup to which this renderable is attached. Implemented in Emma::Renderable.

virtual Fusion::ResultType Emma::IRenderable::initialize (   )  [pure virtual]

Implemented in Emma::Renderable, Emma::RenderableMaterial, Emma::RenderableMaterialBuffer, Emma::RenderableMesh, and Emma::RenderableOgreMaterialInline.

virtual uint8_t* Emma::IRenderable::lockBuffer (   )  [pure virtual]

gets the pointer to the material texture buffer to draw into Implemented in Emma::Renderable, and Emma::RenderableMaterialBuffer.

virtual Fusion::ResultType Emma::IRenderable::processAssets (  RenderManager *   )  [pure virtual]

called after creation to create the internal ogre structure for this renderable Implemented in Emma::Renderable, 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::IRenderable::setMaterialName (  const Fusion::UTF8String &   )  [pure virtual]

set the material name for an ogre mesh Implemented in Emma::Renderable, Emma::RenderableMesh, Emma::RenderableOgre, and Emma::RenderableOgreMeshInline.

virtual void Emma::IRenderable::setMovableObject (  void *   )  [pure virtual]

set the ogre object pointer of this object Implemented in Emma::Renderable, and Emma::RenderableOgreCamera.

virtual void Emma::IRenderable::setParent (  IRenderableGroup *  g  )  [pure virtual]

set the parent to which this renderable is attached. Implemented in Emma::Renderable.

virtual void Emma::IRenderable::setToResourceGroupMaterialName (   )  [pure virtual]

set the active resource group to the resource group name of this renderable Implemented in Emma::Renderable, and Emma::RenderableMesh.

virtual void Emma::IRenderable::unlockBuffer (   )  [pure virtual]

unlocks the material texture buffer Implemented in Emma::Renderable, and Emma::RenderableMaterialBuffer.

---

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

• C:/svn/emma/mainline/emma/runtime/emma/EmmaIRenderable.h

---