Ogre::StaticGeometry::Region Class Reference

The details of a topological region which is the highest level of partitioning for this class. More...

#include <OgreStaticGeometry.h>

Inheritance diagram for Ogre::StaticGeometry::Region:

Inheritance graph
[legend]

List of all members.

Public Types

typedef std::vector< LODBucket * > LODBucketList
 list of LOD Buckets in this region
typedef VectorIterator
< LODBucketList
LODIterator
typedef std::vector
< ShadowRenderable * > 
ShadowRenderableList
typedef VectorIterator
< ShadowRenderableList
ShadowRenderableListIterator

Public Member Functions

 Region (StaticGeometry *parent, const String &name, SceneManager *mgr, uint32 regionID, const Vector3 &centre)
virtual ~Region ()
StaticGeometrygetParent (void) const
void assign (QueuedSubMesh *qmesh)
 Assign a queued mesh to this region, read for final build.
void build (bool stencilShadows)
 Build this region.
uint32 getID (void) const
 Get the region ID of this region.
const Vector3getCentre (void) const
 Get the centre point of the region.
const StringgetMovableType (void) const
 Returns the type name of this object.
void _notifyCurrentCamera (Camera *cam)
 Internal method to notify the object of the camera to be used for the next rendering operation.
const AxisAlignedBoxgetBoundingBox (void) const
 Retrieves the local axis-aligned bounding box for this object.
Real getBoundingRadius (void) const
 Retrieves the radius of the origin-centered bounding sphere for this object.
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.

bool isVisible (void) const
 Returns whether or not this object is supposed to be visible or not.
uint32 getTypeFlags (void) const
 Get the 'type flags' for this MovableObject.
LODIterator getLODIterator (void)
 Get an iterator over the LODs in this region.
ShadowRenderableListIterator getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, bool extrudeVertices, Real extrusionDistance, unsigned long flags=0)
 Gets an iterator over the renderables required to render the shadow volume.

Remarks:
Shadowable geometry should ideally be designed such that there is only one ShadowRenderable required to render the the shadow; however this is not a necessary limitation and it can be exceeded if required.
Parameters:
shadowTechnique The technique being used to generate the shadow
light The light to generate the shadow from
indexBuffer The index buffer to build the renderables into, the current contents are assumed to be disposable.
extrudeVertices If true, this means this class should extrude the vertices of the back of the volume in software. If false, it will not be done (a vertex program is assumed).
extrusionDistance The distance to extrude the shadow volume
flags Technique-specific flags, see ShadowRenderableFlags

EdgeDatagetEdgeList (void)
 Overridden from MovableObject.
bool hasEdgeList (void)
 Overridden member from ShadowCaster.
void dump (std::ofstream &of) const
 Dump contents for diagnostics.
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 StringgetName (void) const
 Returns the name of this object.
virtual NodegetParentNode (void) const
 Returns the node to which this object is attached.
