OGRE: Ogre::StaticGeometry::Region Class Reference

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

StaticGeometry * getParent (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 Vector3 & getCentre (void) const

Get the centre point of the region.

const String & getMovableType (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 AxisAlignedBox & getBoundingBox (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

EdgeData * getEdgeList (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 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 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 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.

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 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 *)

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

StaticGeometry * mParent

Parent static geometry.

SceneManager * mSceneMgr

Scene manager link.

SceneNode * mNode

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< Real > mLodSquaredDistances

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.

List of LOD buckets.

List of lights for this region.

ulong

mLightListUpdated

The last frame that this light list was updated in.

EdgeData * mEdgeList

Edge list, used if stencil shadow casting is enabled.

ShadowRenderableList

mShadowRenderables

List of shadow renderables.

bool mVertexProgramInUse

Is a vertex program in use somewhere in this region?

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.

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. */.

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.

Classes

class RegionShadowRenderable

Nested class to allow region shadows. More...

Detailed Description

Member Typedef Documentation

typedef std::vector<LODBucket*> Ogre::StaticGeometry::Region::LODBucketList

list of LOD Buckets in this region

Definition at line 352 of file OgreStaticGeometry.h.

typedef VectorIterator<LODBucketList> Ogre::StaticGeometry::Region::LODIterator

Definition at line 437 of file OgreStaticGeometry.h.

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.

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 417 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 423 of file OgreStaticGeometry.h.

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

Get the centre point of the region.

Definition at line 425 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().