Emma::RenderableGroup Class Reference

RenderableGroup implements IRenderableGroup. More...

#include <EmmaRenderableGroup.h>

Inheritance diagram for Emma::RenderableGroup:

List of all members.


Public Types
enum	{ NOTRACKING_MASK = 1<<0, TRACKING_MASK = 1<<1 }
Public Member Functions
	RenderableGroup (Fusion::IObject , RenderManager r=NULL)
virtual	~RenderableGroup ()
virtual Fusion::ResultType	initialize ()
virtual Fusion::ResultType	finalize ()
virtual IRenderableGroup *	createRenderableGroup (IInstance , Fusion::IObject )
	Create another RenderableGroup as the child of this RenderableGroup This creates a RenderableGroup object for each Emma object that can contain other Renderable objects.
virtual Fusion::ResultType	attach (IRenderable , Fusion::IObject parent)
	Attach an Emma or Ogre Renderable to this group.
virtual Fusion::ResultType	detach (IRenderable *r)
	Detach an Emma or Ogre Renderable from this group.
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 RenderableGroup object.
virtual Fusion::ResultType	reparentRenderableGroup (IRenderableGroup , Fusion::IObject parent)
	Make this renderable group to be the child of the passed-in renderable group.
virtual Fusion::ResultType	removeRenderableGroup (IRenderableGroup *)
	Remove this RG from the children list of the passed-in parent renderable group.
virtual bool	localToWorld (const Fusion::Vec3f &localPos, Fusion::Vec3f &worldPos)
	This returns the passed local coordinate point in screen coordinates.
virtual bool	worldToLocal (const Fusion::Vec3f &worldPos, Fusion::Vec3f &localPos)
	This returns the passed screen coordinate point in local coordinates.
virtual bool	addChildRenderableGroup (IRenderableGroup *)
	Add the given RG as child of this RG.
virtual IRenderableGroup *	getParent ()
	Get this RenderableGroup's Parent.
virtual void	setParent (IRenderableGroup *p)
	Set this RenderableGroup's Parent.
virtual Fusion::IObject *	getObject ()
	Get this Group's associated "Object".
virtual bool	isRoot ()
	Is this a "root" group?
virtual void	setIsRoot (bool flag)
	Set this as a "root" group.
virtual Fusion::ResultType	processAssets (Ogre::SceneNode *parent)
virtual Ogre::SceneNode *	getSceneNode ()
Protected Attributes
Fusion::IObject *	myObject
Ogre::SceneNode *	mySceneNode
bool	mybPickable
IRenderableGroup *	myParent
bool	myIsRoot

Detailed Description

RenderableGroup implements IRenderableGroup.

Member Enumeration Documentation

anonymous enum

Enumerator:

NOTRACKING_MASK

TRACKING_MASK

Constructor & Destructor Documentation

Emma::RenderableGroup::RenderableGroup ( Fusion::IObject * ,

RenderManager * r = NULL

)

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

Member Function Documentation

virtual bool Emma::RenderableGroup::addChildRenderableGroup ( IRenderableGroup * ) [virtual]

Add the given RG as child of this RG.

Implements Emma::IRenderableGroup.

virtual Fusion::ResultType Emma::RenderableGroup::attach ( IRenderable * ,

Fusion::IObject * parent

) [virtual]

Attach an Emma or Ogre Renderable to this group.

Implements Emma::IRenderableGroup.

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

const Fusion::Value & value

) [virtual]

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

Implements Emma::IRenderableGroup.

virtual IRenderableGroup* Emma::RenderableGroup::createRenderableGroup ( IInstance * ,

Fusion::IObject *

) [virtual]

Create another RenderableGroup as the child of this RenderableGroup This creates a RenderableGroup object for each Emma object that can contain other Renderable objects.
For example, an Emma Shape object corresponds to a RenderableGroup and an Emma MeshInline corresponds to a Renderable.
Implements Emma::IRenderableGroup.

virtual Fusion::ResultType Emma::RenderableGroup::detach ( IRenderable * r ) [virtual]

Detach an Emma or Ogre Renderable from this group.

Implements Emma::IRenderableGroup.

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

Implements Emma::IRenderableGroup.

virtual Fusion::IObject* Emma::RenderableGroup::getObject ( ) [inline, virtual]

Get this Group's associated "Object".

Implements Emma::IRenderableGroup.

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

Get this RenderableGroup's Parent.
NOTE this is NOT the same as EmmaNode::getParent()! The Rendering tree has SINGLE parentage, so there can be only one parent.
Implements Emma::IRenderableGroup.

virtual Ogre::SceneNode* Emma::RenderableGroup::getSceneNode ( ) [inline, virtual]

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

Implements Emma::IRenderableGroup.

virtual bool Emma::RenderableGroup::isRoot ( ) [inline, virtual]

Is this a "root" group?

Implements Emma::IRenderableGroup.

virtual bool Emma::RenderableGroup::localToWorld ( const Fusion::Vec3f & localPos,

Fusion::Vec3f & worldPos

) [virtual]

This returns the passed local coordinate point in screen coordinates.

Implements Emma::IRenderableGroup.

virtual Fusion::ResultType Emma::RenderableGroup::processAssets ( Ogre::SceneNode * parent ) [virtual]

virtual Fusion::ResultType Emma::RenderableGroup::removeRenderableGroup ( IRenderableGroup * ) [virtual]

Remove this RG from the children list of the passed-in parent renderable group.

Implements Emma::IRenderableGroup.

virtual Fusion::ResultType Emma::RenderableGroup::reparentRenderableGroup ( IRenderableGroup * ,

Fusion::IObject * parent

) [virtual]

Make this renderable group to be the child of the passed-in renderable group.

Implements Emma::IRenderableGroup.

virtual void Emma::RenderableGroup::setIsRoot ( bool flag ) [inline, virtual]

Set this as a "root" group.

Implements Emma::IRenderableGroup.

virtual void Emma::RenderableGroup::setParent ( IRenderableGroup * p ) [inline, virtual]

Set this RenderableGroup's Parent.

Implements Emma::IRenderableGroup.

virtual bool Emma::RenderableGroup::worldToLocal ( const Fusion::Vec3f & worldPos,

Fusion::Vec3f & localPos

) [virtual]

This returns the passed screen coordinate point in local coordinates.

Implements Emma::IRenderableGroup.