![]() |
OGRE 1.12.10
Object-Oriented Graphics Rendering Engine
|
A frustum represents a pyramid, capped at the near and far end which is used to represent either a visible area or a projection area. More...
#include <OgreFrustum.h>
Public Types | |
typedef Vector3 | Corners[8] |
![]() | |
typedef std::vector< ShadowRenderable * > | ShadowRenderableList |
typedef VectorIterator< ShadowRenderableList > | ShadowRenderableListIterator |
![]() | |
enum | { DEFAULT_PRIORITY = 100 } |
typedef SharedPtr< RenderSystemData > | RenderSystemDataPtr |
Public Member Functions | |
Frustum (const String &name=BLANKSTRING) | |
Named constructor. | |
virtual | ~Frustum () |
void | _notifyCurrentCamera (Camera *cam) override |
Internal method to notify the object of the camera to be used for the next rendering operation. | |
void | _updateRenderQueue (RenderQueue *queue) override |
Internal method by which the movable object must add Renderable subclass instances to the rendering queue. | |
void | calcViewMatrixRelative (const Vector3 &relPos, Matrix4 &matToUpdate) const |
Calculate a view matrix for this frustum, relative to a potentially dynamic point. | |
void | disableCustomNearClipPlane (void) |
Disables any custom near clip plane. | |
void | disableReflection (void) |
Disables reflection modification previously turned on with enableReflection. | |
void | enableCustomNearClipPlane (const MovablePlane *plane) |
Links the frustum to a custom near clip plane, which can be used to clip geometry in a custom manner without using user clip planes. | |
void | enableCustomNearClipPlane (const Plane &plane) |
Links the frustum to a custom near clip plane, which can be used to clip geometry in a custom manner without using user clip planes. | |
void | enableReflection (const MovablePlane *p) |
Modifies this frustum so it always renders from the reflection of itself through the plane specified. | |
void | enableReflection (const Plane &p) |
Modifies this frustum so it always renders from the reflection of itself through the plane specified. | |
Real | getAspectRatio (void) const |
Retrieves the current aspect ratio. | |
const AxisAlignedBox & | getBoundingBox (void) const override |
Retrieves the local axis-aligned bounding box for this object. | |
Real | getBoundingRadius (void) const override |
Retrieves the radius of the origin-centered bounding sphere for this object. | |
const ColourValue & | getDebugColour () const |
Real | getFarClipDistance (void) const |
Retrieves the distance from the frustum to the far clipping plane. | |
Real | getFocalLength () const |
Returns focal length of frustum. | |
const Radian & | getFOVy (void) const |
Retrieves the frustums Y-dimension Field Of View (FOV). | |
RealRect | getFrustumExtents () const |
Get the extents of the frustum in view space. | |
void | getFrustumExtents (Real &outleft, Real &outright, Real &outtop, Real &outbottom) const |
const Vector2 & | getFrustumOffset () const |
Retrieves the frustum offsets. | |
virtual const Plane & | getFrustumPlane (unsigned short plane) const |
Retrieves a specified plane of the frustum (world space). | |
virtual const Plane * | getFrustumPlanes (void) const |
Retrieves the clipping planes of the frustum (world space). | |
const LightList & | getLights (void) const override |
Gets a list of lights, ordered relative to how close they are to this renderable. | |
const MaterialPtr & | getMaterial (void) const override |
Retrieves a weak reference to the material this renderable object uses. | |
const String & | getMovableType (void) const override |
Returns the type name of this object. | |
Real | getNearClipDistance (void) const |
Sets the position of the near clipping plane. | |
virtual const Quaternion & | getOrientationForViewUpdate (void) const |
Get the derived orientation of this frustum. | |
OrientationMode | getOrientationMode () const |
Get the orientation mode of the frustum. | |
Real | getOrthoWindowHeight () const |
Gets the orthographic window height, for use with orthographic rendering only. | |
Real | getOrthoWindowWidth () const |
Gets the orthographic window width, for use with orthographic rendering only. | |
PlaneBoundedVolume | getPlaneBoundedVolume () |
Gets a world-space list of planes enclosing the frustum. | |
virtual const Vector3 & | getPositionForViewUpdate (void) const |
Get the derived position of this frustum. | |
const Matrix4 & | getProjectionMatrix (void) const |
Gets the normal projection matrix for this frustum, ie the projection matrix which conforms to standard right-handed rules and uses depth range [-1,+1]. | |
const Matrix4 & | getProjectionMatrixRS (void) const |
Gets the projection matrix for this frustum adjusted for the current rendersystem specifics (may be right or left-handed, depth range may vary). | |
const Matrix4 & | getProjectionMatrixWithRSDepth (void) const |
Gets the depth-adjusted projection matrix for the current rendersystem, but one which still conforms to right-hand rules. | |
ProjectionType | getProjectionType (void) const |
Retrieves info on the type of projection used (orthographic or perspective). | |
const Affine3 & | getReflectionMatrix (void) const |
Returns the reflection matrix of the frustum if appropriate. | |
const Plane & | getReflectionPlane (void) const |
Returns the reflection plane of the frustum if appropriate. | |
void | getRenderOperation (RenderOperation &op) override |
Gets the render operation required to send this object to the frame buffer. | |
Real | getSquaredViewDepth (const Camera *cam) const override |
Returns the camera-relative squared depth of this renderable. | |
uint32 | getTypeFlags (void) const override |
Get the 'type flags' for this MovableObject. | |
const Affine3 & | getViewMatrix (void) const |
Gets the view matrix for this frustum. | |
virtual const Corners & | getWorldSpaceCorners (void) const |
Gets the world space corners of the frustum. | |
void | getWorldTransforms (Matrix4 *xform) const override |
Gets the world transform matrix / matrices for this renderable object. | |
bool | isCustomNearClipPlaneEnabled (void) const |
Is a custom near clip plane in use? | |
bool | isCustomProjectionMatrixEnabled (void) const |
Returns whether a custom projection matrix is in use. | |
bool | isCustomViewMatrixEnabled (void) const |
Returns whether a custom view matrix is in use. | |
bool | isReflected (void) const |
Returns whether this frustum is being reflected. | |
virtual bool | isVisible (const AxisAlignedBox &bound, FrustumPlane *culledBy=0) const |
Tests whether the given container is visible in the Frustum. | |
virtual bool | isVisible (const Sphere &bound, FrustumPlane *culledBy=0) const |
Tests whether the given container is visible in the Frustum. | |
virtual bool | isVisible (const Vector3 &vert, FrustumPlane *culledBy=0) const |
Tests whether the given vertex is visible in the Frustum. | |
virtual bool | projectSphere (const Sphere &sphere, Real *left, Real *top, Real *right, Real *bottom) const |
Project a sphere onto the near plane and get the bounding rectangle. | |
void | resetFrustumExtents () |
Reset the frustum extents to be automatically derived from other params. | |
void | setAspectRatio (Real ratio) |
Sets the aspect ratio for the frustum viewport. | |
void | setCustomProjectionMatrix (bool enable, const Matrix4 &projectionMatrix=Matrix4::IDENTITY) |
Set whether to use a custom projection matrix on this frustum. | |
void | setCustomViewMatrix (bool enable, const Affine3 &viewMatrix=Affine3::IDENTITY) |
Set whether to use a custom view matrix on this frustum. | |
void | setDebugColour (const ColourValue &col) |
void | setFarClipDistance (Real farDist) |
Sets the distance to the far clipping plane. | |
void | setFocalLength (Real focalLength=1.0) |
Sets frustum focal length (used in stereo rendering). | |
void | setFOVy (const Radian &fovy) |
Sets the Y-dimension Field Of View (FOV) of the frustum. | |
void | setFrustumExtents (Real left, Real right, Real top, Real bottom) |
Manually set the extents of the frustum. | |
void | setFrustumOffset (const Vector2 &offset) |
Sets frustum offsets, used in stereo rendering. | |
void | setFrustumOffset (Real horizontal=0.0, Real vertical=0.0) |
Sets frustum offsets, used in stereo rendering. | |
void | setMaterial (const MaterialPtr &mat) |
void | setNearClipDistance (Real nearDist) |
Sets the position of the near clipping plane. | |
void | setOrientationMode (OrientationMode orientationMode) |
Set the orientation mode of the frustum. | |
void | setOrthoWindow (Real w, Real h) |
Sets the orthographic window settings, for use with orthographic rendering only. | |
void | setOrthoWindowHeight (Real h) |
Sets the orthographic window height, for use with orthographic rendering only. | |
void | setOrthoWindowWidth (Real w) |
Sets the orthographic window width, for use with orthographic rendering only. | |
virtual void | setProjectionType (ProjectionType pt) |
Sets the type of projection to use (orthographic or perspective). | |
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. | |
virtual void | _releaseManualHardwareResources () |
Notifies the movable object that hardware resources were lost. | |
virtual void | _restoreManualHardwareResources () |
Notifies the movable object that hardware resources should be restored. | |
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. | |
EdgeData * | getEdgeList (void) |
Returns details of the edges which might be used to determine a silhouette. | |
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 ShadowRenderableList & | getShadowVolumeRenderableList (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, size_t *indexBufferUsedSize, bool extrudeVertices, Real extrusionDist, unsigned long flags=0) |
Define a default implementation of method from ShadowCaster which implements no shadows. | |
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) | |
virtual bool | isVisible (void) const |
Returns whether or not this object is supposed to be visible or not. | |
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. | |
![]() | |
Renderable () | |
virtual | ~Renderable () |
Virtual destructor needed as class has virtual methods. | |
virtual void | _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const |
Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows. | |
virtual bool | getCastsShadows (void) const |
Method which reports whether this renderable would normally cast a shadow. | |
const Vector4 & | getCustomParameter (size_t index) const |
Gets the custom value associated with this Renderable at the given index. | |
virtual unsigned short | getNumWorldTransforms (void) const |
Returns the number of world transform matrices this renderable requires. | |
bool | getPolygonModeOverrideable (void) const |
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. | |
const RenderSystemDataPtr & | getRenderSystemData () const |
virtual Technique * | getTechnique (void) const |
Retrieves a pointer to the Material Technique this renderable object uses. | |
bool | getUseIdentityProjection (void) const |
Returns whether or not to use an 'identity' projection. | |
bool | getUseIdentityView (void) const |
Returns whether or not to use an 'identity' view. | |
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. | |
bool | hasCustomParameter (size_t index) const |
Checks whether a custom value is associated with this Renderable at the given index. | |
virtual void | postRender (SceneManager *sm, RenderSystem *rsys) |
Called immediately after the Renderable has been rendered. | |
virtual bool | preRender (SceneManager *sm, RenderSystem *rsys) |
Called just prior to the Renderable being rendered. | |
void | removeCustomParameter (size_t index) |
Removes a custom value which is associated with this Renderable at the given index. | |
void | setCustomParameter (size_t index, const Vector4 &value) |
Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters. | |
void | setPolygonModeOverrideable (bool override) |
Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. | |
void | setRenderSystemData (RenderSystemDataPtr val) const |
void | setUseIdentityProjection (bool useIdentityProjection) |
Sets whether or not to use an 'identity' projection. | |
void | setUseIdentityView (bool useIdentityView) |
Sets whether or not to use an 'identity' view. | |
void | setUserAny (const Any &anything) |
Static Public Attributes | |
static const Real | INFINITE_FAR_PLANE_ADJUST |
Small constant used to reduce far plane projection to avoid inaccuracies. | |
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. | |
A frustum represents a pyramid, capped at the near and far end which is used to represent either a visible area or a projection area.
Can be used for a number of applications.
Ogre::Frustum::Frustum | ( | const String & | name = BLANKSTRING | ) |
Named constructor.
|
virtual |
Sets the Y-dimension Field Of View (FOV) of the frustum.
Retrieves the frustums Y-dimension Field Of View (FOV).
Sets the position of the near clipping plane.
nearDist | The distance to the near clipping plane from the frustum in world coordinates. |
Sets the position of the near clipping plane.
Sets the distance to the far clipping plane.
farDist | The distance to the far clipping plane from the frustum in world coordinates.If you specify 0, this means an infinite view distance which is useful especially when projecting shadows; but be careful not to use a near distance too close. |
Retrieves the distance from the frustum to the far clipping plane.
Sets the aspect ratio for the frustum viewport.
Sets frustum offsets, used in stereo rendering.
offset | The horizontal and vertical plane offsets. |
Sets frustum offsets, used in stereo rendering.
horizontal | The horizontal plane offset. |
vertical | The vertical plane offset. |
Sets frustum focal length (used in stereo rendering).
focalLength | The distance to the focal plane from the frustum in world coordinates. |
Real Ogre::Frustum::getFocalLength | ( | ) | const |
Returns focal length of frustum.
Manually set the extents of the frustum.
left,right,top,bottom | The position where the side clip planes intersect the near clip plane, in eye space |
void Ogre::Frustum::resetFrustumExtents | ( | ) |
Reset the frustum extents to be automatically derived from other params.
RealRect Ogre::Frustum::getFrustumExtents | ( | ) | const |
Get the extents of the frustum in view space.
void Ogre::Frustum::getFrustumExtents | ( | Real & | outleft, |
Real & | outright, | ||
Real & | outtop, | ||
Real & | outbottom | ||
) | const |
Gets the projection matrix for this frustum adjusted for the current rendersystem specifics (may be right or left-handed, depth range may vary).
Gets the depth-adjusted projection matrix for the current rendersystem, but one which still conforms to right-hand rules.
Gets the normal projection matrix for this frustum, ie the projection matrix which conforms to standard right-handed rules and uses depth range [-1,+1].
Gets the view matrix for this frustum.
Mainly for use by OGRE internally.
Calculate a view matrix for this frustum, relative to a potentially dynamic point.
Mainly for use by OGRE internally when using camera-relative rendering for frustums that are not the centre (e.g. texture projection)
void Ogre::Frustum::setCustomViewMatrix | ( | bool | enable, |
const Affine3 & | viewMatrix = Affine3::IDENTITY |
||
) |
Set whether to use a custom view matrix on this frustum.
enable | If true , the custom view matrix passed as the second parameter will be used in preference to an auto calculated one. If false, the frustum will revert to auto calculating the view matrix. |
viewMatrix | The custom view matrix to use |
Returns whether a custom view matrix is in use.
void Ogre::Frustum::setCustomProjectionMatrix | ( | bool | enable, |
const Matrix4 & | projectionMatrix = Matrix4::IDENTITY |
||
) |
Set whether to use a custom projection matrix on this frustum.
enable | If true , the custom projection matrix passed as the second parameter will be used in preference to an auto calculated one. If false , the frustum will revert to auto calculating the projection matrix. |
projectionMatrix | The custom view matrix to use. |
Returns whether a custom projection matrix is in use.
Retrieves the clipping planes of the frustum (world space).
Retrieves a specified plane of the frustum (world space).
Reimplemented in Ogre::Camera.
|
virtual |
Tests whether the given container is visible in the Frustum.
bound | Bounding box to be checked (world space). |
culledBy | Optional pointer to an int which will be filled by the plane number which culled the box if the result was false ; |
true
is returned. false
is returned. Reimplemented in Ogre::Camera, and Ogre::PCZCamera.
|
virtual |
Tests whether the given container is visible in the Frustum.
bound | Bounding sphere to be checked (world space). |
culledBy | Optional pointer to an int which will be filled by the plane number which culled the box if the result was false ; |
true
is returned. false
is returned. Reimplemented in Ogre::Camera.
|
virtual |
Tests whether the given vertex is visible in the Frustum.
vert | Vertex to be checked (world space). |
culledBy | Optional pointer to an int which will be filled by the plane number which culled the box if the result was false ; |
true
is returned. false
is returned. Reimplemented in Ogre::Camera.
Get the 'type flags' for this MovableObject.
Reimplemented from Ogre::MovableObject.
|
overridevirtual |
Retrieves the local axis-aligned bounding box for this object.
Implements Ogre::MovableObject.
Reimplemented in Ogre::PCZCamera.
Retrieves the radius of the origin-centered bounding sphere for this object.
Implements Ogre::MovableObject.
|
overridevirtual |
Internal method by which the movable object must add Renderable subclass instances to the rendering queue.
Implements Ogre::MovableObject.
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.
void Ogre::Frustum::setMaterial | ( | const MaterialPtr & | mat | ) |
|
inline |
|
inline |
|
overridevirtual |
Retrieves a weak reference to the material this renderable object uses.
Implements Ogre::Renderable.
|
overridevirtual |
Gets the render operation required to send this object to the frame buffer.
Implements Ogre::Renderable.
Gets the world transform matrix / matrices for this renderable object.
Implements Ogre::Renderable.
Returns the camera-relative squared depth of this renderable.
Implements Ogre::Renderable.
Gets a list of lights, ordered relative to how close they are to this renderable.
Implements Ogre::Renderable.
Gets the world space corners of the frustum.
Reimplemented in Ogre::Camera.
|
virtual |
Sets the type of projection to use (orthographic or perspective).
Default is perspective.
Reimplemented in Ogre::PCZCamera.
ProjectionType Ogre::Frustum::getProjectionType | ( | void | ) | const |
Retrieves info on the type of projection used (orthographic or perspective).
Sets the orthographic window settings, for use with orthographic rendering only.
w | The width of the view window in world units. |
h | The height of the view window in world units. |
Sets the orthographic window height, for use with orthographic rendering only.
h | The height of the view window in world units. |
Sets the orthographic window width, for use with orthographic rendering only.
w | The width of the view window in world units. |
Real Ogre::Frustum::getOrthoWindowHeight | ( | ) | const |
Gets the orthographic window height, for use with orthographic rendering only.
Real Ogre::Frustum::getOrthoWindowWidth | ( | ) | const |
Gets the orthographic window width, for use with orthographic rendering only.
Modifies this frustum so it always renders from the reflection of itself through the plane specified.
void Ogre::Frustum::enableReflection | ( | const MovablePlane * | p | ) |
Modifies this frustum so it always renders from the reflection of itself through the plane specified.
Note that this version of the method links to a plane so that changes to it are picked up automatically. It is important that this plane continues to exist whilst this object does; do not destroy the plane before the frustum.
Disables reflection modification previously turned on with enableReflection.
Returns whether this frustum is being reflected.
Returns the reflection matrix of the frustum if appropriate.
Returns the reflection plane of the frustum if appropriate.
|
virtual |
Project a sphere onto the near plane and get the bounding rectangle.
sphere | The world-space sphere to project. |
left | Pointers to destination values, these will be completed with the normalised device coordinates (in the range {-1,1}). |
top | Pointers to destination values, these will be completed with the normalised device coordinates (in the range {-1,1}). |
right | Pointers to destination values, these will be completed with the normalised device coordinates (in the range {-1,1}). |
bottom | Pointers to destination values, these will be completed with the normalised device coordinates (in the range {-1,1}). |
true
if the sphere was projected to a subset of the near plane, false
if the entire near plane was contained. Reimplemented in Ogre::Camera.
void Ogre::Frustum::enableCustomNearClipPlane | ( | const MovablePlane * | plane | ) |
Links the frustum to a custom near clip plane, which can be used to clip geometry in a custom manner without using user clip planes.
plane | The plane to link to to perform the clipping. This plane must continue to exist while the camera is linked to it; do not destroy it before the frustum. |
Links the frustum to a custom near clip plane, which can be used to clip geometry in a custom manner without using user clip planes.
plane | The plane to link to to perform the clipping. This plane must continue to exist while the camera is linked to it; do not destroy it before the frustum. |
Is a custom near clip plane in use?
|
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.
Get the derived position of this frustum.
Reimplemented in Ogre::Camera.
|
virtual |
Get the derived orientation of this frustum.
Reimplemented in Ogre::Camera.
PlaneBoundedVolume Ogre::Frustum::getPlaneBoundedVolume | ( | ) |
Gets a world-space list of planes enclosing the frustum.
void Ogre::Frustum::setOrientationMode | ( | OrientationMode | orientationMode | ) |
Set the orientation mode of the frustum.
Default is OR_DEGREE_0
OrientationMode Ogre::Frustum::getOrientationMode | ( | ) | const |
Get the orientation mode of the frustum.
Small constant used to reduce far plane projection to avoid inaccuracies.