Ogre::WireBoundingBox

Ogre::WireBoundingBox Class Reference

Allows the rendering of a wireframe bounding box. More...

#include <OgreWireBoundingBox.h>

Inheritance diagram for Ogre::WireBoundingBox:

Inheritance graph
[legend]

List of all members.

Public Types

typedef std::vector
< ShadowRenderable * > 		ShadowRenderableList
typedef
VectorIterator
< ShadowRenderableList > 		ShadowRenderableListIterator

Public Member Functions

 WireBoundingBox ()
 ~WireBoundingBox ()
void setupBoundingBox (const AxisAlignedBox &aabb)
 Builds the wireframe line list.
Real getSquaredViewDepth (const Camera *cam) const
 Returns the camera-relative squared depth of this renderable.
Real getBoundingRadius (void) const
 Retrieves the radius of the origin-centered bounding sphere for this object.
void setMaterial (const String &matName)
virtual const
MaterialPtr & 		getMaterial (void) const
 Retrieves a weak reference to the material this renderable object uses.
virtual void setRenderOperation (const RenderOperation &rend)
virtual void getRenderOperation (RenderOperation &op)
 Gets the render operation required to send this object to the frame buffer.
void setWorldTransform (const Matrix4 &xform)
virtual void _notifyCurrentCamera (Camera *cam)
 Internal method to notify the object of the camera to be used for the next rendering operation.
void setBoundingBox (const AxisAlignedBox &box)
virtual const
AxisAlignedBox & 		getBoundingBox (void) const
 Retrieves the local axis-aligned bounding box for this object.
virtual void _updateRenderQueue (RenderQueue *queue)
 Internal method by which the movable object must add Renderable subclass instances to the rendering queue.
void visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false)
 Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any.

Parameters:
visitor Pointer to a class implementing the Renderable::Visitor interface which will be called back for each Renderable which will be queued. Bear in mind that the state of the Renderable instances may not be finalised depending on when you call this.
debugRenderables If false, only regular renderables will be visited (those for normal display). If true, debug renderables will be included too.

virtual const String & getMovableType (void) const
 Overridden from MovableObject.
const LightList & getLights (void) const
 Gets a list of lights, ordered relative to how close they are to this renderable.

Remarks:
Directional lights, which have no position, will always be first on this list.

virtual void _notifyCreator (MovableObjectFactory *fact)
 Notify the object of it's creator (internal use only).
virtual
MovableObjectFactory * 		_getCreator (void) const
 Get the creator of this object, if any (internal use only).
virtual void _notifyManager (SceneManager *man)
 Notify the object of it's manager (internal use only).
virtual SceneManager * _getManager (void) const
 Get the manager of this object, if any (internal use only).
virtual const String & getName (void) const
 Returns the name of this object.
virtual Node * getParentNode (void) const
 Returns the node to which this object is attached.
virtual SceneNode * getParentSceneNode (void) const
 Returns the scene node to which this object is attached.
virtual void _notifyAttached (Node *parent, bool isTagPoint=false)
 Internal method called to notify the object that it has been attached to a node.
virtual bool isAttached (void) const
 Returns true if this object is attached to a SceneNode or TagPoint.
virtual void detatchFromParent (void)
 Detaches an object from a parent SceneNode or TagPoint, if attached.
virtual bool isInScene (void) const
 Returns true if this object is attached to a SceneNode or TagPoint, and this SceneNode / TagPoint is currently in an active part of the scene graph.
virtual void _notifyMoved (void)
 Internal method called to notify the object that it has been moved.
virtual const
AxisAlignedBox & 		getWorldBoundingBox (bool derive=false) const
 Retrieves the axis-aligned bounding box for this object in world coordinates.
virtual const Sphere & getWorldBoundingSphere (bool derive=false) const
 Retrieves the worldspace bounding sphere for this object.
virtual void setVisible (bool visible)
 Tells this object whether to be visible or not, if it has a renderable component.
virtual bool getVisible (void) const
 Gets this object whether to be visible or not, if it has a renderable component.
virtual bool isVisible (void) const
 Returns whether or not this object is supposed to be visible or not.
