![]() |
OGRE 1.12.10
Object-Oriented Graphics Rendering Engine
|
The details of a topological region which is the highest level of partitioning for this class. More...
#include <OgreStaticGeometry.h>
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 ¢re) | |
virtual | ~Region () |
void | _notifyCurrentCamera (Camera *cam) |
Internal method to notify the object of the camera to be used for the next rendering operation. | |
void | _releaseManualHardwareResources () override |
Notifies the movable object that hardware resources were lost. | |
void | _restoreManualHardwareResources () override |
Notifies the movable object that hardware resources should be restored. | |
void | _updateRenderQueue (RenderQueue *queue) |
Internal method by which the movable object must add Renderable subclass instances to the rendering queue. | |
void | assign (QueuedSubMesh *qmesh) |
Assign a queued mesh to this region, read for final build. | |
void | build (bool stencilShadows) |
Build this region. | |
void | dump (std::ofstream &of) const |
Dump contents for diagnostics. | |
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. | |
const Vector3 & | getCentre (void) const |
Get the centre point of the region. | |
EdgeData * | getEdgeList (void) override |
Returns details of the edges which might be used to determine a silhouette. | |
uint32 | getID (void) const |
Get the region ID of this region. | |
const LODBucketList & | getLODBuckets () const |
Get an list of the LODs in this region. | |
LODIterator | getLODIterator (void) |
const String & | getMovableType (void) const |
Returns the type name of this object. | |
StaticGeometry * | getParent (void) const |
const ShadowRenderableList & | getShadowVolumeRenderableList (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. | |
uint32 | getTypeFlags (void) const |
Get the 'type flags' for this MovableObject. | |
bool | isVisible (void) const |
Returns whether or not this object is supposed to be visible or not. | |
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. | |
![]() | |
MovableObject () | |
Constructor. | |
MovableObject (const String &name) | |
Named constructor. | |
virtual | ~MovableObject () |
Virtual destructor - read Scott Meyers if you don't know why this is needed. | |
MovableObjectFactory * | _getCreator (void) const |
Get the creator of this object, if any (internal use only) | |
LightList * | _getLightList () |
Returns a pointer to the current list of lights for this object. | |
SceneManager * | _getManager (void) const |
Get the manager of this object, if any (internal use only) | |
virtual const Affine3 & | _getParentNodeFullTransform (void) const |
Return the full transformation of the parent sceneNode or the attachingPoint node. | |
virtual void | _notifyAttached (Node *parent, bool isTagPoint=false) |
Internal method called to notify the object that it has been attached to a node. | |
virtual void | _notifyCreator (MovableObjectFactory *fact) |
Notify the object of it's creator (internal use only) | |
virtual void | _notifyManager (SceneManager *man) |
Notify the object of it's manager (internal use only) | |
virtual void | _notifyMoved (void) |
Internal method called to notify the object that it has been moved. | |
void | addQueryFlags (uint32 flags) |
As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. | |
void | addVisibilityFlags (uint32 flags) |
As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. | |
void | detachFromParent (void) |
Detaches an object from a parent SceneNode or TagPoint, if attached. | |
Real | getBoundingRadiusScaled () const |
as getBoundingRadius, but with scaling applied | |
bool | getCastShadows (void) const |
Returns whether shadow casting is enabled for this object. | |
const AxisAlignedBox & | getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const override |
Gets the world space bounding box of the dark cap, as extruded using the light provided. | |
const AxisAlignedBox & | getLightCapBounds (void) const override |
Gets the world space bounding box of the light cap. | |
uint32 | getLightMask () const |
Get a bitwise mask which will filter the lights affecting this object. | |
Listener * | getListener (void) const |
Gets the current listener for this object. | |
const String & | getName (void) const |
Returns the name of this object. | |
Node * | getParentNode (void) const |
Returns the node to which this object is attached. | |
SceneNode * | getParentSceneNode (void) const |
Returns the scene node to which this object is attached. | |
Real | getPointExtrusionDistance (const Light *l) const |
Get the distance to extrude for a point/spot light. | |
virtual uint32 | getQueryFlags (void) const |
Returns the query flags relevant 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 | getRenderingDistance (void) const |
Gets the distance at which batches are no longer rendered. | |
Real | getRenderingMinPixelSize () const |
Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered. | |
uint8 | getRenderQueueGroup (void) const |
Gets the queue group for this entity. | |
const Any & | getUserAny (void) const |
UserObjectBindings & | getUserObjectBindings () |
Return an instance of user objects binding associated with this class. | |
const UserObjectBindings & | getUserObjectBindings () const |
Return an instance of user objects binding associated with this class. | |
virtual uint32 | getVisibilityFlags (void) const |
Returns the visibility flags relevant for this object. | |
bool | getVisible (void) const |
Gets this object whether to be visible or not, if it has a renderable component. | |
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. | |
bool | isAttached (void) const |
Returns true if this object is attached to a SceneNode or TagPoint. | |
bool | isDebugDisplayEnabled (void) const |
Gets whether debug display of this object is enabled. | |
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. | |
bool | isParentTagPoint () const |
Gets whether the parent node is a TagPoint (or a SceneNode) | |
const LightList & | queryLights (void) const |
Gets a list of lights, ordered relative to how close they are to this movable object. | |
void | removeQueryFlags (uint32 flags) |
As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. | |
void | removeVisibilityFlags (uint32 flags) |
As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object. | |
void | setCastShadows (bool enabled) |
Sets whether or not this object will cast shadows. | |
void | setDebugDisplayEnabled (bool enabled) |
Sets whether or not the debug display of this object is enabled. | |
void | setLightMask (uint32 lightMask) |
Set a bitwise mask which will filter the lights affecting this object. | |
void | setListener (Listener *listener) |
Sets a listener for this object. | |
void | setQueryFlags (uint32 flags) |
Sets the query flags for this object. | |
void | setRenderingDistance (Real dist) |
Sets the distance at which the object is no longer rendered. | |
void | setRenderingMinPixelSize (Real pixelSize) |
Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered. | |
virtual void | setRenderQueueGroup (uint8 queueID) |
Sets the render queue group this entity will be rendered through. | |
virtual void | setRenderQueueGroupAndPriority (uint8 queueID, ushort priority) |
Sets the render queue group and group priority this entity will be rendered through. | |
void | setUserAny (const Any &anything) |
void | setVisibilityFlags (uint32 flags) |
Sets the visibility flags for this object. | |
void | setVisible (bool visible) |
Tells this object whether to be visible or not, if it has a renderable component. | |
![]() | |
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. | |
![]() | |
AnimableObject () | |
virtual | ~AnimableObject () |
virtual AnimableValuePtr | createAnimableValue (const String &valueName) |
Create a reference-counted AnimableValuePtr for the named value. | |
const StringVector & | getAnimableValueNames (void) const |
Gets a list of animable value names for this object. | |
Additional Inherited Members | |
![]() | |
static uint32 | getDefaultQueryFlags () |
Get the default query flags for all future MovableObject instances. | |
static uint32 | getDefaultVisibilityFlags () |
Get the default visibility flags for all future MovableObject instances. | |
static void | setDefaultQueryFlags (uint32 flags) |
Set 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 void | clearShadowRenderableList (ShadowRenderableList &shadowRenderables) |
Common implementation of releasing shadow renderables. | |
static void | extrudeVertices (const HardwareVertexBufferSharedPtr &vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist) |
Utility method for extruding vertices based on a light. | |
The details of a topological region which is the highest level of partitioning for this class.
typedef std::vector<LODBucket*> Ogre::StaticGeometry::Region::LODBucketList |
list of LOD Buckets in this region
Ogre::StaticGeometry::Region::Region | ( | StaticGeometry * | parent, |
const String & | name, | ||
SceneManager * | mgr, | ||
uint32 | regionID, | ||
const Vector3 & | centre | ||
) |
|
virtual |
|
inline |
void Ogre::StaticGeometry::Region::assign | ( | QueuedSubMesh * | qmesh | ) |
Assign a queued mesh to this region, read for final build.
Get the centre point of the region.
Returns the type name of this object.
Implements Ogre::MovableObject.
Internal method to notify the object of the camera to be used for the next rendering operation.
Reimplemented from Ogre::MovableObject.
|
virtual |
Retrieves the local axis-aligned bounding box for this object.
Implements Ogre::MovableObject.
Retrieves the radius of the origin-centered bounding sphere for this object.
Implements Ogre::MovableObject.
|
virtual |
Internal method by which the movable object must add Renderable subclass instances to the rendering queue.
Implements Ogre::MovableObject.
|
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.
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.
Returns whether or not this object is supposed to be visible or not.
Reimplemented from Ogre::MovableObject.
Get the 'type flags' for this MovableObject.
Reimplemented from Ogre::MovableObject.
LODIterator Ogre::StaticGeometry::Region::getLODIterator | ( | void | ) |
|
inline |
Get an list of the LODs in this region.
|
overridevirtual |
Define a default implementation of method from ShadowCaster which implements no shadows.
Reimplemented from Ogre::MovableObject.
Returns details of the edges which might be used to determine a silhouette.
Reimplemented from Ogre::MovableObject.
|
overridevirtual |
Notifies the movable object that hardware resources were lost.
Reimplemented from Ogre::MovableObject.
|
overridevirtual |
Notifies the movable object that hardware resources should be restored.
Reimplemented from Ogre::MovableObject.
void Ogre::StaticGeometry::Region::dump | ( | std::ofstream & | of | ) | const |
Dump contents for diagnostics.