virtual SceneNodegetParentSceneNode (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 AxisAlignedBoxgetWorldBoundingBox (bool derive=false) const
 Retrieves the axis-aligned bounding box for this object in world coordinates.
virtual const SpheregetWorldBoundingSphere (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 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 UserDefinedObjectgetUserObject (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 const AnygetUserAny (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 ListenergetListener (void) const
 Gets the current listener for this object.
virtual const LightListqueryLights (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.
const AxisAlignedBoxgetLightCapBounds (void) const
 Overridden member from ShadowCaster.
const AxisAlignedBoxgetDarkCapBounds (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.
bool getReceivesShadows ()
 Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows.
Real getPointExtrusionDistance (const Light *l) const
 Get the distance to extrude for a point/spot light.
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 StringVectorgetAnimableValueNames (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, void *)
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 *)

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

Protected Member Functions

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 StringgetAnimableDictionaryName (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

StaticGeometrymParent
 Parent static geometry.
SceneManagermSceneMgr
 Scene manager link.
SceneNodemNode
 Scene node.
QueuedSubMeshList mQueuedSubMeshes
 Local list of queued meshes (not used for deallocation).
uint32 mRegionID
 Unique identifier for the region.
Vector3 mCentre
 Center of the region.
std::vector< RealmLodSquaredDistances
 LOD distances (squared) as built up - use the max at each level.
AxisAlignedBox mAABB
 Local AABB relative to region centre.
Real mBoundingRadius
 Local bounding radius.
ushort mCurrentLod
 The current lod level, as determined from the last camera.
Real mCamDistanceSquared
 Current camera distance, passed on to do material lod later.
LODBucketList mLodBucketList
 List of LOD buckets.
LightList mLightList
 List of lights for this region.
ulong mLightListUpdated
 The last frame that this light list was updated in.
String mName
 Name of this object.
MovableObjectFactorymCreator
 Creator of this object (if created by a factory).
SceneManagermManager
 SceneManager holding this object (if applicable).
NodemParentNode
 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.
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?
ListenermListener
 MovableObject listener - only one allowed (no list) for size & performance reasons. */.

Static Protected Attributes

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

The details of a topological region which is the highest level of partitioning for this class.

Remarks:
The size & shape of regions entirely depends on the SceneManager specific implementation. It is a MovableObject since it will be attached to a node based on the local centre - in practice it won't actually move (although in theory it could).

Definition at line 382 of file OgreStaticGeometry.h.


Member Typedef Documentation

list of LOD Buckets in this region

Definition at line 386 of file OgreStaticGeometry.h.

Definition at line 444 of file OgreStaticGeometry.h.

Definition at line 123 of file OgreShadowCaster.h.

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.


Constructor & Destructor Documentation

Ogre::StaticGeometry::Region::Region ( StaticGeometry parent,
const String name,
SceneManager mgr,
uint32  regionID,
const Vector3 centre 
)

virtual Ogre::StaticGeometry::Region::~Region (  )  [virtual]


Member Function Documentation

StaticGeometry* Ogre::StaticGeometry::Region::getParent ( void   )  const

Definition at line 424 of file OgreStaticGeometry.h.

void Ogre::StaticGeometry::Region::assign ( QueuedSubMesh qmesh  ) 

Assign a queued mesh to this region, read for final build.

void Ogre::StaticGeometry::Region::build ( bool  stencilShadows  ) 

Build this region.

uint32 Ogre::StaticGeometry::Region::getID ( void   )  const

Get the region ID of this region.

Definition at line 430 of file OgreStaticGeometry.h.

const Vector3& Ogre::StaticGeometry::Region::getCentre ( void   )  const

Get the centre point of the region.

Definition at line 432 of file OgreStaticGeometry.h.

const String& Ogre::StaticGeometry::Region::getMovableType ( void   )  const [virtual]

Returns the type name of this object.

Implements Ogre::MovableObject.

void Ogre::StaticGeometry::Region::_notifyCurrentCamera ( Camera cam  )  [virtual]

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.

const AxisAlignedBox& Ogre::StaticGeometry::Region::getBoundingBox ( void   )  const [virtual]

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

Remarks:
This bounding box is in local coordinates.

Implements Ogre::MovableObject.

Real Ogre::StaticGeometry::Region::getBoundingRadius ( void   )  const [virtual]

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

Implements Ogre::MovableObject.

void Ogre::StaticGeometry::Region::_updateRenderQueue ( RenderQueue queue  )  [virtual]

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::StaticGeometry::Region::visitRenderables ( Renderable::Visitor visitor,
bool  debugRenderables = false 
) [virtual]

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.

bool Ogre::StaticGeometry::Region::isVisible ( void   )  const [virtual]

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 from Ogre::MovableObject.

uint32 Ogre::StaticGeometry::Region::getTypeFlags ( void   )  const [virtual]

Get the 'type flags' for this MovableObject.

Remarks:
A type flag identifies the type of the MovableObject as a bitpattern. This is used for categorical inclusion / exclusion in SceneQuery objects. By default, this method returns all ones for objects not created by a MovableObjectFactory (hence always including them); otherwise it returns the value assigned to the MovableObjectFactory. Custom objects which don't use MovableObjectFactory will need to override this if they want to be included in queries.

Reimplemented from Ogre::MovableObject.

LODIterator Ogre::StaticGeometry::Region::getLODIterator ( void   ) 

Get an iterator over the LODs in this region.

ShadowRenderableListIterator Ogre::StaticGeometry::Region::getShadowVolumeRenderableIterator ( ShadowTechnique  shadowTechnique,
const Light light,
HardwareIndexBufferSharedPtr indexBuffer,
bool  extrudeVertices,
Real  extrusionDistance,
unsigned long  flags = 0 
) [virtual]

Gets an iterator over the renderables required to render the shadow volume.

Remarks:
Shadowable geometry should ideally be designed such that there is only one ShadowRenderable required to render the the shadow; however this is not a necessary limitation and it can be exceeded if required.
Parameters:
shadowTechnique The technique being used to generate the shadow
light The light to generate the shadow from
indexBuffer The index buffer to build the renderables into, the current contents are assumed to be disposable.
extrudeVertices If true, this means this class should extrude the vertices of the back of the volume in software. If false, it will not be done (a vertex program is assumed).
extrusionDistance The distance to extrude the shadow volume
flags Technique-specific flags, see ShadowRenderableFlags

Reimplemented from Ogre::MovableObject.

EdgeData* Ogre::StaticGeometry::Region::getEdgeList ( void   )  [virtual]

Overridden from MovableObject.

Reimplemented from Ogre::MovableObject.

bool Ogre::StaticGeometry::Region::hasEdgeList ( void   )  [virtual]

Overridden member from ShadowCaster.

Reimplemented from Ogre::MovableObject.

void Ogre::StaticGeometry::Region::dump ( std::ofstream &  of  )  const

Dump contents for diagnostics.

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 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 MovableObject and your own application classes. Call this method to establish the link.

Definition at line 294 of file OgreMovableObject.h.

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

Retrieves a pointer to a custom application object associated with this movable by an earlier call to setUserObject.

Definition at line 298 of file OgreMovableObject.h.

References Ogre::any_cast().

virtual void Ogre::MovableObject::setUserAny ( const Any anything  )  [virtual, inherited]

Sets any kind of user value on this object.

Remarks:
This method allows you to associate any user value you like with this MovableObject. This can be a pointer back to one of your own classes for instance.
Note:
This value is shared with setUserObject so don't use both!

Definition at line 310 of file OgreMovableObject.h.

virtual const Any& Ogre::MovableObject::getUserAny ( void   )  const [virtual, inherited]

Retrieves the custom user value associated with this object.

Definition at line 314 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setRenderQueueGroup ( uint8  queueID  )  [virtual, inherited]

Sets the render queue group this entity will be rendered through.

Remarks:
Render queues are grouped to allow you to more tightly control the ordering of rendered objects. If you do not call this method, all Entity objects default to the default queue (RenderQueue::getDefaultQueueGroup), which is fine for most objects. You may want to alter this if you want this entity to always appear in front of other objects, e.g. for a 3D menu system or such.
See RenderQueue for more details.
Parameters:
queueID Enumerated value of the queue group to use.

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

virtual uint8 Ogre::MovableObject::getRenderQueueGroup ( void   )  const [virtual, inherited]

Gets the queue group for this entity, see setRenderQueueGroup for full details.

virtual const Matrix4& Ogre::MovableObject::_getParentNodeFullTransform ( void   )  const [virtual, inherited]

return the full transformation of the parent sceneNode or the attachingPoint node

virtual void Ogre::MovableObject::setQueryFlags ( uint32  flags  )  [virtual, inherited]

Sets the query flags for this object.

Remarks:
When performing a scene query, this object will be included or excluded according to flags on the object and flags on the query. This is a bitwise value, so only when a bit on these flags is set, will it be included in a query asking for that flag. The meaning of the bits is application-specific.

Definition at line 342 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::addQueryFlags ( uint32  flags  )  [virtual, inherited]

As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.

Definition at line 346 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::removeQueryFlags ( unsigned long  flags  )  [virtual, inherited]

As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.

Definition at line 350 of file OgreMovableObject.h.

virtual uint32 Ogre::MovableObject::getQueryFlags ( void   )  const [virtual, inherited]

Returns the query flags relevant for this object.

Definition at line 353 of file OgreMovableObject.h.

static void Ogre::MovableObject::setDefaultQueryFlags ( uint32  flags  )  [static, inherited]

Set the default query flags for all future MovableObject instances.

Definition at line 357 of file OgreMovableObject.h.

static uint32 Ogre::MovableObject::getDefaultQueryFlags (  )  [static, inherited]

Get the default query flags for all future MovableObject instances.

Definition at line 361 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setVisibilityFlags ( uint32  flags  )  [virtual, inherited]

Sets the visiblity flags for this object.

Remarks:
As well as a simple true/false value for visibility (as seen in setVisible), you can also set visiblity flags which when 'and'ed with the SceneManager's visibility mask can also make an object invisible.

Definition at line 370 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::addVisibilityFlags ( uint32  flags  )  [virtual, inherited]

As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object.

Definition at line 374 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::removeVisibilityFlags ( uint32  flags  )  [virtual, inherited]

As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object.

Definition at line 378 of file OgreMovableObject.h.

virtual uint32 Ogre::MovableObject::getVisibilityFlags ( void   )  const [virtual, inherited]

Returns the visibility flags relevant for this object.

Definition at line 381 of file OgreMovableObject.h.

static void Ogre::MovableObject::setDefaultVisibilityFlags ( uint32  flags  )  [static, inherited]

Set the default visibility flags for all future MovableObject instances.

Definition at line 385 of file OgreMovableObject.h.

static uint32 Ogre::MovableObject::getDefaultVisibilityFlags (  )  [static, inherited]

Get the default visibility flags for all future MovableObject instances.

Definition at line 389 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setListener ( Listener listener  )  [virtual, inherited]

Sets a listener for this object.

Remarks:
Note for size and performance reasons only one listener per object is allowed.

Definition at line 396 of file OgreMovableObject.h.

virtual Listener* Ogre::MovableObject::getListener ( void   )  const [virtual, inherited]

Gets the current listener for this object.

Definition at line 400 of file OgreMovableObject.h.

virtual const LightList& Ogre::MovableObject::queryLights ( void   )  const [virtual, inherited]

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

Remarks:
By default, this method gives the listener a chance to populate light list first, if there is no listener or Listener::objectQueryLights returns NULL, it'll query the light list from parent entity if it is present, or returns SceneNode::findLights if it has parent scene node, otherwise it just returns an empty list.
The object internally caches the light list, so it will recalculate it only when object is moved, or lights that affect the frustum have been changed (
See also:
SceneManager::_getLightsDirtyCounter), but if listener exists, it will be called each time, so the listener should implement their own cache mechanism to optimise performance.
This method can be useful when implementing Renderable::getLights in case the renderable is a part of the movable.
Returns:
The list of lights use to lighting this object.

virtual LightList* Ogre::MovableObject::_getLightList (  )  [virtual, inherited]

Returns a pointer to the current list of lights for this object.

Remarks:
You should not modify this list outside of MovableObject::Listener::objectQueryLights (say if you want to use it to implement this method, and use the pointer as a return value) and for reading it's only accurate as at the last frame.

Definition at line 428 of file OgreMovableObject.h.

const AxisAlignedBox& Ogre::MovableObject::getLightCapBounds ( void   )  const [virtual, inherited]

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

const AxisAlignedBox& Ogre::MovableObject::getDarkCapBounds ( const Light light,
Real  dirLightExtrusionDist 
) const [virtual, inherited]

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

void Ogre::MovableObject::setCastShadows ( bool  enabled  )  [inherited]

Sets whether or not this object will cast shadows.

Remarks:
This setting simply allows you to turn on/off shadows for a given object. An object will not cast shadows unless the scene supports it in any case (see SceneManager::setShadowTechnique), and also the material which is in use must also have shadow casting enabled. By default all entities cast shadows. If, however, for some reason you wish to disable this for a single object then you can do so using this method.
Note:
This method normally refers to objects which block the light, but since Light is also a subclass of MovableObject, in that context it means whether the light causes shadows itself.

Definition at line 456 of file OgreMovableObject.h.

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

Returns whether shadow casting is enabled for this object.

Implements Ogre::ShadowCaster.

Definition at line 458 of file OgreMovableObject.h.

bool Ogre::MovableObject::getReceivesShadows (  )  [inherited]

Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows.

Real Ogre::MovableObject::getPointExtrusionDistance ( const Light l  )  const [virtual, inherited]

Get the distance to extrude for a point/spot light.

Implements Ogre::ShadowCaster.

virtual void Ogre::MovableObject::setDebugDisplayEnabled ( bool  enabled  )  [virtual, inherited]

Sets whether or not the debug display of this object is enabled.

Remarks:
Some objects aren't visible themselves but it can be useful to display a debug representation of them. Or, objects may have an additional debug display on top of their regular display. This option enables / disables that debug display. Objects that are not visible never display debug geometry regardless of this setting.

Definition at line 500 of file OgreMovableObject.h.

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

Gets whether debug display of this object is enabled.

Definition at line 502 of file OgreMovableObject.h.

static void Ogre::ShadowCaster::extrudeVertices ( const HardwareVertexBufferSharedPtr vertexBuffer,
size_t  originalVertexCount,
const Vector4 lightPos,
Real  extrudeDist 
) [static, inherited]

Utility method for extruding vertices based on a light.

Remarks:
Unfortunately, because D3D cannot handle homogeneous (4D) position coordinates in the fixed-function pipeline (GL can, but we have to be cross-API), when we extrude in software we cannot extrude to infinity the way we do in the vertex program (by setting w to 0.0f). Therefore we extrude by a fixed distance, which may cause some problems with larger scenes. Luckily better hardware (ie vertex programs) can fix this.
Parameters:
vertexBuffer The vertex buffer containing ONLY xyz position values, which must be originalVertexCount * 2 * 3 floats long.
originalVertexCount The count of the original number of vertices, i.e. the number in the mesh, not counting the doubling which has already been done (by VertexData::prepareForShadowVolume) to provide the extruded area of the buffer.
lightPos 4D light position in object space, when w=0.0f this represents a directional light
extrudeDist The distance to extrude

Real Ogre::ShadowCaster::getExtrusionDistance ( const Vector3 objectPos,
const Light light 
) const [protected, inherited]

Helper method for calculating extrusion distance.

virtual void Ogre::ShadowCaster::updateEdgeListLightFacing ( EdgeData edgeData,
const Vector4 lightPos 
) [protected, virtual, inherited]

Tells the caster to perform the tasks necessary to update the edge data's light listing.

Can be overridden if the subclass needs to do additional things.

Parameters:
edgeData The edge information to update
lightPos 4D vector representing the light, a directional light has w=0.0

virtual void Ogre::ShadowCaster::generateShadowVolume ( EdgeData edgeData,
const HardwareIndexBufferSharedPtr indexBuffer,
const Light light,
ShadowRenderableList shadowRenderables,
unsigned long  flags 
) [protected, virtual, inherited]

Generates the indexes required to render a shadow volume into the index buffer which is passed in, and updates shadow renderables to use it.

Parameters:
edgeData The edge information to use
indexBuffer The buffer into which to write data into; current contents are assumed to be discardable.
light The light, mainly for type info as silhouette calculations should already have been done in updateEdgeListLightFacing
shadowRenderables A list of shadow renderables which has already been constructed but will need populating with details of the index ranges to be used.
flags Additional controller flags, see ShadowRenderableFlags

virtual void Ogre::ShadowCaster::extrudeBounds ( AxisAlignedBox box,
const Vector4 lightPos,
Real  extrudeDist 
) const [protected, virtual, inherited]

Utility method for extruding a bounding box.

Parameters:
box Original bounding box, will be updated in-place
lightPos 4D light position in object space, when w=0.0f this represents a directional light
extrudeDist The distance to extrude

virtual const String& Ogre::AnimableObject::getAnimableDictionaryName ( void   )  const [protected, virtual, inherited]

Get the name of the animable dictionary for this class.

Remarks:
Subclasses must override this if they want to support animation of their values.

Reimplemented in Ogre::Light.

Definition at line 242 of file OgreAnimable.h.

References Ogre::StringUtil::BLANK.

void Ogre::AnimableObject::createAnimableDictionary ( void   )  const [protected, inherited]

Internal method for creating a dictionary of animable value names for the class, if it does not already exist.

Definition at line 247 of file OgreAnimable.h.

StringVector& Ogre::AnimableObject::_getAnimableValueNames ( void   )  [protected, inherited]

Get an updateable reference to animable value list.

Definition at line 260 of file OgreAnimable.h.

References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.

virtual void Ogre::AnimableObject::initialiseAnimableDictionary ( StringVector  )  const [protected, virtual, inherited]

Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters.

Reimplemented in Ogre::Light.

Definition at line 280 of file OgreAnimable.h.

const StringVector& Ogre::AnimableObject::getAnimableValueNames ( void   )  const [inherited]

Gets a list of animable value names for this object.

Definition at line 288 of file OgreAnimable.h.

References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.

virtual AnimableValuePtr Ogre::AnimableObject::createAnimableValue ( const String valueName  )  [virtual, inherited]

Create a reference-counted AnimableValuePtr for the named value.

Remarks:
You can use the returned object to animate a value on this object, using AnimationTrack. Subclasses must override this if they wish to support animation of their values.

Reimplemented in Ogre::Light.

Definition at line 313 of file OgreAnimable.h.

References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.

template<class Alloc>
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
) [inherited]

operator new, with debug line info

Definition at line 62 of file OgreMemoryAllocatedObject.h.

template<class Alloc>
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz  )  [inherited]

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc>
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
) [inherited]

placement operator new

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc>
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
) [inherited]

array operator new, with debug line info

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc>
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz  )  [inherited]

Definition at line 84 of file OgreMemoryAllocatedObject.h.

template<class Alloc>
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr  )  [inherited]