virtual void setRenderingDistance (Real dist)
 Sets the distance at which the object is no longer rendered.
virtual Real getRenderingDistance (void) const
 Gets the distance at which batches are no longer rendered.
virtual void setUserObject (UserDefinedObject *obj)
 Call this to associate your own custom user object instance with this MovableObject.
virtual
UserDefinedObject * 		getUserObject (void)
 Retrieves a pointer to a custom application object associated with this movable by an earlier call to setUserObject.
virtual void setUserAny (const Any &anything)
 Sets any kind of user value on this object.
virtual void setUserAny (const Any &anything)
 Sets any kind of user value on this object.
virtual const Any & getUserAny (void) const
 Retrieves the custom user value associated with this object.
virtual const Any & getUserAny (void) const
 Retrieves the custom user value associated with this object.
virtual void setRenderQueueGroup (uint8 queueID)
 Sets the render queue group this entity will be rendered through.
virtual uint8 getRenderQueueGroup (void) const
 Gets the queue group for this entity, see setRenderQueueGroup for full details.
virtual const Matrix4 & _getParentNodeFullTransform (void) const
 return the full transformation of the parent sceneNode or the attachingPoint node
virtual void setQueryFlags (uint32 flags)
 Sets the query flags for this object.
virtual void addQueryFlags (uint32 flags)
 As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.
virtual void removeQueryFlags (unsigned long flags)
 As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.
virtual uint32 getQueryFlags (void) const
 Returns the query flags relevant for this object.
virtual void setVisibilityFlags (uint32 flags)
 Sets the visiblity flags for this object.
virtual void addVisibilityFlags (uint32 flags)
 As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object.
virtual void removeVisibilityFlags (uint32 flags)
 As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object.
virtual uint32 getVisibilityFlags (void) const
 Returns the visibility flags relevant for this object.
virtual void setListener (Listener *listener)
 Sets a listener for this object.
virtual Listener * getListener (void) const
 Gets the current listener for this object.
virtual const LightList & queryLights (void) const
 Gets a list of lights, ordered relative to how close they are to this movable object.
virtual LightList * _getLightList ()
 Returns a pointer to the current list of lights for this object.
EdgeData * getEdgeList (void)
 Define a default implementation of method from ShadowCaster which implements no shadows.
bool hasEdgeList (void)
 Define a default implementation of method from ShadowCaster which implements no shadows.
ShadowRenderableListIterator getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, bool extrudeVertices, Real extrusionDist, unsigned long flags=0)
 Define a default implementation of method from ShadowCaster which implements no shadows.
const AxisAlignedBox & getLightCapBounds (void) const
 Overridden member from ShadowCaster.
const AxisAlignedBox & getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const
 Overridden member from ShadowCaster.
void setCastShadows (bool enabled)
 Sets whether or not this object will cast shadows.
bool getCastShadows (void) const
 Returns whether shadow casting is enabled for this object.
Real getPointExtrusionDistance (const Light *l) const
 Get the distance to extrude for a point/spot light.
virtual uint32 getTypeFlags (void) const
 Get the 'type flags' for this MovableObject.
virtual void setDebugDisplayEnabled (bool enabled)
 Sets whether or not the debug display of this object is enabled.
virtual bool isDebugDisplayEnabled (void) const
 Gets whether debug display of this object is enabled.
const StringVector & getAnimableValueNames (void) const
 Gets a list of animable value names for this object.
virtual AnimableValuePtr createAnimableValue (const String &valueName)
 Create a reference-counted AnimableValuePtr for the named value.
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info
void * operator new (size_t sz)
void * operator new (size_t sz, void *ptr)
 placement operator new
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info
void * operator new[] (size_t sz)
void operator delete (void *ptr)
void operator delete (void *ptr, const char *, int, const char *)
void operator delete[] (void *ptr)
void operator delete[] (void *ptr, const char *, int, const char *)
virtual Technique * getTechnique (void) const
 Retrieves a pointer to the Material Technique this renderable object uses.
virtual bool preRender (SceneManager *sm, RenderSystem *rsys)
 Called just prior to the Renderable being rendered.
