OgreRenderable Class Reference

Class to wrap different Ogre Renderable types. More...

Inheritance diagram for OgreRenderable:

List of all members.

Public Member Functions
	OgreRenderable (SubEntity *sube, Entity *parentEntity)
	Constructor.
	OgreRenderable (Entity *parentEntity, int subEntityNum)
	Constructor.
	OgreRenderable (BillboardSet *billboardset)
	Constructor.
	~OgreRenderable (void)
	Destructor.
void	setVisible (bool visible)
	Sets the visibility of the wrapped renderable.
void	setRenderGroup (unsigned char groupID)
	Sets the rendergroup of the wrapped renderable.
bool	isVisible ()
	Retrieves if the renderable is hided or shown.
void	setMaterialName (String &name)
	Sets the material to be used by the renderable.
const MaterialPtr &	getMaterialPtr ()
	Retrieves a resource pointer to the material used by the renderable.
const String &	getMaterialName ()
	Retrieves the name of the material used by the renderable.
Material *	getMaterial ()
	Retrieves a pointer to the material used by the renderable.
AxisAlignedBox &	getBoundingBox ()
	Retrieves the axis-aligned bouding box of the renderable.
Sphere &	getBoundingSphere ()
	Retrieves the bouding sphere of the renderable.
String &	getName ()
	Retrieves the unique name assigned to the renderable.
void	updateBounds ()
	Updates bounding volumes.
void	notifyCamera (Camera *cam)
	Calls notifyCamera for the wrapped Renderable.
Renderable *	getRenderable ()
	Returns the wrapped Renderable.
Protected Attributes
String	name
	unique name assigned to the renderable
Entity *	parentEntity
	pointer to the parent Entity if the renderable is a Subentity
SubEntity *	subEntityRenderable
	pointer to the wrapped Subentity (if the renderable is a Subentity)
BillboardSet *	billboardSetRenderable
	pointer to the wrapped BillboardSet (if the renderable is a BillboardSet)
AxisAlignedBox	boundingBox
	axis-aligned bounding box of the wrapped renderable in world space
Sphere	boundingSphere
	bounding sphere of the wrapped renderable in world space
Ogre_RenderableType	renderableType
	type of the renderable (see Ogre_RenderableType)

---

Detailed Description

Class to wrap different Ogre Renderable types.

---

Constructor & Destructor Documentation

OgreRenderable::OgreRenderable (  SubEntity *  sube, Entity *  parentEntity )

Constructor. Creates an OgreRenderable from a SubEntity of an Entity. Parameters: sube  the subentity to wrap parentEntity  the parent of the wrapped subentity

OgreRenderable::OgreRenderable (  Entity *  parentEntity, int  subEntityNum )

Constructor. Creates an OgreRenderable from a SubEntity of an Entity. Parameters: parentEntity  the parent of the wrapped subentity subEntityNum  the number of the subentity to wrap

OgreRenderable::OgreRenderable (  BillboardSet *  billboardset  )

Constructor. Creates an OgreRenderable from a SubEntity of a BillboardSet. Parameters: billboardset  the BillboardSet to wrap

---

Member Function Documentation

AxisAlignedBox& OgreRenderable::getBoundingBox (   )  [inline]

Retrieves the axis-aligned bouding box of the renderable. Returns: reference to the bouding box

Sphere& OgreRenderable::getBoundingSphere (   )  [inline]

Retrieves the bouding sphere of the renderable. Returns: reference to the bouding sphere

Material* OgreRenderable::getMaterial (   )  [inline]

Retrieves a pointer to the material used by the renderable. Returns: reference to the Material pointer

const String& OgreRenderable::getMaterialName (   )  [inline]

Retrieves the name of the material used by the renderable. Returns: reference to the name of the material

const MaterialPtr & OgreRenderable::getMaterialPtr (   )

Retrieves a resource pointer to the material used by the renderable. Returns: reference to the resource pointer

String& OgreRenderable::getName (   )  [inline]

Retrieves the unique name assigned to the renderable. Returns: reference to name of the renderable

Renderable * OgreRenderable::getRenderable (   )

Returns the wrapped Renderable. Returns: pointer to the wrapped Renderable

void OgreRenderable::notifyCamera (  Camera *  cam  )

Calls notifyCamera for the wrapped Renderable. Parameters: pointer  to the Camera to pass to notifyCamera()

void OgreRenderable::setMaterialName (  String &  name  )

Sets the material to be used by the renderable. Parameters: name  the name of the material to use

void OgreRenderable::setRenderGroup (  unsigned char  groupID  )  [virtual]

Sets the rendergroup of the wrapped renderable. Parameters: groupID  the ID of the group to use See also: ElementaryRenderable::setRenderGroup() Implements ElementaryRenderable.

void OgreRenderable::setVisible (  bool  visible  )  [virtual]

Sets the visibility of the wrapped renderable. Parameters: visible  visibility See also: ElementaryRenderable::setVisible() Implements ElementaryRenderable.

---

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

• OgreRenderable.h
• OgreRenderable.cpp

---