Definition at line 89 of file OgreMemoryAllocatedObject.h.

template<class Alloc>
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
) [inherited]

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc>
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
) [inherited]

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc>
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr  )  [inherited]

Definition at line 106 of file OgreMemoryAllocatedObject.h.

template<class Alloc>
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
) [inherited]

Definition at line 112 of file OgreMemoryAllocatedObject.h.


Member Data Documentation

Parent static geometry.

Definition at line 389 of file OgreStaticGeometry.h.

Scene manager link.

Definition at line 391 of file OgreStaticGeometry.h.

Scene node.

Definition at line 393 of file OgreStaticGeometry.h.

Local list of queued meshes (not used for deallocation).

Definition at line 395 of file OgreStaticGeometry.h.

Unique identifier for the region.

Definition at line 397 of file OgreStaticGeometry.h.

Center of the region.

Definition at line 399 of file OgreStaticGeometry.h.

LOD distances (squared) as built up - use the max at each level.

Definition at line 401 of file OgreStaticGeometry.h.

Local AABB relative to region centre.

Definition at line 403 of file OgreStaticGeometry.h.

Local bounding radius.

Definition at line 405 of file OgreStaticGeometry.h.

The current lod level, as determined from the last camera.

Definition at line 407 of file OgreStaticGeometry.h.

