# Ogre::Frustum Class Reference

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

Inheritance diagram for Ogre::Frustum:

[legend]

List of all members.

## Public Types

typedef std::vector < ShadowRenderable * > | ShadowRenderableList
typedef VectorIterator < ShadowRenderableList > | ShadowRenderableListIterator

## Public Member Functions

| Frustum ()
virtual | ~Frustum ()
virtual void | setFOVy (const Radian &fovy)
| Sets the Y-dimension Field Of View (FOV) of the frustum.
virtual const Radian & | getFOVy (void) const
| Retrieves the frustums Y-dimension Field Of View (FOV).
virtual void | setNearClipDistance (Real nearDist)
| Sets the position of the near clipping plane.
virtual Real | getNearClipDistance (void) const
| Sets the position of the near clipping plane.
virtual void | setFarClipDistance (Real farDist)
| Sets the distance to the far clipping plane.
virtual Real | getFarClipDistance (void) const
| Retrieves the distance from the frustum to the far clipping plane.
virtual void | setAspectRatio (Real ratio)
| Sets the aspect ratio for the frustum viewport.
virtual Real | getAspectRatio (void) const
| Retreives the current aspect ratio.
virtual void | setFrustumOffset (const Vector2 &offset)
| Sets frustum offsets, used in stereo rendering.
virtual void | setFrustumOffset (Real horizontal=0.0, Real vertical=0.0)
| Sets frustum offsets, used in stereo rendering.
virtual const Vector2 & | getFrustumOffset () const
| Retrieves the frustum offsets.
virtual void | setFocalLength (Real focalLength=1.0)
| Sets frustum focal length (used in stereo rendering).
virtual Real | getFocalLength () const
| Returns focal length of frustum.
virtual void | setFrustumExtents (Real left, Real right, Real top, Real bottom)
| Manually set the extents of the frustum.
virtual void | resetFrustumExtents ()
| Reset the frustum extents to be automatically derived from other params.
virtual void | getFrustumExtents (Real &outleft, Real &outright, Real &outtop, Real &outbottom) const
| Get the extents of the frustum in view space.
virtual 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).
virtual const Matrix4 & | getProjectionMatrixWithRSDepth (void) const
| Gets the depth-adjusted projection matrix for the current rendersystem, but one which still conforms to right-hand rules.
virtual 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].
virtual const Matrix4 & | getViewMatrix (void) const
| Gets the view matrix for this frustum.
virtual void | calcViewMatrixRelative (const Vector3 &relPos, Matrix4 &matToUpdate) const
| Calculate a view matrix for this frustum, relative to a potentially dynamic point.
virtual void | setCustomViewMatrix (bool enable, const Matrix4 &viewMatrix=Matrix4::IDENTITY)
| Set whether to use a custom view matrix on this frustum.
virtual bool | isCustomViewMatrixEnabled (void) const
| Returns whether a custom view matrix is in use.
virtual void | setCustomProjectionMatrix (bool enable, const Matrix4 &projectionMatrix=Matrix4::IDENTITY)
| Set whether to use a custom projection matrix on this frustum.
virtual bool | isCustomProjectionMatrixEnabled (void) const
| Returns whether a custom projection matrix is in use.
virtual const Plane * | getFrustumPlanes (void) const
| Retrieves the clipping planes of the frustum (world space).
virtual const Plane & | getFrustumPlane (unsigned short plane) const
| Retrieves a specified plane of the frustum (world space).
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.
uint32 | getTypeFlags (void) const
| Overridden from MovableObject::getTypeFlags.
const AxisAlignedBox & | getBoundingBox (void) const
| Overridden from MovableObject.
Real | getBoundingRadius (void) const
| Overridden from MovableObject.
void | _updateRenderQueue (RenderQueue *queue)
| Overridden from MovableObject.
const String & | getMovableType (void) const
| Overridden from MovableObject.
void | _notifyCurrentCamera (Camera *cam)
| Overridden from MovableObject.
const MaterialPtr & | getMaterial (void) const
| Overridden from Renderable.
void | getRenderOperation (RenderOperation &op)
| Overridden from Renderable.
void | getWorldTransforms (Matrix4 *xform) const
| Overridden from Renderable.
Real | getSquaredViewDepth (const Camera *cam) const
| Overridden from Renderable.
const LightList & | getLights (void) const
| Overridden from Renderable.
virtual const Vector3 * | getWorldSpaceCorners (void) const
| Gets the world space corners of the frustum.
virtual void | setProjectionType (ProjectionType pt)
| Sets the type of projection to use (orthographic or perspective).
virtual ProjectionType | getProjectionType (void) const
| Retrieves info on the type of projection used (orthographic or perspective).
virtual void | setOrthoWindow (Real w, Real h)
| Sets the orthographic window settings, for use with orthographic rendering only.
virtual void | setOrthoWindowHeight (Real h)
| Sets the orthographic window height, for use with orthographic rendering only.
virtual void | setOrthoWindowWidth (Real w)
| Sets the orthographic window width, for use with orthographic rendering only.
virtual Real | getOrthoWindowHeight () const
| Gets the orthographic window height, for use with orthographic rendering only.
virtual Real | getOrthoWindowWidth () const
| Gets the orthographic window width, for use with orthographic rendering only.
virtual void | enableReflection (const Plane &p)
| Modifies this frustum so it always renders from the reflection of itself through the plane specified.
virtual void | enableReflection (const MovablePlane *p)
| Modifies this frustum so it always renders from the reflection of itself through the plane specified.
virtual void | disableReflection (void)
| Disables reflection modification previously turned on with enableReflection.
virtual bool | isReflected (void) const
| Returns whether this frustum is being reflected.
virtual const Matrix4 & | getReflectionMatrix (void) const
| Returns the reflection matrix of the frustum if appropriate.
virtual const Plane & | getReflectionPlane (void) const
| Returns the reflection plane of the frustum if appropriate.
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.
virtual 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.
virtual 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.
virtual void | disableCustomNearClipPlane (void)
| Disables any custom near clip plane.
virtual bool | isCustomNearClipPlaneEnabled (void) const
| Is a custom near clip plane in use?
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.

