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.
Real	getPointExtrusionDistance (const Light *l) const
	Get the distance to extrude for a point/spot light.
virtual void	setDebugDisplayEnabled (bool enabled)
	Sets whether or not the debug display of this object is enabled.
virtual bool	isDebugDisplayEnabled (void) const
	Gets whether debug display of this object is enabled.
const StringVector &	getAnimableValueNames (void) const
	Gets a list of animable value names for this object.
virtual AnimableValuePtr	createAnimableValue (const String &valueName)
	Create a reference-counted AnimableValuePtr for the named value.
void *	operator new (size_t sz, const char *file, int line, const char *func)
	operator new, with debug line info
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz, const char *file, int line, const char *func)
	array operator new, with debug line info
void *	operator new[] (size_t sz)
void	operator delete (void *ptr)
void	operator delete (void *ptr, const char *, int, const char *)
void	operator delete[] (void *ptr)
void	operator delete[] (void *ptr, const char *, int, const char *)
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.