Current camera distance, passed on to do material lod later.

Definition at line 409 of file OgreStaticGeometry.h.

List of LOD buckets.

Definition at line 411 of file OgreStaticGeometry.h.

List of lights for this region.

Reimplemented from Ogre::MovableObject.

Definition at line 413 of file OgreStaticGeometry.h.

The last frame that this light list was updated in.

Reimplemented from Ogre::MovableObject.

Definition at line 415 of file OgreStaticGeometry.h.

String Ogre::MovableObject::mName [protected, inherited]

Name of this object.

Reimplemented in Ogre::Camera.

Definition at line 104 of file OgreMovableObject.h.

Creator of this object (if created by a factory).

Definition at line 106 of file OgreMovableObject.h.

SceneManager holding this object (if applicable).

Definition at line 108 of file OgreMovableObject.h.

Node* Ogre::MovableObject::mParentNode [protected, inherited]

node to which this object is attached

Definition at line 110 of file OgreMovableObject.h.

bool Ogre::MovableObject::mParentIsTagPoint [protected, inherited]

Definition at line 111 of file OgreMovableObject.h.

bool Ogre::MovableObject::mVisible [protected, inherited]

Is this object visible?

Definition at line 113 of file OgreMovableObject.h.

bool Ogre::MovableObject::mDebugDisplay [protected, inherited]

