Emma::IRenderableGroup Class Reference

RenderableGroup corresponds to an Ogre SceneNode. More...

#include <EmmaIRenderableGroup.h>

Inheritance diagram for Emma::IRenderableGroup:

List of all members.

Public Member Functions
virtual Fusion::ResultType	initialize ()=0
virtual Fusion::ResultType	finalize ()=0
virtual IRenderableGroup *	createRenderableGroup (IInstance *, Fusion::IObject *)=0
	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)=0
	Attach an Emma or Ogre Renderable to this group.
virtual Fusion::ResultType	detach (IRenderable *)=0
	Detach an Emma or Ogre Renderable from this group.
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 RenderableGroup object.
virtual Fusion::ResultType	reparentRenderableGroup (IRenderableGroup *, Fusion::IObject *)=0
	Make this renderable group to be the child of the passed-in renderable group.
virtual Fusion::ResultType	removeRenderableGroup (IRenderableGroup *)=0
	Remove this RG from the children list of the passed-in parent renderable group.
virtual bool	localToWorld (const Fusion::Vec3f &localPos, Fusion::Vec3f &worldPos)=0
	This returns the passed local coordinate point in screen coordinates.
virtual bool	worldToLocal (const Fusion::Vec3f &worldPos, Fusion::Vec3f &localPos)=0
	This returns the passed screen coordinate point in local coordinates.
virtual bool	addChildRenderableGroup (IRenderableGroup *)=0
	Add the given RG as child of this RG.
virtual IRenderableGroup *	getParent ()=0
	Get this RenderableGroup's Parent.
virtual void	setParent (IRenderableGroup *)=0
	Set this RenderableGroup's Parent.
virtual Fusion::IObject *	getObject ()=0
	Get this Group's associated "Object".
virtual bool	isRoot ()=0
	Is this a "root" group?
virtual void	setIsRoot (bool flag)=0
	Set this as a "root" group.

---

Detailed Description

RenderableGroup corresponds to an Ogre SceneNode.

---

Member Function Documentation

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

Add the given RG as child of this RG. Implemented in Emma::RenderableGroup.

virtual Fusion::ResultType Emma::IRenderableGroup::attach (  IRenderable *  , Fusion::IObject *  parent )  [pure virtual]

Attach an Emma or Ogre Renderable to this group. Implemented in Emma::RenderableGroup.

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

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

virtual IRenderableGroup* Emma::IRenderableGroup::createRenderableGroup (  IInstance *  , Fusion::IObject *  )  [pure 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. Implemented in Emma::RenderableGroup.

virtual Fusion::ResultType Emma::IRenderableGroup::detach (  IRenderable *   )  [pure virtual]

Detach an Emma or Ogre Renderable from this group. Implemented in Emma::RenderableGroup.

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

Implemented in Emma::RenderableGroup.

virtual Fusion::IObject* Emma::IRenderableGroup::getObject (   )  [pure virtual]

Get this Group's associated "Object". Implemented in Emma::RenderableGroup.

virtual IRenderableGroup* Emma::IRenderableGroup::getParent (   )  [pure 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. Implemented in Emma::RenderableGroup.

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

Implemented in Emma::RenderableGroup.

virtual bool Emma::IRenderableGroup::isRoot (   )  [pure virtual]

Is this a "root" group? Implemented in Emma::RenderableGroup.

virtual bool Emma::IRenderableGroup::localToWorld (  const Fusion::Vec3f &  localPos, Fusion::Vec3f &  worldPos )  [pure virtual]

This returns the passed local coordinate point in screen coordinates. Implemented in Emma::RenderableGroup.

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

Remove this RG from the children list of the passed-in parent renderable group. Implemented in Emma::RenderableGroup.

virtual Fusion::ResultType Emma::IRenderableGroup::reparentRenderableGroup (  IRenderableGroup *  , Fusion::IObject *  )  [pure virtual]

Make this renderable group to be the child of the passed-in renderable group. Implemented in Emma::RenderableGroup.

virtual void Emma::IRenderableGroup::setIsRoot (  bool  flag  )  [pure virtual]

Set this as a "root" group. Implemented in Emma::RenderableGroup.

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

Set this RenderableGroup's Parent. Implemented in Emma::RenderableGroup.

virtual bool Emma::IRenderableGroup::worldToLocal (  const Fusion::Vec3f &  worldPos, Fusion::Vec3f &  localPos )  [pure virtual]

This returns the passed screen coordinate point in local coordinates. Implemented in Emma::RenderableGroup.

---

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

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

---