virtual void postRender (SceneManager *sm, RenderSystem *rsys)
 Called immediately after the Renderable has been rendered.
virtual unsigned short getNumWorldTransforms (void) const
 Returns the number of world transform matrices this renderable requires.
void setUseIdentityProjection (bool useIdentityProjection)
 Sets whether or not to use an 'identity' projection.
bool getUseIdentityProjection (void) const
 Returns whether or not to use an 'identity' projection.
void setUseIdentityView (bool useIdentityView)
 Sets whether or not to use an 'identity' view.
bool getUseIdentityView (void) const
 Returns whether or not to use an 'identity' view.
virtual bool getCastsShadows (void) const
 Method which reports whether this renderable would normally cast a shadow.
void setCustomParameter (size_t index, const Vector4 &value)
 Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters.
const Vector4 & getCustomParameter (size_t index) const
 Gets the custom value associated with this Renderable at the given index.
virtual void _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
 Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.
virtual void setPolygonModeOverrideable (bool override)
 Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
virtual bool getPolygonModeOverrideable (void) const
 Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
virtual
RenderSystemData * 		getRenderSystemData () const
 Sets render system private data.
virtual void setRenderSystemData (RenderSystemData *val) const
 gets render system private data

Static Public Member Functions

static void setDefaultQueryFlags (uint32 flags)
 Set the default query flags for all future MovableObject instances.
static uint32 getDefaultQueryFlags ()
 Get the default query flags for all future MovableObject instances.
static void setDefaultVisibilityFlags (uint32 flags)
 Set the default visibility flags for all future MovableObject instances.
static uint32 getDefaultVisibilityFlags ()
 Get the default visibility flags for all future MovableObject instances.
static void extrudeVertices (const HardwareVertexBufferSharedPtr &vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist)
 Utility method for extruding vertices based on a light.

Protected Types

typedef std::map
< String,
StringVector > 		AnimableDictionaryMap
typedef std::map
< size_t, Vector4 > 		CustomParameterMap

Protected Member Functions

void getWorldTransforms (Matrix4 *xform) const
 Override this method to prevent parent transforms (rotation,translation,scale).
void setupBoundingBoxVertices (const AxisAlignedBox &aab)
 Builds the wireframe line list.
Real getExtrusionDistance (const Vector3 &objectPos, const Light *light) const
 Helper method for calculating extrusion distance.
virtual void updateEdgeListLightFacing (EdgeData *edgeData, const Vector4 &lightPos)
 Tells the caster to perform the tasks necessary to update the edge data's light listing.
virtual void generateShadowVolume (EdgeData *edgeData, const HardwareIndexBufferSharedPtr &indexBuffer, const Light *light, ShadowRenderableList &shadowRenderables, unsigned long flags)
 Generates the indexes required to render a shadow volume into the index buffer which is passed in, and updates shadow renderables to use it.
virtual void extrudeBounds (AxisAlignedBox &box, const Vector4 &lightPos, Real extrudeDist) const
 Utility method for extruding a bounding box.
virtual const String & getAnimableDictionaryName (void) const
 Get the name of the animable dictionary for this class.
void createAnimableDictionary (void) const
 Internal method for creating a dictionary of animable value names for the class, if it does not already exist.
StringVector & _getAnimableValueNames (void)
 Get an updateable reference to animable value list.
virtual void initialiseAnimableDictionary (StringVector &) const
 Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters.

Protected Attributes

Real mRadius
RenderOperation mRenderOp
Matrix4 m_matWorldTransform
AxisAlignedBox mBox
String m_strMatName
MaterialPtr m_pMaterial
SceneManager * m_pParentSceneManager
 The scene manager for the current frame.
Camera * m_pCamera
 The camera for the current frame.
String mName
 Name of this object.
MovableObjectFactory * mCreator
 Creator of this object (if created by a factory).
SceneManager * mManager
 SceneManager holding this object (if applicable).
Node * mParentNode
 node to which this object is attached
bool mParentIsTagPoint
bool mVisible
 Is this object visible?
bool mDebugDisplay
 Is debug display enabled?
Real mUpperDistance
 Upper distance to still render.
