OGRE  1.12.13
Object-Oriented Graphics Rendering Engine
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:

Public Types

typedef std::vector< LODBucket * > LODBucketList
 list of LOD Buckets in this region More...
 
typedef VectorIterator< LODBucketListLODIterator
 
- Public Types inherited from Ogre::ShadowCaster
typedef std::vector< ShadowRenderable * > ShadowRenderableList
 
typedef VectorIterator< ShadowRenderableListShadowRenderableListIterator
 

Public Member Functions

 Region (StaticGeometry *parent, const String &name, SceneManager *mgr, uint32 regionID, const Vector3 &centre)
 
virtual ~Region ()
 
void _notifyCurrentCamera (Camera *cam)
 Internal method to notify the object of the camera to be used for the next rendering operation. More...
 
void _releaseManualHardwareResources () override
 Notifies the movable object that hardware resources were lost. More...
 
void _restoreManualHardwareResources () override
 Notifies the movable object that hardware resources should be restored. More...
 
void _updateRenderQueue (RenderQueue *queue)
 Internal method by which the movable object must add Renderable subclass instances to the rendering queue. More...
 
void assign (QueuedSubMesh *qmesh)
 Assign a queued mesh to this region, read for final build. More...
 
void build (bool stencilShadows)
 Build this region. More...
 
void dump (std::ofstream &of) const
 Dump contents for diagnostics. More...
 
const AxisAlignedBoxgetBoundingBox (void) const
 Retrieves the local axis-aligned bounding box for this object. More...
 
Real getBoundingRadius (void) const
 Retrieves the radius of the origin-centered bounding sphere for this object. More...
 
const Vector3getCentre (void) const
 Get the centre point of the region. More...
 
EdgeDatagetEdgeList (void) override
 Returns details of the edges which might be used to determine a silhouette. More...
 
uint32 getID (void) const
 Get the region ID of this region. More...
 
const LODBucketListgetLODBuckets () const
 Get an list of the LODs in this region. More...
 
LODIterator getLODIterator (void)
 
const StringgetMovableType (void) const
 Returns the type name of this object. More...
 
StaticGeometrygetParent (void) const
 
const ShadowRenderableListgetShadowVolumeRenderableList (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, size_t *indexBufferUsedSize, bool extrudeVertices, Real extrusionDistance, unsigned long flags=0) override
 Define a default implementation of method from ShadowCaster which implements no shadows. More...
 
uint32 getTypeFlags (void) const
 Get the 'type flags' for this MovableObject. More...
 
bool isVisible (void) const
 Returns whether or not this object is supposed to be visible or not. More...
 
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. More...
 
- Public Member Functions inherited from Ogre::MovableObject
 MovableObject ()
 Constructor. More...
 
 MovableObject (const String &name)
 Named constructor. More...
 
virtual ~MovableObject ()
 Virtual destructor - read Scott Meyers if you don't know why this is needed. More...
 
MovableObjectFactory_getCreator (void) const
 Get the creator of this object, if any (internal use only) More...
 
LightList_getLightList ()
 Returns a pointer to the current list of lights for this object. More...
 
SceneManager_getManager (void) const
 Get the manager of this object, if any (internal use only) More...
 
virtual const Affine3_getParentNodeFullTransform (void) const
 Return the full transformation of the parent sceneNode or the attachingPoint node. More...
 
virtual void _notifyAttached (Node *parent, bool isTagPoint=false)
 Internal method called to notify the object that it has been attached to a node. More...
 
virtual void _notifyCreator (MovableObjectFactory *fact)
 Notify the object of it's creator (internal use only) More...
 
virtual void _notifyManager (SceneManager *man)
 Notify the object of it's manager (internal use only) More...
 
virtual void _notifyMoved (void)
 Internal method called to notify the object that it has been moved. More...
 
void addQueryFlags (uint32 flags)
 As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
 
void addVisibilityFlags (uint32 flags)
 As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
 
void detachFromParent (void)
 Detaches an object from a parent SceneNode or TagPoint, if attached. More...
 