virtual const Vector3 & | getPositionForViewUpdate (void) const
| Get the derived position of this frustum.
virtual const Quaternion & | getOrientationForViewUpdate (void) const
| Get the derived orientation of this frustum.
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 bool | isVisible (void) const
| Returns whether or not this object is supposed to be visible or not.
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.
EdgeData * | getEdgeList (void)
| Define a default implementation of method from ShadowCaster which implements no shadows.
bool | hasEdgeList (void)
| Define a default implementation of method from ShadowCaster which implements no shadows.
ShadowRenderableListIterator | getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, bool extrudeVertices, Real extrusionDist, unsigned long flags=0)
| Define a default implementation of method from ShadowCaster which implements no shadows.
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.
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 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, 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 *)
virtual Technique * | getTechnique (void) const
| Retrieves a pointer to the Material Technique this renderable object uses.
virtual bool | preRender (SceneManager *sm, RenderSystem *rsys)
| Called just prior to the Renderable being rendered.
virtual void | postRender (SceneManager *sm, RenderSystem *rsys)
| Called immediately after the Renderable has been rendered.
virtual unsigned short | getNumWorldTransforms (void) const
| Returns the number of world transform matrices this renderable requires.
void | setUseIdentityProjection (bool useIdentityProjection)
| Sets whether or not to use an 'identity' projection.
bool | getUseIdentityProjection (void) const
| Returns whether or not to use an 'identity' projection.
void | setUseIdentityView (bool useIdentityView)
| Sets whether or not to use an 'identity' view.
bool | getUseIdentityView (void) const
| Returns whether or not to use an 'identity' view.
virtual bool | getCastsShadows (void) const
| Method which reports whether this renderable would normally cast a shadow.
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.
const Vector4 & | getCustomParameter (size_t index) const
| Gets the custom value associated with this Renderable at the given index.
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 void | setPolygonModeOverrideable (bool override)
| Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
virtual bool | getPolygonModeOverrideable (void) const
| Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
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 RenderSystemData * | getRenderSystemData () const
| Sets render system private data.
virtual void | setRenderSystemData (RenderSystemData *val) const
| gets render system private data

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

## Static Public Attributes

static const Real | INFINITE_FAR_PLANE_ADJUST
| Small constant used to reduce far plane projection to avoid inaccuracies.

## Protected Types

typedef std::map< String, StringVector > | AnimableDictionaryMap
typedef std::map< size_t, Vector4 > | CustomParameterMap

## Protected Member Functions

virtual void | calcProjectionParameters (Real &left, Real &right, Real &bottom, Real &top) const
virtual void | updateFrustum (void) const
| Update frustum if out of date.
virtual void | updateView (void) const
| Update view if out of date.
virtual void | updateFrustumImpl (void) const
| Implementation of updateFrustum (called if out of date).
virtual void | updateViewImpl (void) const
| Implementation of updateView (called if out of date).
virtual void | updateFrustumPlanes (void) const
virtual void | updateFrustumPlanesImpl (void) const
| Implementation of updateFrustumPlanes (called if out of date).
virtual void | updateWorldSpaceCorners (void) const
virtual void | updateWorldSpaceCornersImpl (void) const
| Implementation of updateWorldSpaceCorners (called if out of date).
virtual void | updateVertexData (void) const
virtual bool | isViewOutOfDate (void) const
virtual bool | isFrustumOutOfDate (void) const
virtual void | invalidateFrustum (void) const
| Signal to update frustum information.
virtual void | invalidateView (void) const
| Signal to update view information.
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

ProjectionType | mProjType
| Orthographic or perspective?
Radian | mFOVy
| y-direction field-of-view (default 45)
Real | mFarDist
| Far clip distance - default 10000.
Real | mNearDist
| Near clip distance - default 100.
Real | mAspect
| x/y viewport ratio - default 1.3333
Real | mOrthoHeight
| Ortho height size (world units).
Vector2 | mFrustumOffset
| Off-axis frustum center offset - default (0.0, 0.0).
Real | mFocalLength
| Focal length of frustum (for stereo rendering, defaults to 1.0).
Plane | mFrustumPlanes [6]
| The 6 main clipping planes.
Quaternion | mLastParentOrientation
| Stored versions of parent orientation / position.
Vector3 | mLastParentPosition
Matrix4 | mProjMatrixRS
| Pre-calced projection matrix for the specific render system.
Matrix4 | mProjMatrixRSDepth
| Pre-calced standard projection matrix but with render system depth range.
Matrix4 | mProjMatrix
| Pre-calced standard projection matrix.
Matrix4 | mViewMatrix
| Pre-calced view matrix.
bool | mRecalcFrustum
| Something's changed in the frustum shape?
bool | mRecalcView
| Something re the view pos has changed.
bool | mRecalcFrustumPlanes
| Something re the frustum planes has changed.
bool | mRecalcWorldSpaceCorners
| Something re the world space corners has changed.
bool | mRecalcVertexData
| Something re the vertex data has changed.
bool | mCustomViewMatrix
| Are we using a custom view matrix?
bool | mCustomProjMatrix
| Are we using a custom projection matrix?
bool | mFrustumExtentsManuallySet
| Have the frustum extents been manually set?
Real | mLeft
| Frustum extents.
Real | mRight
Real | mTop
Real | mBottom
AxisAlignedBox | mBoundingBox
VertexData | mVertexData
MaterialPtr | mMaterial
Vector3 | mWorldSpaceCorners [8]
bool | mReflect
| Is this frustum to act as a reflection of itself?
Matrix4 | mReflectMatrix
| Derived reflection matrix.
Plane | mReflectPlane
| Fixed reflection plane.
const MovablePlane * | mLinkedReflectPlane
| Pointer to a reflection plane (automatically updated).
Plane | mLastLinkedReflectionPlane
| Record of the last world-space reflection plane info used.
bool | mObliqueDepthProjection
| Is this frustum using an oblique depth projection?
Plane | mObliqueProjPlane
| Fixed oblique projection plane.
const MovablePlane * | mLinkedObliqueProjPlane
| Pointer to oblique projection plane (automatically updated).
Plane | mLastLinkedObliqueProjPlane
| Record of the last world-space oblique depth projection plane info used.
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. */.
LightList | mLightList
| List of lights for this object.
ulong | mLightListUpdated
| The last frame that this light list was updated in.
CustomParameterMap | mCustomParameters
bool | mPolygonModeOverrideable
bool | mUseIdentityProjection
bool | mUseIdentityView
Any | mUserAny
RenderSystemData * | mRenderSystemData

## Static Protected Attributes

static String | msMovableType
| Shared class-level name for Movable type.
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

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.

Definition at line 65 of file OgreFrustum.h.

## Member Typedef Documentation

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.

typedef std::map<size_t, Vector4> Ogre::Renderable::CustomParameterMap `[protected, inherited]`

Definition at line 371 of file OgreRenderable.h.

## Constructor & Destructor Documentation

Ogre::Frustum::Frustum | ( |  | ) |

virtual Ogre::Frustum::~Frustum | ( |  | ) | `[virtual]`

## Member Function Documentation

virtual void Ogre::Frustum::calcProjectionParameters | ( | Real & | left,
|  | Real & | right,
|  | Real & | bottom,
|  | Real & | top |
| ) |  |  | const`[protected, virtual]`

virtual void Ogre::Frustum::updateFrustum | ( | void |  | ) | const`[protected, virtual]`

Update frustum if out of date.

virtual void Ogre::Frustum::updateView | ( | void |  | ) | const`[protected, virtual]`

Update view if out of date.