Real mSquaredUpperDistance
bool mBeyondFarDistance
 Hidden because of distance?
Any mUserAny
 User defined link to another object / value / whatever.
Any mUserAny
uint8 mRenderQueueID
 The render queue to use when rendering this object.
bool mRenderQueueIDSet
 Flags whether the RenderQueue's default should be used.
uint32 mQueryFlags
 Flags determining whether this object is included / excluded from scene queries.
uint32 mVisibilityFlags
 Flags determining whether this object is visible (compared to SceneManager mask).
AxisAlignedBox mWorldAABB
 Cached world AABB of this object.
Sphere mWorldBoundingSphere
AxisAlignedBox mWorldDarkCapBounds
 World space AABB of this object's dark cap.
bool mCastShadows
 Does this object cast shadows?
bool mRenderingDisabled
 Does rendering this object disabled by listener?
Listener * mListener
 MovableObject listener - only one allowed (no list) for size & performance reasons. */.
LightList mLightList
 List of lights for this object.
ulong mLightListUpdated
 The last frame that this light list was updated in.
CustomParameterMap mCustomParameters
bool mPolygonModeOverrideable
bool mUseIdentityProjection
bool mUseIdentityView
RenderSystemData * mRenderSystemData

Static Protected Attributes

static uint ms_uGenNameCount
 Static member used to automatically generate names for SimpleRendaerable objects.
static uint32 msDefaultQueryFlags
 Default query flags.
static uint32 msDefaultVisibilityFlags
 Default visibility flags.
static
AnimableDictionaryMap 		msAnimableDictionary
 Static map of class name to list of animable value names.

Detailed Description

Allows the rendering of a wireframe bounding box.

Remarks:
This class builds a wireframe renderable from a given aabb. A pointer to this class can be added to a render queue to display the bounding box of an object.

Definition at line 43 of file OgreWireBoundingBox.h.

Member Typedef Documentation

typedef std::vector<ShadowRenderable*> Ogre::ShadowCaster::ShadowRenderableList [inherited]

Definition at line 123 of file OgreShadowCaster.h.

typedef VectorIterator<ShadowRenderableList> Ogre::ShadowCaster::ShadowRenderableListIterator [inherited]

Definition at line 124 of file OgreShadowCaster.h.

typedef std::map<String, StringVector> Ogre::AnimableObject::AnimableDictionaryMap [protected, inherited]

Definition at line 234 of file OgreAnimable.h.

typedef std::map<size_t, Vector4> Ogre::Renderable::CustomParameterMap [protected, inherited]

Definition at line 371 of file OgreRenderable.h.

Constructor & Destructor Documentation

Ogre::WireBoundingBox::WireBoundingBox (  ) 

Ogre::WireBoundingBox::~WireBoundingBox (  ) 

Member Function Documentation

void Ogre::WireBoundingBox::getWorldTransforms ( Matrix4 *  xform  )  const [protected, virtual]

Override this method to prevent parent transforms (rotation,translation,scale).

Reimplemented from Ogre::SimpleRenderable.

void Ogre::WireBoundingBox::setupBoundingBoxVertices ( const AxisAlignedBox &  aab  )  [protected]

Builds the wireframe line list.

void Ogre::WireBoundingBox::setupBoundingBox ( const AxisAlignedBox &  aabb  ) 

Builds the wireframe line list.

Parameters:
aabb bounding box to build a wireframe from.

Real Ogre::WireBoundingBox::getSquaredViewDepth ( const Camera *  cam  )  const [virtual]

Returns the camera-relative squared depth of this renderable.

Remarks:
Used to sort transparent objects. Squared depth is used rather than actual depth to avoid having to perform a square root on the result.

Implements Ogre::Renderable.

Real Ogre::WireBoundingBox::getBoundingRadius ( void   )  const [virtual]

Retrieves the radius of the origin-centered bounding sphere for this object.

Implements Ogre::MovableObject.

Definition at line 69 of file OgreWireBoundingBox.h.

void Ogre::SimpleRenderable::setMaterial ( const String &  matName  )  [inherited]