Is debug display enabled?

Definition at line 115 of file OgreMovableObject.h.

Real Ogre::MovableObject::mUpperDistance [protected, inherited]

Upper distance to still render.

Definition at line 117 of file OgreMovableObject.h.

Definition at line 118 of file OgreMovableObject.h.

bool Ogre::MovableObject::mBeyondFarDistance [protected, inherited]

Hidden because of distance?

Definition at line 120 of file OgreMovableObject.h.

Any Ogre::MovableObject::mUserAny [protected, inherited]

User defined link to another object / value / whatever.

Definition at line 122 of file OgreMovableObject.h.

The render queue to use when rendering this object.

Definition at line 124 of file OgreMovableObject.h.

bool Ogre::MovableObject::mRenderQueueIDSet [protected, inherited]

Flags whether the RenderQueue's default should be used.

Definition at line 126 of file OgreMovableObject.h.

uint32 Ogre::MovableObject::mQueryFlags [protected, inherited]

Flags determining whether this object is included / excluded from scene queries.

Definition at line 128 of file OgreMovableObject.h.

Flags determining whether this object is visible (compared to SceneManager mask).

Definition at line 130 of file OgreMovableObject.h.

AxisAlignedBox Ogre::MovableObject::mWorldAABB [mutable, protected, inherited]