virtual void Ogre::Frustum::updateFrustumImpl | ( | void |  | ) | const`[protected, virtual]`

Implementation of updateFrustum (called if out of date).

virtual void Ogre::Frustum::updateViewImpl | ( | void |  | ) | const`[protected, virtual]`

Implementation of updateView (called if out of date).

virtual void Ogre::Frustum::updateFrustumPlanes | ( | void |  | ) | const`[protected, virtual]`

virtual void Ogre::Frustum::updateFrustumPlanesImpl | ( | void |  | ) | const`[protected, virtual]`

Implementation of updateFrustumPlanes (called if out of date).

virtual void Ogre::Frustum::updateWorldSpaceCorners | ( | void |  | ) | const`[protected, virtual]`

virtual void Ogre::Frustum::updateWorldSpaceCornersImpl | ( | void |  | ) | const`[protected, virtual]`

Implementation of updateWorldSpaceCorners (called if out of date).

virtual void Ogre::Frustum::updateVertexData | ( | void |  | ) | const`[protected, virtual]`

virtual bool Ogre::Frustum::isViewOutOfDate | ( | void |  | ) | const`[protected, virtual]`

Reimplemented in Ogre::Camera.

virtual bool Ogre::Frustum::isFrustumOutOfDate | ( | void |  | ) | const`[protected, virtual]`

virtual void Ogre::Frustum::invalidateFrustum | ( | void |  | ) | const`[protected, virtual]`

Signal to update frustum information.

Reimplemented in Ogre::Camera.

virtual void Ogre::Frustum::invalidateView | ( | void |  | ) | const`[protected, virtual]`

Signal to update view information.

Reimplemented in Ogre::Camera.

virtual void Ogre::Frustum::setFOVy | ( | const Radian & | fovy | ) | `[virtual]`

Sets the Y-dimension Field Of View (FOV) of the frustum.

Remarks:
  Field Of View (FOV) is the angle made between the frustum's position, and the edges of the 'screen' onto which the scene is projected. High values (90+ degrees) result in a wide-angle, fish-eye kind of view, low values (30- degrees) in a stretched, telescopic kind of view. Typical values are between 45 and 60 degrees.

  This value represents the VERTICAL field-of-view. The horizontal field of view is calculated from this depending on the dimensions of the viewport (they will only be the same if the viewport is square).

Note:
  Setting the FOV overrides the value supplied for frustum::setNearClipPlane.

virtual const Radian& Ogre::Frustum::getFOVy | ( | void |  | ) | const`[virtual]`

Retrieves the frustums Y-dimension Field Of View (FOV).

virtual void Ogre::Frustum::setNearClipDistance | ( | Real | nearDist | ) | `[virtual]`

Sets the position of the near clipping plane.

Remarks:
  The position of the near clipping plane is the distance from the frustums position to the screen on which the world is projected. The near plane distance, combined with the field-of-view and the aspect ratio, determines the size of the viewport through which the world is viewed (in world co-ordinates). Note that this world viewport is different to a screen viewport, which has it's dimensions expressed in pixels. The frustums viewport should have the same aspect ratio as the screen viewport it renders into to avoid distortion.

Parameters:

  | near | The distance to the near clipping plane from the frustum in world coordinates.

virtual Real Ogre::Frustum::getNearClipDistance | ( | void |  | ) | const`[virtual]`

Sets the position of the near clipping plane.

Reimplemented in Ogre::Camera.

virtual void Ogre::Frustum::setFarClipDistance | ( | Real | farDist | ) | `[virtual]`

Sets the distance to the far clipping plane.

Remarks:
  The view frustum is a pyramid created from the frustum position and the edges of the viewport. This method sets the distance for the far end of that pyramid. Different applications need different values: e.g. a flight sim needs a much further far clipping plane than a first-person shooter. An important point here is that the larger the ratio between near and far clipping planes, the lower the accuracy of the Z-buffer used to depth-cue pixels. This is because the Z-range is limited to the size of the Z buffer (16 or 32-bit) and the max values must be spread over the gap between near and far clip planes. As it happens, you can affect the accuracy far more by altering the near distance rather than the far distance, but keep this in mind.

Parameters:

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

virtual Real Ogre::Frustum::getFarClipDistance | ( | void |  | ) | const`[virtual]`

Retrieves the distance from the frustum to the far clipping plane.

Reimplemented in Ogre::Camera.

virtual void Ogre::Frustum::setAspectRatio | ( | Real | ratio | ) | `[virtual]`

Sets the aspect ratio for the frustum viewport.

Remarks:
  The ratio between the x and y dimensions of the rectangular area visible through the frustum is known as aspect ratio: aspect = width / height .

  The default for most fullscreen windows is 1.3333 - this is also assumed by Ogre unless you use this method to state otherwise.

virtual Real Ogre::Frustum::getAspectRatio | ( | void |  | ) | const`[virtual]`

Retreives the current aspect ratio.

virtual void Ogre::Frustum::setFrustumOffset | ( | const Vector2 & | offset | ) | `[virtual]`

Sets frustum offsets, used in stereo rendering.

Remarks:
  You can set both horizontal and vertical plane offsets of "eye"; in stereo rendering frustum is moved in horizontal plane. To be able to render from two "eyes" you'll need two cameras rendering on two RenderTargets.

  The frustum offsets is in world coordinates, and default to (0, 0) - no offsets.

Parameters:

  | offset | The horizontal and vertical plane offsets.

virtual void Ogre::Frustum::setFrustumOffset | ( | Real | horizontal = `0.0`,
|  | Real | vertical = `0.0` |
| ) |  |  | `[virtual]`

Sets frustum offsets, used in stereo rendering.

Remarks:
  You can set both horizontal and vertical plane offsets of "eye"; in stereo rendering frustum is moved in horizontal plane. To be able to render from two "eyes" you'll need two cameras rendering on two RenderTargets.

  The frustum offsets is in world coordinates, and default to (0, 0) - no offsets.

Parameters:

  | horizontal | The horizontal plane offset.
  | vertical | The vertical plane offset.

virtual const Vector2& Ogre::Frustum::getFrustumOffset | ( |  | ) | const`[virtual]`

Retrieves the frustum offsets.

virtual void Ogre::Frustum::setFocalLength | ( | Real | focalLength = `1.0` | ) | `[virtual]`

Sets frustum focal length (used in stereo rendering).

Parameters:

  | focalLength | The distance to the focal plane from the frustum in world coordinates.

virtual Real Ogre::Frustum::getFocalLength | ( |  | ) | const`[virtual]`

Returns focal length of frustum.

virtual void Ogre::Frustum::setFrustumExtents | ( | Real | left,
|  | Real | right,
|  | Real | top,
|  | Real | bottom |
| ) |  |  | `[virtual]`

Manually set the extents of the frustum.

Parameters:

  | left,right,top,bottom | The position where the side clip planes intersect the near clip plane, in eye space