virtual const MaterialPtr& Ogre::SimpleRenderable::getMaterial ( void   )  const [virtual, inherited]

Retrieves a weak reference to the material this renderable object uses.

Remarks:
Note that the Renderable also has the option to override the getTechnique method to specify a particular Technique to use instead of the best one available.

Implements Ogre::Renderable.

Reimplemented in Ogre::InstancedGeometry::GeometryBucket.

virtual void Ogre::SimpleRenderable::setRenderOperation ( const RenderOperation &  rend  )  [virtual, inherited]

virtual void Ogre::SimpleRenderable::getRenderOperation ( RenderOperation &  op  )  [virtual, inherited]

Gets the render operation required to send this object to the frame buffer.

Implements Ogre::Renderable.

void Ogre::SimpleRenderable::setWorldTransform ( const Matrix4 &  xform  )  [inherited]

virtual void Ogre::SimpleRenderable::_notifyCurrentCamera ( Camera *  cam  )  [virtual, inherited]

Internal method to notify the object of the camera to be used for the next rendering operation.

Remarks:
Certain objects may want to do specific processing based on the camera position. This method notifies them in case they wish to do this.

Reimplemented from Ogre::MovableObject.

void Ogre::SimpleRenderable::setBoundingBox ( const AxisAlignedBox &  box  )  [inherited]

virtual const AxisAlignedBox& Ogre::SimpleRenderable::getBoundingBox ( void   )  const [virtual, inherited]

Retrieves the local axis-aligned bounding box for this object.

Remarks:
This bounding box is in local coordinates.

Implements Ogre::MovableObject.

virtual void Ogre::SimpleRenderable::_updateRenderQueue ( RenderQueue *  queue  )  [virtual, inherited]

Internal method by which the movable object must add Renderable subclass instances to the rendering queue.

Remarks:
The engine will call this method when this object is to be rendered. The object must then create one or more Renderable subclass instances which it places on the passed in Queue for rendering.

Implements Ogre::MovableObject.

void Ogre::SimpleRenderable::visitRenderables ( Renderable::Visitor *  visitor,
bool  debugRenderables = false 
) [virtual, inherited]

Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any.

Parameters:
visitor Pointer to a class implementing the Renderable::Visitor interface which will be called back for each Renderable which will be queued. Bear in mind that the state of the Renderable instances may not be finalised depending on when you call this.
debugRenderables If false, only regular renderables will be visited (those for normal display). If true, debug renderables will be included too.

Implements Ogre::MovableObject.

Reimplemented in Ogre::InstancedGeometry::GeometryBucket.

virtual const String& Ogre::SimpleRenderable::getMovableType ( void   )  const [virtual, inherited]

Overridden from MovableObject.

Implements Ogre::MovableObject.

const LightList& Ogre::SimpleRenderable::getLights ( void   )  const [virtual, inherited]

Gets a list of lights, ordered relative to how close they are to this renderable.

Remarks:
Directional lights, which have no position, will always be first on this list.

Implements Ogre::Renderable.

Reimplemented in Ogre::InstancedGeometry::GeometryBucket.

virtual void Ogre::MovableObject::_notifyCreator ( MovableObjectFactory *  fact  )  [virtual, inherited]

Notify the object of it's creator (internal use only).

Definition at line 169 of file OgreMovableObject.h.

virtual MovableObjectFactory* Ogre::MovableObject::_getCreator ( void   )  const [virtual, inherited]

Get the creator of this object, if any (internal use only).

Definition at line 171 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::_notifyManager ( SceneManager *  man  )  [virtual, inherited]

Notify the object of it's manager (internal use only).

Definition at line 173 of file OgreMovableObject.h.

virtual SceneManager* Ogre::MovableObject::_getManager ( void   )  const [virtual, inherited]

Get the manager of this object, if any (internal use only).

Definition at line 175 of file OgreMovableObject.h.

virtual const String& Ogre::MovableObject::getName ( void   )  const [virtual, inherited]

Returns the name of this object.

Reimplemented in Ogre::Camera.

Definition at line 178 of file OgreMovableObject.h.

virtual Node* Ogre::MovableObject::getParentNode ( void   )  const [virtual, inherited]