Cached world AABB of this object.

Reimplemented in Ogre::ParticleSystem.

Definition at line 132 of file OgreMovableObject.h.

Sphere Ogre::MovableObject::mWorldBoundingSphere [mutable, protected, inherited]

Definition at line 134 of file OgreMovableObject.h.

World space AABB of this object's dark cap.

Definition at line 136 of file OgreMovableObject.h.

bool Ogre::MovableObject::mCastShadows [protected, inherited]

Does this object cast shadows?

Definition at line 138 of file OgreMovableObject.h.

bool Ogre::MovableObject::mRenderingDisabled [protected, inherited]

Does rendering this object disabled by listener?

Definition at line 141 of file OgreMovableObject.h.

Listener* Ogre::MovableObject::mListener [protected, inherited]

MovableObject listener - only one allowed (no list) for size & performance reasons. */.

Definition at line 143 of file OgreMovableObject.h.

uint32 Ogre::MovableObject::msDefaultQueryFlags [static, protected, inherited]

Default query flags.

Definition at line 152 of file OgreMovableObject.h.

uint32 Ogre::MovableObject::msDefaultVisibilityFlags [static, protected, inherited]

Default visibility flags.

Definition at line 154 of file OgreMovableObject.h.

Static map of class name to list of animable value names.

Definition at line 236 of file OgreAnimable.h.


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

Copyright © 2008 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Sep 27 22:07:37 2009