virtual void Ogre::Frustum::resetFrustumExtents | ( |  | ) | `[virtual]`

Reset the frustum extents to be automatically derived from other params.

virtual void Ogre::Frustum::getFrustumExtents | ( | Real & | outleft,
|  | Real & | outright,
|  | Real & | outtop,
|  | Real & | outbottom |
| ) |  |  | const`[virtual]`

Get the extents of the frustum in view space.

virtual const Matrix4& Ogre::Frustum::getProjectionMatrixRS | ( | void |  | ) | const`[virtual]`

Gets the projection matrix for this frustum adjusted for the current rendersystem specifics (may be right or left-handed, depth range may vary).

Remarks:
  This method retrieves the rendering-API dependent version of the projection matrix. If you want a 'typical' projection matrix then use getProjectionMatrix.

virtual const Matrix4& Ogre::Frustum::getProjectionMatrixWithRSDepth | ( | void |  | ) | const`[virtual]`

Gets the depth-adjusted projection matrix for the current rendersystem, but one which still conforms to right-hand rules.

Remarks:
  This differs from the rendering-API dependent getProjectionMatrix in that it always returns a right-handed projection matrix result no matter what rendering API is being used - this is required for vertex and fragment programs for example. However, the resulting depth range may still vary between render systems since D3D uses [0,1] and GL uses [-1,1], and the range must be kept the same between programmable and fixed-function pipelines.

virtual const Matrix4& Ogre::Frustum::getProjectionMatrix | ( | void |  | ) | const`[virtual]`

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

Remarks:
  This differs from the rendering-API dependent getProjectionMatrixRS in that it always returns a right-handed projection matrix with depth range [-1,+1], result no matter what rendering API is being used - this is required for some uniform algebra for example.

virtual const Matrix4& Ogre::Frustum::getViewMatrix | ( | void |  | ) | const`[virtual]`

Gets the view matrix for this frustum.

Mainly for use by OGRE internally.

Reimplemented in Ogre::Camera.

virtual void Ogre::Frustum::calcViewMatrixRelative | ( | const Vector3 & | relPos,
|  | Matrix4 & | matToUpdate |
| ) |  |  | const`[virtual]`

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)

virtual void Ogre::Frustum::setCustomViewMatrix | ( | bool | enable,
|  | const Matrix4 & | viewMatrix = `Matrix4::IDENTITY` |
| ) |  |  | `[virtual]`

Set whether to use a custom view matrix on this frustum.

Remarks:
  This is an advanced method which allows you to manually set the view matrix on this frustum, rather than having it calculate itself based on it's position and orientation.

Note:
  After enabling a custom view matrix, the frustum will no longer update on its own based on position / orientation changes. You are completely responsible for keeping the view matrix up to date. The custom matrix will be returned from getViewMatrix.

Parameters:

  | 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, the matrix must be an affine matrix.

See also:
  Frustum::setCustomProjectionMatrix, Matrix4::isAffine

virtual bool Ogre::Frustum::isCustomViewMatrixEnabled | ( | void |  | ) | const`[virtual]`

Returns whether a custom view matrix is in use.

Definition at line 369 of file OgreFrustum.h.

virtual void Ogre::Frustum::setCustomProjectionMatrix | ( | bool | enable,
|  | const Matrix4 & | projectionMatrix = `Matrix4::IDENTITY` |
| ) |  |  | `[virtual]`

Set whether to use a custom projection matrix on this frustum.

Remarks:
  This is an advanced method which allows you to manually set the projection matrix on this frustum, rather than having it calculate itself based on it's position and orientation.

Note:
  After enabling a custom projection matrix, the frustum will no longer update on its own based on field of view and near / far distance changes. You are completely responsible for keeping the projection matrix up to date if those values change. The custom matrix will be returned from getProjectionMatrix and derivative functions.

Parameters:

  | 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

See also:
  Frustum::setCustomViewMatrix

virtual bool Ogre::Frustum::isCustomProjectionMatrixEnabled | ( | void |  | ) | const`[virtual]`

Returns whether a custom projection matrix is in use.

Definition at line 394 of file OgreFrustum.h.

virtual const Plane* Ogre::Frustum::getFrustumPlanes | ( | void |  | ) | const`[virtual]`

Retrieves the clipping planes of the frustum (world space).

Remarks:
  The clipping planes are ordered as declared in enumerate constants FrustumPlane.

virtual const Plane& Ogre::Frustum::getFrustumPlane | ( | unsigned short | plane | ) | const`[virtual]`

Retrieves a specified plane of the frustum (world space).

Remarks:
  Gets a reference to one of the planes which make up the frustum frustum, e.g. for clipping purposes.

Reimplemented in Ogre::Camera.

virtual bool Ogre::Frustum::isVisible | ( | const AxisAlignedBox & | bound,
|  | FrustumPlane * | culledBy = `0` |
| ) |  |  | const`[virtual]`

Tests whether the given container is visible in the Frustum.

Parameters:

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

Returns:
  If the box was visible, true is returned.

  Otherwise, false is returned.

Reimplemented in Ogre::Camera.

virtual bool Ogre::Frustum::isVisible | ( | const Sphere & | bound,
|  | FrustumPlane * | culledBy = `0` |
| ) |  |  | const`[virtual]`

Tests whether the given container is visible in the Frustum.

Parameters:

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

Returns:
  If the sphere was visible, true is returned.

  Otherwise, false is returned.

Reimplemented in Ogre::Camera.

virtual bool Ogre::Frustum::isVisible | ( | const Vector3 & | vert,
|  | FrustumPlane * | culledBy = `0` |
| ) |  |  | const`[virtual]`

Tests whether the given vertex is visible in the Frustum.

Parameters:

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

Returns:
  If the box was visible, true is returned.

  Otherwise, false is returned.

Reimplemented in Ogre::Camera.

uint32 Ogre::Frustum::getTypeFlags | ( | void |  | ) | const`[virtual]`

Overridden from MovableObject::getTypeFlags.

Reimplemented from Ogre::MovableObject.

const AxisAlignedBox& Ogre::Frustum::getBoundingBox | ( | void |  | ) | const`[virtual]`

Overridden from MovableObject.

Implements Ogre::MovableObject.

Real Ogre::Frustum::getBoundingRadius | ( | void |  | ) | const`[virtual]`

Overridden from MovableObject.

Implements Ogre::MovableObject.

Reimplemented in Ogre::Camera.

void Ogre::Frustum::_updateRenderQueue | ( | RenderQueue * | queue | ) | `[virtual]`

Overridden from MovableObject.

Implements Ogre::MovableObject.

const String& Ogre::Frustum::getMovableType | ( | void |  | ) | const`[virtual]`

Overridden from MovableObject.

Implements Ogre::MovableObject.

Reimplemented in Ogre::Camera.