Returns the node to which this object is attached.

Remarks:
A MovableObject may be attached to either a SceneNode or to a TagPoint, the latter case if it's attached to a bone on an animated entity. Both are Node subclasses so this method will return either.

virtual SceneNode* Ogre::MovableObject::getParentSceneNode ( void   )  const [virtual, inherited]

Returns the scene node to which this object is attached.

Remarks:
A MovableObject may be attached to either a SceneNode or to a TagPoint, the latter case if it's attached to a bone on an animated entity. This method will return the scene node of the parent entity if the latter is true.

virtual void Ogre::MovableObject::_notifyAttached ( Node *  parent,
bool  isTagPoint = false 
) [virtual, inherited]

Internal method called to notify the object that it has been attached to a node.

Reimplemented in Ogre::Entity, Ogre::Light, and Ogre::ParticleSystem.

virtual bool Ogre::MovableObject::isAttached ( void   )  const [virtual, inherited]

Returns true if this object is attached to a SceneNode or TagPoint.

virtual void Ogre::MovableObject::detatchFromParent ( void   )  [virtual, inherited]

Detaches an object from a parent SceneNode or TagPoint, if attached.

virtual bool Ogre::MovableObject::isInScene ( void   )  const [virtual, inherited]

Returns true if this object is attached to a SceneNode or TagPoint, and this SceneNode / TagPoint is currently in an active part of the scene graph.

virtual void Ogre::MovableObject::_notifyMoved ( void   )  [virtual, inherited]

Internal method called to notify the object that it has been moved.

Reimplemented in Ogre::Light.

virtual const AxisAlignedBox& Ogre::MovableObject::getWorldBoundingBox ( bool  derive = false  )  const [virtual, inherited]

Retrieves the axis-aligned bounding box for this object in world coordinates.

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::Entity.

virtual const Sphere& Ogre::MovableObject::getWorldBoundingSphere ( bool  derive = false  )  const [virtual, inherited]

Retrieves the worldspace bounding sphere for this object.

Reimplemented in Ogre::Entity.

virtual void Ogre::MovableObject::setVisible ( bool  visible  )  [virtual, inherited]

Tells this object whether to be visible or not, if it has a renderable component.

Note:
An alternative approach of making an object invisible is to detach it from it's SceneNode, or to remove the SceneNode entirely. Detaching a node means that structurally the scene graph changes. Once this change has taken place, the objects / nodes that have been removed have less overhead to the visibility detection pass than simply making the object invisible, so if you do this and leave the objects out of the tree for a long time, it's faster. However, the act of detaching / reattaching nodes is in itself more expensive than setting an object visibility flag, since in the latter case structural changes are not made. Therefore, small or frequent visibility changes are best done using this method; large or more longer term changes are best done by detaching.

Reimplemented in Ogre::Light.

virtual bool Ogre::MovableObject::getVisible ( void   )  const [virtual, inherited]

Gets this object whether to be visible or not, if it has a renderable component.

Remarks:
Returns the value set by MovableObject::setVisible only.

virtual bool Ogre::MovableObject::isVisible ( void   )  const [virtual, inherited]

Returns whether or not this object is supposed to be visible or not.

Remarks:
Takes into account both upper rendering distance and visible flag.

Reimplemented in Ogre::InstancedGeometry::BatchInstance, and Ogre::StaticGeometry::Region.

virtual void Ogre::MovableObject::setRenderingDistance ( Real  dist  )  [virtual, inherited]

Sets the distance at which the object is no longer rendered.

Parameters:
dist Distance beyond which the object will not be rendered (the default is 0, which means objects are always rendered).

Definition at line 280 of file OgreMovableObject.h.

virtual Real Ogre::MovableObject::getRenderingDistance ( void   )  const [virtual, inherited]

Gets the distance at which batches are no longer rendered.

Definition at line 286 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setUserObject ( UserDefinedObject *  obj  )  [virtual, inherited]

Call this to associate your own custom user object instance with this MovableObject.

Remarks:
By simply making your game / application object a subclass of UserDefinedObject, you can establish a link between an OGRE instance of