Real getBoundingRadiusScaled () const
 as getBoundingRadius, but with scaling applied More...
 
bool getCastShadows (void) const
 Returns whether shadow casting is enabled for this object. More...
 
const AxisAlignedBoxgetDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const override
 Gets the world space bounding box of the dark cap, as extruded using the light provided. More...
 
const AxisAlignedBoxgetLightCapBounds (void) const override
 Gets the world space bounding box of the light cap. More...
 
uint32 getLightMask () const
 Get a bitwise mask which will filter the lights affecting this object. More...
 
ListenergetListener (void) const
 Gets the current listener for this object. More...
 
const StringgetName (void) const
 Returns the name of this object. More...
 
NodegetParentNode (void) const
 Returns the node to which this object is attached. More...
 
SceneNodegetParentSceneNode (void) const
 Returns the scene node to which this object is attached. More...
 
Real getPointExtrusionDistance (const Light *l) const
 Get the distance to extrude for a point/spot light. More...
 
virtual uint32 getQueryFlags (void) const
 Returns the query flags relevant for this object. More...
 
bool getReceivesShadows ()
 Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows. More...
 
Real getRenderingDistance (void) const
 Gets the distance at which batches are no longer rendered. More...
 
Real getRenderingMinPixelSize () const
 Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...
 
uint8 getRenderQueueGroup (void) const
 Gets the queue group for this entity. More...
 
const AnygetUserAny (void) const
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
virtual uint32 getVisibilityFlags (void) const
 Returns the visibility flags relevant for this object. More...
 
bool getVisible (void) const
 Gets this object whether to be visible or not, if it has a renderable component. More...
 
virtual const AxisAlignedBoxgetWorldBoundingBox (bool derive=false) const
 Retrieves the axis-aligned bounding box for this object in world coordinates. More...
 
virtual const SpheregetWorldBoundingSphere (bool derive=false) const
 Retrieves the worldspace bounding sphere for this object. More...
 
bool isAttached (void) const
 Returns true if this object is attached to a SceneNode or TagPoint. More...
 
bool isDebugDisplayEnabled (void) const
 Gets whether debug display of this object is enabled. More...
 
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. More...
 
bool isParentTagPoint () const
 Gets whether the parent node is a TagPoint (or a SceneNode) More...
 
const LightListqueryLights (void) const
 Gets a list of lights, ordered relative to how close they are to this movable object. More...
 
void removeQueryFlags (uint32 flags)
 As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
 
void removeVisibilityFlags (uint32 flags)
 As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
 
void setCastShadows (bool enabled)
 Sets whether or not this object will cast shadows. More...
 
void setDebugDisplayEnabled (bool enabled)
 Sets whether or not the debug display of this object is enabled. More...
 
void setLightMask (uint32 lightMask)
 Set a bitwise mask which will filter the lights affecting this object. More...
 
void setListener (Listener *listener)
 Sets a listener for this object. More...
 
void setQueryFlags (uint32 flags)
 Sets the query flags for this object. More...
 
void setRenderingDistance (Real dist)
 Sets the distance at which the object is no longer rendered. More...
 
void setRenderingMinPixelSize (Real pixelSize)
 Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...
 
virtual void setRenderQueueGroup (uint8 queueID)
 Sets the render queue group this entity will be rendered through. More...
 
virtual void setRenderQueueGroupAndPriority (uint8 queueID, ushort priority)
 Sets the render queue group and group priority this entity will be rendered through. More...
 
void setUserAny (const Any &anything)
 
void setVisibilityFlags (uint32 flags)
 Sets the visibility flags for this object. More...
 
void setVisible (bool visible)
 Tells this object whether to be visible or not, if it has a renderable component. More...
 
- Public Member Functions inherited from Ogre::ShadowCaster
virtual ~ShadowCaster ()
 
virtual ShadowRenderableListIterator getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, size_t *indexBufferUsedSize, bool extrudeVertices, Real extrusionDistance, unsigned long flags=0)
 
bool hasEdgeList ()
 Returns whether the object has a valid edge list. More...
 