void Ogre::Frustum::_notifyCurrentCamera | ( | Camera * | cam | ) | `[virtual]`

Overridden from MovableObject.

Reimplemented from Ogre::MovableObject.

const MaterialPtr& Ogre::Frustum::getMaterial | ( | void |  | ) | const`[virtual]`

Overridden from Renderable.

Implements Ogre::Renderable.

void Ogre::Frustum::getRenderOperation | ( | RenderOperation & | op | ) | `[virtual]`

Overridden from Renderable.

Implements Ogre::Renderable.

void Ogre::Frustum::getWorldTransforms | ( | Matrix4 * | xform | ) | const`[virtual]`

Overridden from Renderable.

Implements Ogre::Renderable.

Real Ogre::Frustum::getSquaredViewDepth | ( | const Camera * | cam | ) | const`[virtual]`

Overridden from Renderable.

Implements Ogre::Renderable.

const LightList& Ogre::Frustum::getLights | ( | void |  | ) | const`[virtual]`

Overridden from Renderable.

Implements Ogre::Renderable.

virtual const Vector3* Ogre::Frustum::getWorldSpaceCorners | ( | void |  | ) | const`[virtual]`

Gets the world space corners of the frustum.

Remarks:
  The corners are ordered as follows: top-right near, top-left near, bottom-left near, bottom-right near, top-right far, top-left far, bottom-left far, bottom-right far.

Reimplemented in Ogre::Camera.

virtual void Ogre::Frustum::setProjectionType | ( | ProjectionType | pt | ) | `[virtual]`

Sets the type of projection to use (orthographic or perspective).

Default is perspective.

virtual ProjectionType Ogre::Frustum::getProjectionType | ( | void |  | ) | const`[virtual]`

Retrieves info on the type of projection used (orthographic or perspective).

virtual void Ogre::Frustum::setOrthoWindow | ( | Real | w,
|  | Real | h |
| ) |  |  | `[virtual]`

Sets the orthographic window settings, for use with orthographic rendering only.

Note:
  Calling this method will recalculate the aspect ratio, use setOrthoWindowHeight or setOrthoWindowWidth alone if you wish to preserve the aspect ratio but just fit one or other dimension to a particular size.

Parameters:

  | w,h | The dimensions of the view window in world units

virtual void Ogre::Frustum::setOrthoWindowHeight | ( | Real | h | ) | `[virtual]`

Sets the orthographic window height, for use with orthographic rendering only.

Note:
  The width of the window will be calculated from the aspect ratio.

Parameters:

  | h | The height of the view window in world units

virtual void Ogre::Frustum::setOrthoWindowWidth | ( | Real | w | ) | `[virtual]`

Sets the orthographic window width, for use with orthographic rendering only.

Note:
  The height of the window will be calculated from the aspect ratio.

Parameters:

  | w | The width of the view window in world units

virtual Real Ogre::Frustum::getOrthoWindowHeight | ( |  | ) | const`[virtual]`

Gets the orthographic window height, for use with orthographic rendering only.

virtual Real Ogre::Frustum::getOrthoWindowWidth | ( |  | ) | const`[virtual]`

Gets the orthographic window width, for use with orthographic rendering only.

Note:
  This is calculated from the orthographic height and the aspect ratio

virtual void Ogre::Frustum::enableReflection | ( | const Plane & | p | ) | `[virtual]`

Modifies this frustum so it always renders from the reflection of itself through the plane specified.

Remarks:
  This is obviously useful for performing planar reflections.

virtual void Ogre::Frustum::enableReflection | ( | const MovablePlane * | p | ) | `[virtual]`

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.

Remarks:
  This is obviously useful for performing planar reflections.

virtual void Ogre::Frustum::disableReflection | ( | void |  | ) | `[virtual]`

Disables reflection modification previously turned on with enableReflection.

virtual bool Ogre::Frustum::isReflected | ( | void |  | ) | const`[virtual]`

Returns whether this frustum is being reflected.

Definition at line 543 of file OgreFrustum.h.

virtual const Matrix4& Ogre::Frustum::getReflectionMatrix | ( | void |  | ) | const`[virtual]`

Returns the reflection matrix of the frustum if appropriate.

Definition at line 545 of file OgreFrustum.h.

virtual const Plane& Ogre::Frustum::getReflectionPlane | ( | void |  | ) | const`[virtual]`

Returns the reflection plane of the frustum if appropriate.

Definition at line 547 of file OgreFrustum.h.

virtual bool Ogre::Frustum::projectSphere | ( | const Sphere & | sphere,
|  | Real * | left,
|  | Real * | top,
|  | Real * | right,
|  | Real * | bottom |
| ) |  |  | const`[virtual]`

Project a sphere onto the near plane and get the bounding rectangle.

Parameters:

  | sphere | The world-space sphere to project
  | radius | Radius of the sphere
  | left,top,right,bottom | Pointers to destination values, these will be completed with the normalised device coordinates (in the range {-1,1})

Returns:
  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.

virtual void Ogre::Frustum::enableCustomNearClipPlane | ( | const MovablePlane * | plane | ) | `[virtual]`

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.

Remarks:
  There are several applications for clipping a scene arbitrarily by a single plane; the most common is when rendering a reflection to a texture, and you only want to render geometry that is above the water plane (to do otherwise results in artefacts). Whilst it is possible to use user clip planes, they are not supported on all cards, and sometimes are not hardware accelerated when they are available. Instead, where a single clip plane is involved, this technique uses a 'fudging' of the near clip plane, which is available and fast on all hardware, to perform as the arbitrary clip plane. This does change the shape of the frustum, leading to some depth buffer loss of precision, but for many of the uses of this technique that is not an issue.

  This version of the method links to a plane, rather than requiring a by-value plane definition, and therefore you can make changes to the plane (e.g. by moving / rotating the node it is attached to) and they will automatically affect this object.

Note:
  This technique only works for perspective projection.

Parameters:

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

virtual void Ogre::Frustum::enableCustomNearClipPlane | ( | const Plane & | plane | ) | `[virtual]`

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.

Remarks:
  There are several applications for clipping a scene arbitrarily by a single plane; the most common is when rendering a reflection to a texture, and you only want to render geometry that is above the water plane (to do otherwise results in artefacts). Whilst it is possible to use user clip planes, they are not supported on all cards, and sometimes are not hardware accelerated when they are available. Instead, where a single clip plane is involved, this technique uses a 'fudging' of the near clip plane, which is available and fast on all hardware, to perform as the arbitrary clip plane. This does change the shape of the frustum, leading to some depth buffer loss of precision, but for many of the uses of this technique that is not an issue.

Note:
  This technique only works for perspective projection.

Parameters:

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

virtual void Ogre::Frustum::disableCustomNearClipPlane | ( | void |  | ) | `[virtual]`

Disables any custom near clip plane.

virtual bool Ogre::Frustum::isCustomNearClipPlaneEnabled | ( | void |  | ) | const`[virtual]`

Is a custom near clip plane in use?

Definition at line 612 of file OgreFrustum.h.

void Ogre::Frustum::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.

virtual const Vector3& Ogre::Frustum::getPositionForViewUpdate | ( | void |  | ) | const`[virtual]`

Get the derived position of this frustum.

Reimplemented in Ogre::Camera.

virtual const Quaternion& Ogre::Frustum::getOrientationForViewUpdate | ( | void |  | ) | const`[virtual]`

Get the derived orientation of this frustum.

Reimplemented in Ogre::Camera.

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 bool Ogre::MovableObject::isVisible | ( | void |  | ) | const`[virtual, inherited]`

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 in Ogre::InstancedGeometry::BatchInstance, and Ogre::StaticGeometry::Region.

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. See the enum RenderQueueGroupID for what kind of values can be used here.

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 343 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 347 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 351 of file OgreMovableObject.h.

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

Returns the query flags relevant for this object.

Definition at line 354 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 358 of file OgreMovableObject.h.

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

Get the default query flags for all future MovableObject instances.

Definition at line 362 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 371 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 375 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 379 of file OgreMovableObject.h.

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

Returns the visibility flags relevant for this object.

Definition at line 382 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 386 of file OgreMovableObject.h.

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

Get the default visibility flags for all future MovableObject instances.

Definition at line 390 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 397 of file OgreMovableObject.h.

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

Gets the current listener for this object.

Definition at line 401 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 429 of file OgreMovableObject.h.

EdgeData* Ogre::MovableObject::getEdgeList | ( | void |  | ) | `[virtual, inherited]`

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::Entity, Ogre::ManualObject, and Ogre::StaticGeometry::Region.

Definition at line 432 of file OgreMovableObject.h.

bool Ogre::MovableObject::hasEdgeList | ( | void |  | ) | `[virtual, inherited]`

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::Entity, Ogre::ManualObject, and Ogre::StaticGeometry::Region.

Definition at line 434 of file OgreMovableObject.h.

ShadowRenderableListIterator Ogre::MovableObject::getShadowVolumeRenderableIterator | ( | ShadowTechnique | shadowTechnique,
|  | const Light * | light,
|  | HardwareIndexBufferSharedPtr * | indexBuffer,
|  | bool | extrudeVertices,
|  | Real | extrusionDist,
|  | unsigned long | flags = `0` |
| ) |  |  | `[virtual, inherited]`

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::Entity, Ogre::ManualObject, and Ogre::StaticGeometry::Region.

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 457 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 459 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 501 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 503 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.

virtual Technique* Ogre::Renderable::getTechnique | ( | void |  | ) | const`[virtual, inherited]`

Retrieves a pointer to the Material Technique this renderable object uses.

Remarks:
  This is to allow Renderables to use a chosen Technique if they wish, otherwise they will use the best Technique available for the Material they are using.

Reimplemented in Ogre::InstancedGeometry::GeometryBucket, Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity.

Definition at line 87 of file OgreRenderable.h.

virtual bool Ogre::Renderable::preRender | ( | SceneManager * | sm,
|  | RenderSystem * | rsys |
| ) |  |  | `[virtual, inherited]`

Called just prior to the Renderable being rendered.

Remarks:
  OGRE is a queued renderer, so the actual render commands are executed at a later time than the point at which an object is discovered to be visible. This allows ordering & grouping of renders without the discovery process having to be aware of it. It also means OGRE uses declarative render information rather than immediate mode rendering - this is very useful in that certain effects and processes can automatically be applied to a wide range of scenes, but the downside is that special cases are more difficult to handle, because there is not the declared state to cope with it.

  This method allows a Renderable to do something special at the actual point of rendering if it wishes to. When this method is called, all the material render state as declared by this Renderable has already been set, all that is left to do is to bind the buffers and perform the render. The Renderable may modify render state itself if it wants to (and restore it in the postRender call) before the automated render happens, or by returning 'false' from this method can actually suppress the automatic render and perform one of its own.

Returns:
  true if the automatic render should proceed, false to skip it on the assumption that the Renderable has done it manually.

Definition at line 116 of file OgreRenderable.h.

virtual void Ogre::Renderable::postRender | ( | SceneManager * | sm,
|  | RenderSystem * | rsys |
| ) |  |  | `[virtual, inherited]`

Called immediately after the Renderable has been rendered.

Definition at line 119 of file OgreRenderable.h.

virtual unsigned short Ogre::Renderable::getNumWorldTransforms | ( | void |  | ) | const`[virtual, inherited]`

Returns the number of world transform matrices this renderable requires.

Remarks:
  When a renderable uses vertex blending, it uses multiple world matrices instead of a single one. Each vertex sent to the pipeline can reference one or more matrices in this list with given weights. If a renderable does not use vertex blending this method returns 1, which is the default for simplicity.

Reimplemented in Ogre::BorderRenderable, Ogre::InstancedGeometry::GeometryBucket, and Ogre::SubEntity.

Definition at line 143 of file OgreRenderable.h.

void Ogre::Renderable::setUseIdentityProjection | ( | bool | useIdentityProjection | ) | `[inherited]`

Sets whether or not to use an 'identity' projection.

Remarks:
  Usually Renderable objects will use a projection matrix as determined by the active camera. However, if they want they can cancel this out and use an identity projection, which effectively projects in 2D using a {-1, 1} view space. Useful for overlay rendering. Normal renderables need not change this. The default is false.

See also:
  Renderable::getUseIdentityProjection

Definition at line 154 of file OgreRenderable.h.

bool Ogre::Renderable::getUseIdentityProjection | ( | void |  | ) | const`[inherited]`

Returns whether or not to use an 'identity' projection.

Remarks:
  Usually Renderable objects will use a projection matrix as determined by the active camera. However, if they want they can cancel this out and use an identity projection, which effectively projects in 2D using a {-1, 1} view space. Useful for overlay rendering. Normal renderables need not change this.

See also:
  Renderable::setUseIdentityProjection

Definition at line 168 of file OgreRenderable.h.

void Ogre::Renderable::setUseIdentityView | ( | bool | useIdentityView | ) | `[inherited]`

Sets whether or not to use an 'identity' view.

Remarks:
  Usually Renderable objects will use a view matrix as determined by the active camera. However, if they want they can cancel this out and use an identity matrix, which means all geometry is assumed to be relative to camera space already. Useful for overlay rendering. Normal renderables need not change this. The default is false.

See also:
  Renderable::getUseIdentityView

Definition at line 179 of file OgreRenderable.h.

bool Ogre::Renderable::getUseIdentityView | ( | void |  | ) | const`[inherited]`

Returns whether or not to use an 'identity' view.