- Public Member Functions inherited from Ogre::AnimableObject
 AnimableObject ()
 
virtual ~AnimableObject ()
 
virtual AnimableValuePtr createAnimableValue (const String &valueName)
 Create a reference-counted AnimableValuePtr for the named value. More...
 
const StringVectorgetAnimableValueNames (void) const
 Gets a list of animable value names for this object. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Ogre::MovableObject
static uint32 getDefaultQueryFlags ()
 Get the default query flags for all future MovableObject instances. More...
 
static uint32 getDefaultVisibilityFlags ()
 Get the default visibility flags for all future MovableObject instances. More...
 
static void setDefaultQueryFlags (uint32 flags)
 Set the default query flags for all future MovableObject instances. More...
 
static void setDefaultVisibilityFlags (uint32 flags)
 Set the default visibility flags for all future MovableObject instances. More...
 
- Static Public Member Functions inherited from Ogre::ShadowCaster
static void clearShadowRenderableList (ShadowRenderableList &shadowRenderables)
 Common implementation of releasing shadow renderables. More...
 
static void extrudeVertices (const HardwareVertexBufferSharedPtr &vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist)
 Utility method for extruding vertices based on a light. More...
 

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

Member Typedef Documentation

◆ LODBucketList

list of LOD Buckets in this region

◆ LODIterator

Constructor & Destructor Documentation

◆ Region()

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

◆ ~Region()

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

Member Function Documentation

◆ getParent()

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

◆ assign()

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

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

◆ build()

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

Build this region.

◆ getID()

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

Get the region ID of this region.

◆ getCentre()

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

Get the centre point of the region.

◆ getMovableType()

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

Returns the type name of this object.

Implements Ogre::MovableObject.

◆ _notifyCurrentCamera()

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.

◆ getBoundingBox()

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.

◆ getBoundingRadius()

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

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

Implements Ogre::MovableObject.

◆ _updateRenderQueue()

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.

◆ visitRenderables()

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
visitorPointer 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.
debugRenderablesIf false, only regular renderables will be visited (those for normal display). If true, debug renderables will be included too.

Implements Ogre::MovableObject.

◆ isVisible()

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.

◆ getTypeFlags()

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.

◆ getLODIterator()

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

◆ getLODBuckets()

const LODBucketList& Ogre::StaticGeometry::Region::getLODBuckets ( ) const
inline

Get an list of the LODs in this region.

◆ getShadowVolumeRenderableList()

const ShadowRenderableList& Ogre::StaticGeometry::Region::getShadowVolumeRenderableList ( ShadowTechnique  shadowTechnique,
const Light light,
HardwareIndexBufferSharedPtr indexBuffer,
size_t *  indexBufferUsedSize,
bool  extrudeVertices,
Real  extrusionDist,
unsigned long  flags = 0 
)
overridevirtual

Define a default implementation of method from ShadowCaster which implements no shadows.

Reimplemented from Ogre::MovableObject.

◆ getEdgeList()

EdgeData* Ogre::StaticGeometry::Region::getEdgeList ( void  )
overridevirtual

Returns details of the edges which might be used to determine a silhouette.

Reimplemented from Ogre::MovableObject.

◆ _releaseManualHardwareResources()

void Ogre::StaticGeometry::Region::_releaseManualHardwareResources ( )
overridevirtual

Notifies the movable object that hardware resources were lost.

Remarks
Called automatically by RenderSystem if hardware resources were lost and can not be restored using some internal mechanism. Among affected resources are nested shadow renderables, ManualObjects, etc.

Reimplemented from Ogre::MovableObject.

◆ _restoreManualHardwareResources()

void Ogre::StaticGeometry::Region::_restoreManualHardwareResources ( )
overridevirtual

Notifies the movable object that hardware resources should be restored.

Remarks
Called automatically by RenderSystem if hardware resources were lost and can not be restored using some internal mechanism. Among affected resources are nested shadow renderables, ManualObjects, etc.

Reimplemented from Ogre::MovableObject.

◆ dump()

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

Dump contents for diagnostics.


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