Remarks:
  Usually Renderable objects will use a view matrix as determined by the active camera. However, if they want they can cancel this out and use an identity matrix, which means all geometry is assumed to be relative to camera space already. Useful for overlay rendering. Normal renderables need not change this.

See also:
  Renderable::setUseIdentityView

Definition at line 193 of file OgreRenderable.h.

virtual bool Ogre::Renderable::getCastsShadows | ( | void |  | ) | const`[virtual, inherited]`

Method which reports whether this renderable would normally cast a shadow.

Remarks:
  Subclasses should override this if they could have been used to generate a shadow.

Reimplemented in Ogre::InstancedGeometry::GeometryBucket, Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity.

Definition at line 214 of file OgreRenderable.h.

void Ogre::Renderable::setCustomParameter | ( | size_t | index,
|  | const Vector4 & | value |
| ) |  |  | `[inherited]`

Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters.

Remarks:
  Calling this method simply associates a numeric index with a 4-dimensional value for this specific Renderable. This is most useful if the material which this Renderable uses a vertex or fragment program, and has an ACT_CUSTOM parameter entry. This parameter entry can refer to the index you specify as part of this call, thereby mapping a custom parameter for this renderable to a program parameter.

Parameters:

  | index | The index with which to associate the value. Note that this does not have to start at 0, and can include gaps. It also has no direct correlation with a GPU program parameter index - the mapping between the two is performed by the ACT_CUSTOM entry, if that is used.
  | value | The value to associate.

Definition at line 231 of file OgreRenderable.h.

const Vector4& Ogre::Renderable::getCustomParameter | ( | size_t | index | ) | const`[inherited]`

Gets the custom value associated with this Renderable at the given index.

Parameters:

  | @see | setCustomParaemter for full details.

Definition at line 240 of file OgreRenderable.h.

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

virtual void Ogre::Renderable::_updateCustomGpuParameter | ( | const GpuProgramParameters::AutoConstantEntry & | constantEntry,
|  | GpuProgramParameters * | params |
| ) |  |  | const`[virtual, inherited]`

Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.

Remarks:
  This method allows a Renderable to map in a custom GPU program parameter based on it's own data. This is represented by a GPU auto parameter of ACT_CUSTOM, and to allow there to be more than one of these per Renderable, the 'data' field on the auto parameter will identify which parameter is being updated. The implementation of this method must identify the parameter being updated, and call a 'setConstant' method on the passed in GpuProgramParameters object, using the details provided in the incoming auto constant setting to identify the index at which to set the parameter.

  You do not need to override this method if you're using the standard sets of data associated with the Renderable as provided by setCustomParameter and getCustomParameter. By default, the implementation will map from the value indexed by the 'constantEntry.data' parameter to a value previously set by setCustomParameter. But custom Renderables are free to override this if they want, in any case.

Parameters:

  | constantEntry | The auto constant entry referring to the parameter being updated
  | params | The parameters object which this method should call to set the updated parameters.

Reimplemented in Ogre::SubEntity.

Definition at line 279 of file OgreRenderable.h.

References Ogre::GpuProgramParameters::_writeRawConstant(), Ogre::GpuProgramParameters::AutoConstantEntry::data, Ogre::GpuProgramParameters::AutoConstantEntry::elementCount, and Ogre::GpuProgramParameters::AutoConstantEntry::physicalIndex.

virtual void Ogre::Renderable::setPolygonModeOverrideable | ( | bool | override | ) | `[virtual, inherited]`

Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.

Parameters:

  | override | true means that a lower camera detail will override this renderables detail level, false means it won't.

Definition at line 296 of file OgreRenderable.h.

virtual bool Ogre::Renderable::getPolygonModeOverrideable | ( | void |  | ) | const`[virtual, inherited]`

Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.

Reimplemented in Ogre::BorderRenderable.

Definition at line 304 of file OgreRenderable.h.

virtual void Ogre::Renderable::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 Renderable. This can be a pointer back to one of your own classes for instance.

Definition at line 315 of file OgreRenderable.h.

virtual const Any& Ogre::Renderable::getUserAny | ( | void |  | ) | const`[virtual, inherited]`

Retrieves the custom user value associated with this object.

Definition at line 319 of file OgreRenderable.h.

virtual RenderSystemData* Ogre::Renderable::getRenderSystemData | ( |  | ) | const`[virtual, inherited]`

Sets render system private data.

Remarks:
  This should only be used by a render system

Definition at line 356 of file OgreRenderable.h.

virtual void Ogre::Renderable::setRenderSystemData | ( | RenderSystemData * | val | ) | const`[virtual, inherited]`

gets render system private data

Remarks:
  This should only be used by a render system

Definition at line 364 of file OgreRenderable.h.

## Member Data Documentation

ProjectionType Ogre::Frustum::mProjType `[protected]`

Orthographic or perspective?

Definition at line 69 of file OgreFrustum.h.

Radian Ogre::Frustum::mFOVy `[protected]`

y-direction field-of-view (default 45)

Definition at line 72 of file OgreFrustum.h.

Real Ogre::Frustum::mFarDist `[protected]`

Far clip distance - default 10000.

Definition at line 74 of file OgreFrustum.h.

Real Ogre::Frustum::mNearDist `[protected]`

Near clip distance - default 100.

Definition at line 76 of file OgreFrustum.h.

Real Ogre::Frustum::mAspect `[protected]`

x/y viewport ratio - default 1.3333

Definition at line 78 of file OgreFrustum.h.

Real Ogre::Frustum::mOrthoHeight `[protected]`

Ortho height size (world units).

Definition at line 80 of file OgreFrustum.h.

Vector2 Ogre::Frustum::mFrustumOffset `[protected]`

Off-axis frustum center offset - default (0.0, 0.0).

Definition at line 82 of file OgreFrustum.h.

Real Ogre::Frustum::mFocalLength `[protected]`

Focal length of frustum (for stereo rendering, defaults to 1.0).

Definition at line 84 of file OgreFrustum.h.

Plane Ogre::Frustum::mFrustumPlanes[6]`[mutable, protected]`

The 6 main clipping planes.

Definition at line 87 of file OgreFrustum.h.

Quaternion Ogre::Frustum::mLastParentOrientation `[mutable, protected]`

Stored versions of parent orientation / position.

Definition at line 90 of file OgreFrustum.h.

Vector3 Ogre::Frustum::mLastParentPosition `[mutable, protected]`

Definition at line 91 of file OgreFrustum.h.

Matrix4 Ogre::Frustum::mProjMatrixRS `[mutable, protected]`

Pre-calced projection matrix for the specific render system.

Definition at line 94 of file OgreFrustum.h.

Matrix4 Ogre::Frustum::mProjMatrixRSDepth `[mutable, protected]`

Pre-calced standard projection matrix but with render system depth range.

Definition at line 96 of file OgreFrustum.h.

Matrix4 Ogre::Frustum::mProjMatrix `[mutable, protected]`

Pre-calced standard projection matrix.

Definition at line 98 of file OgreFrustum.h.

Matrix4 Ogre::Frustum::mViewMatrix `[mutable, protected]`

Pre-calced view matrix.

Definition at line 100 of file OgreFrustum.h.

bool Ogre::Frustum::mRecalcFrustum `[mutable, protected]`

Something's changed in the frustum shape?

Definition at line 102 of file OgreFrustum.h.

bool Ogre::Frustum::mRecalcView `[mutable, protected]`

Something re the view pos has changed.

Definition at line 104 of file OgreFrustum.h.

bool Ogre::Frustum::mRecalcFrustumPlanes `[mutable, protected]`

Something re the frustum planes has changed.

Definition at line 106 of file OgreFrustum.h.

bool Ogre::Frustum::mRecalcWorldSpaceCorners `[mutable, protected]`

Something re the world space corners has changed.

Definition at line 108 of file OgreFrustum.h.

bool Ogre::Frustum::mRecalcVertexData `[mutable, protected]`

Something re the vertex data has changed.

Definition at line 110 of file OgreFrustum.h.

bool Ogre::Frustum::mCustomViewMatrix `[protected]`

Are we using a custom view matrix?

Definition at line 112 of file OgreFrustum.h.

bool Ogre::Frustum::mCustomProjMatrix `[protected]`

Are we using a custom projection matrix?

Definition at line 114 of file OgreFrustum.h.

bool Ogre::Frustum::mFrustumExtentsManuallySet `[protected]`

Have the frustum extents been manually set?

Definition at line 116 of file OgreFrustum.h.

Real Ogre::Frustum::mLeft `[mutable, protected]`

Frustum extents.

Definition at line 118 of file OgreFrustum.h.

Real Ogre::Frustum::mRight `[mutable, protected]`

Definition at line 118 of file OgreFrustum.h.

Real Ogre::Frustum::mTop `[mutable, protected]`

Definition at line 118 of file OgreFrustum.h.

Real Ogre::Frustum::mBottom `[mutable, protected]`

Definition at line 118 of file OgreFrustum.h.

String Ogre::Frustum::msMovableType `[static, protected]`

Shared class-level name for Movable type.

Reimplemented in Ogre::Camera.

Definition at line 146 of file OgreFrustum.h.

AxisAlignedBox Ogre::Frustum::mBoundingBox `[mutable, protected]`

Definition at line 148 of file OgreFrustum.h.

VertexData Ogre::Frustum::mVertexData `[mutable, protected]`

Definition at line 149 of file OgreFrustum.h.

MaterialPtr Ogre::Frustum::mMaterial `[protected]`

Definition at line 151 of file OgreFrustum.h.

Vector3 Ogre::Frustum::mWorldSpaceCorners[8]`[mutable, protected]`

Definition at line 152 of file OgreFrustum.h.

bool Ogre::Frustum::mReflect `[protected]`

Is this frustum to act as a reflection of itself?

Definition at line 155 of file OgreFrustum.h.

Matrix4 Ogre::Frustum::mReflectMatrix `[mutable, protected]`

Derived reflection matrix.

Definition at line 157 of file OgreFrustum.h.

Plane Ogre::Frustum::mReflectPlane `[mutable, protected]`

Fixed reflection plane.

Definition at line 159 of file OgreFrustum.h.

const MovablePlane* Ogre::Frustum::mLinkedReflectPlane `[protected]`

Pointer to a reflection plane (automatically updated).

Definition at line 161 of file OgreFrustum.h.

Plane Ogre::Frustum::mLastLinkedReflectionPlane `[mutable, protected]`

Record of the last world-space reflection plane info used.

Definition at line 163 of file OgreFrustum.h.

bool Ogre::Frustum::mObliqueDepthProjection `[protected]`

Is this frustum using an oblique depth projection?

Definition at line 166 of file OgreFrustum.h.

Plane Ogre::Frustum::mObliqueProjPlane `[mutable, protected]`

Fixed oblique projection plane.

Definition at line 168 of file OgreFrustum.h.

const MovablePlane* Ogre::Frustum::mLinkedObliqueProjPlane `[protected]`

Pointer to oblique projection plane (automatically updated).

Definition at line 170 of file OgreFrustum.h.

Plane Ogre::Frustum::mLastLinkedObliqueProjPlane `[mutable, protected]`

Record of the last world-space oblique depth projection plane info used.

Definition at line 172 of file OgreFrustum.h.

const Real Ogre::Frustum::INFINITE_FAR_PLANE_ADJUST `[static]`

Small constant used to reduce far plane projection to avoid inaccuracies.

Definition at line 620 of file OgreFrustum.h.

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

Name of this object.

Reimplemented in Ogre::Camera.

Definition at line 104 of file OgreMovableObject.h.

MovableObjectFactory* Ogre::MovableObject::mCreator `[protected, inherited]`

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

Definition at line 106 of file OgreMovableObject.h.

SceneManager* Ogre::MovableObject::mManager `[protected, inherited]`

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.

Real Ogre::MovableObject::mSquaredUpperDistance `[protected, inherited]`

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.

uint8 Ogre::MovableObject::mRenderQueueID `[protected, inherited]`

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.

uint32 Ogre::MovableObject::mVisibilityFlags `[protected, inherited]`

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.

AxisAlignedBox Ogre::MovableObject::mWorldDarkCapBounds `[mutable, protected, inherited]`

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.

LightList Ogre::MovableObject::mLightList `[mutable, protected, inherited]`

List of lights for this object.

Reimplemented in Ogre::StaticGeometry::Region.

Definition at line 146 of file OgreMovableObject.h.

ulong Ogre::MovableObject::mLightListUpdated `[mutable, protected, inherited]`

The last frame that this light list was updated in.

Reimplemented in Ogre::StaticGeometry::Region.

Definition at line 148 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.

AnimableDictionaryMap Ogre::AnimableObject::msAnimableDictionary `[static, protected, inherited]`

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

Definition at line 236 of file OgreAnimable.h.

CustomParameterMap Ogre::Renderable::mCustomParameters `[protected, inherited]`

Definition at line 372 of file OgreRenderable.h.

bool Ogre::Renderable::mPolygonModeOverrideable `[protected, inherited]`

Definition at line 373 of file OgreRenderable.h.

bool Ogre::Renderable::mUseIdentityProjection `[protected, inherited]`

Definition at line 374 of file OgreRenderable.h.

bool Ogre::Renderable::mUseIdentityView `[protected, inherited]`

Definition at line 375 of file OgreRenderable.h.

Any Ogre::Renderable::mUserAny `[protected, inherited]`

Definition at line 376 of file OgreRenderable.h.

RenderSystemData* Ogre::Renderable::mRenderSystemData `[mutable, protected, inherited]`

Definition at line 377 of file OgreRenderable.h.

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

- OgreFrustum.h

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Dec 27 17:32:09 2009