OGRE  1.7
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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:
+ Collaboration diagram for Ogre::Frustum:

Public Types

typedef vector
< ShadowRenderable * >::type 
ShadowRenderableList
 
typedef VectorIterator
< ShadowRenderableList
ShadowRenderableListIterator
 

Public Member Functions

 Frustum (const String &name=StringUtil::BLANK)
 Named constructor. More...
 
virtual ~Frustum ()
 
virtual MovableObjectFactory_getCreator (void) const
 Get the creator of this object, if any (internal use only) More...
 
virtual LightList_getLightList ()
 Returns a pointer to the current list of lights for this object. More...
 
virtual SceneManager_getManager (void) const
 Get the manager of this object, if any (internal use only) More...
 
virtual const Matrix4_getParentNodeFullTransform (void) const
 return the full transformation of the parent sceneNode or the attachingPoint node More...
 
virtual void _notifyAttached (Node *parent, bool isTagPoint=false)
 Internal method called to notify the object that it has been attached to a node. More...
 
virtual void _notifyCreator (MovableObjectFactory *fact)
 Notify the object of it's creator (internal use only) More...
 
void _notifyCurrentCamera (Camera *cam)
 Overridden from MovableObject. More...
 
virtual void _notifyManager (SceneManager *man)
 Notify the object of it's manager (internal use only) More...
 
virtual void _notifyMoved (void)
 Internal method called to notify the object that it has been moved. More...
 
virtual void _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const
 Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows. More...
 
void _updateRenderQueue (RenderQueue *queue)
 Overridden from MovableObject. More...
 
virtual void addQueryFlags (uint32 flags)
 As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
 
virtual void addVisibilityFlags (uint32 flags)
 As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
 
virtual void calcViewMatrixRelative (const Vector3 &relPos, Matrix4 &matToUpdate) const
 Calculate a view matrix for this frustum, relative to a potentially dynamic point. More...
 
virtual AnimableValuePtr createAnimableValue (const String &valueName)
 Create a reference-counted AnimableValuePtr for the named value. More...
 
virtual void detachFromParent (void)
 Detaches an object from a parent SceneNode or TagPoint, if attached. More...
 
virtual void disableCustomNearClipPlane (void)
 Disables any custom near clip plane. More...
 
virtual void disableReflection (void)
 Disables reflection modification previously turned on with enableReflection. More...
 
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. More...
 
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. More...
 
virtual void enableReflection (const Plane &p)
 Modifies this frustum so it always renders from the reflection of itself through the plane specified. More...
 
virtual void enableReflection (const MovablePlane *p)
 Modifies this frustum so it always renders from the reflection of itself through the plane specified. More...
 
const StringVectorgetAnimableValueNames (void) const
 Gets a list of animable value names for this object. More...
 
virtual Real getAspectRatio (void) const
 Retreives the current aspect ratio. More...
 
const AxisAlignedBoxgetBoundingBox (void) const
 Overridden from MovableObject. More...
 
Real getBoundingRadius (void) const
 Overridden from MovableObject. More...
 
bool getCastShadows (void) const
 Returns whether shadow casting is enabled for this object. More...
 
virtual bool getCastsShadows (void) const
 Method which reports whether this renderable would normally cast a shadow. More...
 
const Vector4getCustomParameter (size_t index) const
 Gets the custom value associated with this Renderable at the given index. More...
 
const AxisAlignedBoxgetDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const
 Overridden member from ShadowCaster. More...
 
EdgeDatagetEdgeList (void)
 Define a default implementation of method from ShadowCaster which implements no shadows. More...
 
virtual Real getFarClipDistance (void) const
 Retrieves the distance from the frustum to the far clipping plane. More...
 
virtual Real getFocalLength () const
 Returns focal length of frustum. More...
 
virtual const RadiangetFOVy (void) const
 Retrieves the frustums Y-dimension Field Of View (FOV). More...
 
virtual void getFrustumExtents (Real &outleft, Real &outright, Real &outtop, Real &outbottom) const
 Get the extents of the frustum in view space. More...
 
virtual const Vector2getFrustumOffset () const
 Retrieves the frustum offsets. More...
 
virtual const PlanegetFrustumPlane (unsigned short plane) const
 Retrieves a specified plane of the frustum (world space). More...
 
virtual const PlanegetFrustumPlanes (void) const
 Retrieves the clipping planes of the frustum (world space). More...
 
const AxisAlignedBoxgetLightCapBounds (void) const
 Overridden member from ShadowCaster. More...
 
virtual uint32 getLightMask () const
 Get a bitwise mask which will filter the lights affecting this object. More...
 
const LightListgetLights (void) const
 Overridden from Renderable. More...
 
virtual ListenergetListener (void) const
 Gets the current listener for this object. More...
 
const MaterialPtrgetMaterial (void) const
 Overridden from Renderable. More...
 
const StringgetMovableType (void) const
 Overridden from MovableObject. More...
 
virtual const StringgetName (void) const
 Returns the name of this object. More...
 
virtual Real getNearClipDistance (void) const
 Sets the position of the near clipping plane. More...
 
virtual unsigned short getNumWorldTransforms (void) const
 Returns the number of world transform matrices this renderable requires. More...
 
virtual const QuaterniongetOrientationForViewUpdate (void) const
 Get the derived orientation of this frustum. More...
 
OrientationMode getOrientationMode () const
 Get the orientation mode of the frustum. More...
 
virtual Real getOrthoWindowHeight () const
 Gets the orthographic window height, for use with orthographic rendering only. More...
 
virtual Real getOrthoWindowWidth () const
 Gets the orthographic window width, for use with orthographic rendering only. More...
 
virtual NodegetParentNode (void) const
 Returns the node to which this object is attached. More...
 
virtual SceneNodegetParentSceneNode (void) const
 Returns the scene node to which this object is attached. More...
 
PlaneBoundedVolume getPlaneBoundedVolume ()
 Gets a world-space list of planes enclosing the frustum. More...
 
Real getPointExtrusionDistance (const Light *l) const
 Get the distance to extrude for a point/spot light. More...
 
virtual bool getPolygonModeOverrideable (void) const
 Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
 
virtual const Vector3getPositionForViewUpdate (void) const
 Get the derived position of this frustum. More...
 
virtual const Matrix4getProjectionMatrix (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]. More...
 
virtual const Matrix4getProjectionMatrixRS (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). More...
 
virtual const Matrix4getProjectionMatrixWithRSDepth (void) const
 Gets the depth-adjusted projection matrix for the current rendersystem, but one which still conforms to right-hand rules. More...
 
virtual ProjectionType getProjectionType (void) const
 Retrieves info on the type of projection used (orthographic or perspective). More...
 
virtual uint32 getQueryFlags (void) const
 Returns the query flags relevant for this object. More...
 
bool getReceivesShadows ()
 Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows. More...
 
virtual const Matrix4getReflectionMatrix (void) const
 Returns the reflection matrix of the frustum if appropriate. More...
 
virtual const PlanegetReflectionPlane (void) const
 Returns the reflection plane of the frustum if appropriate. More...
 
virtual Real getRenderingDistance (void) const
 Gets the distance at which batches are no longer rendered. More...
 
void getRenderOperation (RenderOperation &op)
 Overridden from Renderable. More...
 
virtual uint8 getRenderQueueGroup (void) const
 Gets the queue group for this entity, see setRenderQueueGroup for full details. More...
 
virtual RenderSystemDatagetRenderSystemData () const
 Sets render system private data. More...
 
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. More...
 
Real getSquaredViewDepth (const Camera *cam) const
 Overridden from Renderable. More...
 
virtual TechniquegetTechnique (void) const
 Retrieves a pointer to the Material Technique this renderable object uses. More...
 
uint32 getTypeFlags (void) const
 Overridden from MovableObject::getTypeFlags. More...
 
bool getUseIdentityProjection (void) const
 Returns whether or not to use an 'identity' projection. More...
 
bool getUseIdentityView (void) const
 Returns whether or not to use an 'identity' view. More...
 
virtual const AnygetUserAny (void) const
 
virtual const AnygetUserAny (void) const
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
virtual const Matrix4getViewMatrix (void) const
 Gets the view matrix for this frustum. More...
 
virtual uint32 getVisibilityFlags (void) const
 Returns the visibility flags relevant for this object. More...
 
virtual bool getVisible (void) const
 Gets this object whether to be visible or not, if it has a renderable component. More...
 
virtual const AxisAlignedBoxgetWorldBoundingBox (bool derive=false) const
 Retrieves the axis-aligned bounding box for this object in world coordinates. More...
 
virtual const SpheregetWorldBoundingSphere (bool derive=false) const
 Retrieves the worldspace bounding sphere for this object. More...
 
virtual const Vector3getWorldSpaceCorners (void) const
 Gets the world space corners of the frustum. More...
 
void getWorldTransforms (Matrix4 *xform) const
 Overridden from Renderable. More...
 
bool hasEdgeList (void)
 Define a default implementation of method from ShadowCaster which implements no shadows. More...
 
virtual bool isAttached (void) const
 Returns true if this object is attached to a SceneNode or TagPoint. More...
 
virtual bool isCustomNearClipPlaneEnabled (void) const
 Is a custom near clip plane in use? More...
 
virtual bool isCustomProjectionMatrixEnabled (void) const
 Returns whether a custom projection matrix is in use. More...
 
virtual bool isCustomViewMatrixEnabled (void) const
 Returns whether a custom view matrix is in use. More...
 
virtual bool isDebugDisplayEnabled (void) const
 Gets whether debug display of this object is enabled. More...
 
virtual bool isInScene (void) const
 Returns true if this object is attached to a SceneNode or TagPoint, and this SceneNode / TagPoint is currently in an active part of the scene graph. More...
 
virtual bool isParentTagPoint () const
 Gets whether the parent node is a TagPoint (or a SceneNode) More...
 
virtual bool isReflected (void) const
 Returns whether this frustum is being reflected. More...
 
virtual bool isVisible (void) const
 Returns whether or not this object is supposed to be visible or not. More...
 
virtual bool isVisible (const AxisAlignedBox &bound, FrustumPlane *culledBy=0) const
 Tests whether the given container is visible in the Frustum. More...
 
virtual bool isVisible (const Sphere &bound, FrustumPlane *culledBy=0) const
 Tests whether the given container is visible in the Frustum. More...
 
virtual bool isVisible (const Vector3 &vert, FrustumPlane *culledBy=0) const
 Tests whether the given vertex is visible in the Frustum. More...
 
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 *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
virtual void postRender (SceneManager *sm, RenderSystem *rsys)
 Called immediately after the Renderable has been rendered. More...
 
virtual bool preRender (SceneManager *sm, RenderSystem *rsys)
 Called just prior to the Renderable being rendered. More...
 
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. More...
 
virtual const LightListqueryLights (void) const
 Gets a list of lights, ordered relative to how close they are to this movable object. More...
 
virtual void removeQueryFlags (uint32 flags)
 As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
 
virtual void removeVisibilityFlags (uint32 flags)
 As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
 
virtual void resetFrustumExtents ()
 Reset the frustum extents to be automatically derived from other params. More...
 
virtual void setAspectRatio (Real ratio)
 Sets the aspect ratio for the frustum viewport. More...
 
void setCastShadows (bool enabled)
 Sets whether or not this object will cast shadows. More...
 
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. More...
 
virtual void setCustomProjectionMatrix (bool enable, const Matrix4 &projectionMatrix=Matrix4::IDENTITY)
 Set whether to use a custom projection matrix on this frustum. More...
 
virtual void setCustomViewMatrix (bool enable, const Matrix4 &viewMatrix=Matrix4::IDENTITY)
 Set whether to use a custom view matrix on this frustum. More...
 
virtual void setDebugDisplayEnabled (bool enabled)
 Sets whether or not the debug display of this object is enabled. More...
 
virtual void setFarClipDistance (Real farDist)
 Sets the distance to the far clipping plane. More...
 
virtual void setFocalLength (Real focalLength=1.0)
 Sets frustum focal length (used in stereo rendering). More...
 
virtual void setFOVy (const Radian &fovy)
 Sets the Y-dimension Field Of View (FOV) of the frustum. More...
 
virtual void setFrustumExtents (Real left, Real right, Real top, Real bottom)
 Manually set the extents of the frustum. More...
 
virtual void setFrustumOffset (const Vector2 &offset)
 Sets frustum offsets, used in stereo rendering. More...
 
virtual void setFrustumOffset (Real horizontal=0.0, Real vertical=0.0)
 Sets frustum offsets, used in stereo rendering. More...
 
virtual void setLightMask (uint32 lightMask)
 Set a bitwise mask which will filter the lights affecting this object. More...
 
virtual void setListener (Listener *listener)
 Sets a listener for this object. More...
 
virtual void setNearClipDistance (Real nearDist)
 Sets the position of the near clipping plane. More...
 
void setOrientationMode (OrientationMode orientationMode)
 Set the orientation mode of the frustum. More...
 
virtual void setOrthoWindow (Real w, Real h)
 Sets the orthographic window settings, for use with orthographic rendering only. More...
 
virtual void setOrthoWindowHeight (Real h)
 Sets the orthographic window height, for use with orthographic rendering only. More...
 
virtual void setOrthoWindowWidth (Real w)
 Sets the orthographic window width, for use with orthographic rendering only. More...
 
virtual void setPolygonModeOverrideable (bool override)
 Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
 
virtual void setProjectionType (ProjectionType pt)
 Sets the type of projection to use (orthographic or perspective). More...
 
virtual void setQueryFlags (uint32 flags)
 Sets the query flags for this object. More...
 
virtual void setRenderingDistance (Real dist)
 Sets the distance at which the object is no longer rendered. More...
 
virtual void setRenderQueueGroup (uint8 queueID)
 Sets the render queue group this entity will be rendered through. More...
 
virtual void setRenderQueueGroupAndPriority (uint8 queueID, ushort priority)
 Sets the render queue group and group priority this entity will be rendered through. More...
 
virtual void setRenderSystemData (RenderSystemData *val) const
 gets render system private data More...
 
void setUseIdentityProjection (bool useIdentityProjection)
 Sets whether or not to use an 'identity' projection. More...
 
void setUseIdentityView (bool useIdentityView)
 Sets whether or not to use an 'identity' view. More...
 
virtual void setUserAny (const Any &anything)
 
virtual void setUserAny (const Any &anything)
 
virtual void setVisibilityFlags (uint32 flags)
 Sets the visiblity flags for this object. More...
 
virtual void setVisible (bool visible)
 Tells this object whether to be visible or not, if it has a renderable component. More...
 
void visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false)
 Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any. More...
 

Static Public Member Functions

static void extrudeVertices (const HardwareVertexBufferSharedPtr &vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist)
 Utility method for extruding vertices based on a light. More...
 
static uint32 getDefaultQueryFlags ()
 Get the default query flags for all future MovableObject instances. More...
 
static uint32 getDefaultVisibilityFlags ()
 Get the default visibility flags for all future MovableObject instances. More...
 
static void setDefaultQueryFlags (uint32 flags)
 Set the default query flags for all future MovableObject instances. More...
 
static void setDefaultVisibilityFlags (uint32 flags)
 Set the default visibility flags for all future MovableObject instances. More...
 

Static Public Attributes

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

Protected Types

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

Protected Member Functions

StringVector_getAnimableValueNames (void)
 Get an updateable reference to animable value list. More...
 
virtual void calcProjectionParameters (Real &left, Real &right, Real &bottom, Real &top) const
 
void createAnimableDictionary (void) const
 Internal method for creating a dictionary of animable value names for the class, if it does not already exist. More...
 
virtual void extrudeBounds (AxisAlignedBox &box, const Vector4 &lightPos, Real extrudeDist) const
 Utility method for extruding a bounding box. More...
 
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. More...
 
virtual const StringgetAnimableDictionaryName (void) const
 Get the name of the animable dictionary for this class. More...
 
Real getExtrusionDistance (const Vector3 &objectPos, const Light *light) const
 Helper method for calculating extrusion distance. More...
 
virtual void initialiseAnimableDictionary (StringVector &) const
 Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters. More...
 
virtual void invalidateFrustum (void) const
 Signal to update frustum information. More...
 
virtual void invalidateView (void) const
 Signal to update view information. More...
 
virtual bool isFrustumOutOfDate (void) const
 
virtual bool isViewOutOfDate (void) const
 
virtual void updateEdgeListLightFacing (EdgeData *edgeData, const Vector4 &lightPos)
 Tells the caster to perform the tasks necessary to update the edge data's light listing. More...
 
virtual void updateFrustum (void) const
 Update frustum if out of date. More...
 
virtual void updateFrustumImpl (void) const
 Implementation of updateFrustum (called if out of date) More...
 
virtual void updateFrustumPlanes (void) const
 
virtual void updateFrustumPlanesImpl (void) const
 Implementation of updateFrustumPlanes (called if out of date) More...
 
virtual void updateVertexData (void) const
 
virtual void updateView (void) const
 Update view if out of date. More...
 
virtual void updateViewImpl (void) const
 Implementation of updateView (called if out of date) More...
 
virtual void updateWorldSpaceCorners (void) const
 
virtual void updateWorldSpaceCornersImpl (void) const
 Implementation of updateWorldSpaceCorners (called if out of date) More...
 

Protected Attributes

Real mAspect
 x/y viewport ratio - default 1.3333 More...
 
bool mBeyondFarDistance
 Hidden because of distance? More...
 
Real mBottom
 
AxisAlignedBox mBoundingBox
 
bool mCastShadows
 Does this object cast shadows? More...
 
MovableObjectFactorymCreator
 Creator of this object (if created by a factory) More...
 
CustomParameterMap mCustomParameters
 
bool mCustomProjMatrix
 Are we using a custom projection matrix? More...
 
bool mCustomViewMatrix
 Are we using a custom view matrix? More...
 
bool mDebugDisplay
 Is debug display enabled? More...
 
Real mFarDist
 Far clip distance - default 10000. More...
 
Real mFocalLength
 Focal length of frustum (for stereo rendering, defaults to 1.0) More...
 
Radian mFOVy
 y-direction field-of-view (default 45) More...
 
bool mFrustumExtentsManuallySet
 Have the frustum extents been manually set? More...
 
Vector2 mFrustumOffset
 Off-axis frustum center offset - default (0.0, 0.0) More...
 
Plane mFrustumPlanes [6]
 The 6 main clipping planes. More...
 
Plane mLastLinkedObliqueProjPlane
 Record of the last world-space oblique depth projection plane info used. More...
 
Plane mLastLinkedReflectionPlane
 Record of the last world-space reflection plane info used. More...
 
Quaternion mLastParentOrientation
 Stored versions of parent orientation / position. More...
 
Vector3 mLastParentPosition
 
Real mLeft
 Frustum extents. More...
 
LightList mLightList
 List of lights for this object. More...
 
ulong mLightListUpdated
 The last frame that this light list was updated in. More...
 
uint32 mLightMask
 the light mask defined for this movable. This will be taken into consideration when deciding which light should affect this movable More...
 
const MovablePlanemLinkedObliqueProjPlane
 Pointer to oblique projection plane (automatically updated) More...
 
const MovablePlanemLinkedReflectPlane
 Pointer to a reflection plane (automatically updated) More...
 
ListenermListener
 MovableObject listener - only one allowed (no list) for size & performance reasons. */. More...
 
SceneManagermManager
 SceneManager holding this object (if applicable) More...
 
MaterialPtr mMaterial
 
String mName
 Name of this object. More...
 
Real mNearDist
 Near clip distance - default 100. More...
 
bool mObliqueDepthProjection
 Is this frustum using an oblique depth projection? More...
 
Plane mObliqueProjPlane
 Fixed oblique projection plane. More...
 
OrientationMode mOrientationMode
 Frustum orientation mode. More...
 
Real mOrthoHeight
 Ortho height size (world units) More...
 
bool mParentIsTagPoint
 
NodemParentNode
 node to which this object is attached More...
 
bool mPolygonModeOverrideable
 
Matrix4 mProjMatrix
 Pre-calced standard projection matrix. More...
 
Matrix4 mProjMatrixRS
 Pre-calced projection matrix for the specific render system. More...
 
Matrix4 mProjMatrixRSDepth
 Pre-calced standard projection matrix but with render system depth range. More...
 
ProjectionType mProjType
 Orthographic or perspective? More...
 
uint32 mQueryFlags
 Flags determining whether this object is included / excluded from scene queries. More...
 
bool mRecalcFrustum
 Something's changed in the frustum shape? More...
 
bool mRecalcFrustumPlanes
 Something re the frustum planes has changed. More...
 
bool mRecalcVertexData
 Something re the vertex data has changed. More...
 
bool mRecalcView
 Something re the view pos has changed. More...
 
bool mRecalcWorldSpaceCorners
 Something re the world space corners has changed. More...
 
bool mReflect
 Is this frustum to act as a reflection of itself? More...
 
Matrix4 mReflectMatrix
 Derived reflection matrix. More...
 
Plane mReflectPlane
 Fixed reflection plane. More...
 
bool mRenderingDisabled
 Does rendering this object disabled by listener? More...
 
uint8 mRenderQueueID
 The render queue to use when rendering this object. More...
 
bool mRenderQueueIDSet
 Flags whether the RenderQueue's default should be used. More...
 
ushort mRenderQueuePriority
 The render queue group to use when rendering this object. More...
 
bool mRenderQueuePrioritySet
 Flags whether the RenderQueue's default should be used. More...
 
RenderSystemDatamRenderSystemData
 
Real mRight
 
Real mSquaredUpperDistance
 
Real mTop
 
Real mUpperDistance
 Upper distance to still render. More...
 
bool mUseIdentityProjection
 
bool mUseIdentityView
 
UserObjectBindings mUserObjectBindings
 User objects binding. More...
 
UserObjectBindings mUserObjectBindings
 
VertexData mVertexData
 
Matrix4 mViewMatrix
 Pre-calced view matrix. More...
 
uint32 mVisibilityFlags
 Flags determining whether this object is visible (compared to SceneManager mask) More...
 
bool mVisible
 Is this object visible? More...
 
AxisAlignedBox mWorldAABB
 Cached world AABB of this object. More...
 
Sphere mWorldBoundingSphere
 
AxisAlignedBox mWorldDarkCapBounds
 World space AABB of this object's dark cap. More...
 
Vector3 mWorldSpaceCorners [8]
 

Static Protected Attributes

static AnimableDictionaryMap msAnimableDictionary
 Static map of class name to list of animable value names. More...
 
static uint32 msDefaultQueryFlags
 Default query flags. More...
 
static uint32 msDefaultVisibilityFlags
 Default visibility flags. More...
 
static String msMovableType
 Shared class-level name for Movable type. More...
 

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 84 of file OgreFrustum.h.

Member Typedef Documentation

Definition at line 240 of file OgreAnimable.h.

typedef map<size_t, Vector4>::type Ogre::Renderable::CustomParameterMap
protectedinherited

Definition at line 395 of file OgreRenderable.h.

Definition at line 128 of file OgreShadowCaster.h.

Constructor & Destructor Documentation

Ogre::Frustum::Frustum ( const String name = StringUtil::BLANK)

Named constructor.

virtual Ogre::Frustum::~Frustum ( )
virtual

Member Function Documentation

StringVector& Ogre::AnimableObject::_getAnimableValueNames ( void  )
inlineprotectedinherited

Get an updateable reference to animable value list.

Definition at line 266 of file OgreAnimable.h.

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

virtual MovableObjectFactory* Ogre::MovableObject::_getCreator ( void  ) const
inlinevirtualinherited

Get the creator of this object, if any (internal use only)

Definition at line 183 of file OgreMovableObject.h.

virtual LightList* Ogre::MovableObject::_getLightList ( )
inlinevirtualinherited

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 472 of file OgreMovableObject.h.

virtual SceneManager* Ogre::MovableObject::_getManager ( void  ) const
inlinevirtualinherited

Get the manager of this object, if any (internal use only)

Definition at line 187 of file OgreMovableObject.h.

virtual const Matrix4& Ogre::MovableObject::_getParentNodeFullTransform ( void  ) const
virtualinherited

return the full transformation of the parent sceneNode or the attachingPoint node

virtual void Ogre::MovableObject::_notifyAttached ( Node parent,
bool  isTagPoint = false 
)
virtualinherited

Internal method called to notify the object that it has been attached to a node.

Reimplemented in Ogre::Entity, Ogre::ParticleSystem, Ogre::Light, and Ogre::PortalBase.

Referenced by Ogre::PortalBase::_notifyAttached().

virtual void Ogre::MovableObject::_notifyCreator ( MovableObjectFactory fact)
inlinevirtualinherited

Notify the object of it's creator (internal use only)

Definition at line 181 of file OgreMovableObject.h.

void Ogre::Frustum::_notifyCurrentCamera ( Camera cam)
virtual

Overridden from MovableObject.

Reimplemented from Ogre::MovableObject.

virtual void Ogre::MovableObject::_notifyManager ( SceneManager man)
inlinevirtualinherited

Notify the object of it's manager (internal use only)

Definition at line 185 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::_notifyMoved ( void  )
virtualinherited

Internal method called to notify the object that it has been moved.

Reimplemented in Ogre::Light, Ogre::PortalBase, and Ogre::PCZLight.

virtual void Ogre::Renderable::_updateCustomGpuParameter ( const GpuProgramParameters::AutoConstantEntry constantEntry,
GpuProgramParameters params 
) const
inlinevirtualinherited

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
constantEntryThe auto constant entry referring to the parameter being updated
paramsThe parameters object which this method should call to set the updated parameters.

Reimplemented in Ogre::TerrainRenderable, Ogre::TerrainZoneRenderable, and Ogre::SubEntity.

Definition at line 288 of file OgreRenderable.h.

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

void Ogre::Frustum::_updateRenderQueue ( RenderQueue queue)
virtual

Overridden from MovableObject.

Implements Ogre::MovableObject.

virtual void Ogre::MovableObject::addQueryFlags ( uint32  flags)
inlinevirtualinherited

As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.

Definition at line 377 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::addVisibilityFlags ( uint32  flags)
inlinevirtualinherited

As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object.

Definition at line 405 of file OgreMovableObject.h.

virtual void Ogre::Frustum::calcProjectionParameters ( Real left,
Real right,
Real bottom,
Real top 
) const
protectedvirtual
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)

void Ogre::AnimableObject::createAnimableDictionary ( void  ) const
inlineprotectedinherited

Internal method for creating a dictionary of animable value names for the class, if it does not already exist.

Definition at line 253 of file OgreAnimable.h.

virtual AnimableValuePtr Ogre::AnimableObject::createAnimableValue ( const String valueName)
inlinevirtualinherited

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 319 of file OgreAnimable.h.

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

virtual void Ogre::MovableObject::detachFromParent ( void  )
virtualinherited

Detaches an object from a parent SceneNode or TagPoint, if attached.

virtual void Ogre::Frustum::disableCustomNearClipPlane ( void  )
virtual

Disables any custom near clip plane.

virtual void Ogre::Frustum::disableReflection ( void  )
virtual

Disables reflection modification previously turned on with enableReflection.

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
planeThe 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
planeThe 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::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::ShadowCaster::extrudeBounds ( AxisAlignedBox box,
const Vector4 lightPos,
Real  extrudeDist 
) const
protectedvirtualinherited

Utility method for extruding a bounding box.

Parameters
boxOriginal bounding box, will be updated in-place
lightPos4D light position in object space, when w=0.0f this represents a directional light
extrudeDistThe distance to extrude
static void Ogre::ShadowCaster::extrudeVertices ( const HardwareVertexBufferSharedPtr vertexBuffer,
size_t  originalVertexCount,
const Vector4 lightPos,
Real  extrudeDist 
)
staticinherited

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
vertexBufferThe vertex buffer containing ONLY xyz position values, which must be originalVertexCount * 2 * 3 floats long.
originalVertexCountThe 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.
lightPos4D light position in object space, when w=0.0f this represents a directional light
extrudeDistThe distance to extrude
virtual void Ogre::ShadowCaster::generateShadowVolume ( EdgeData edgeData,
const HardwareIndexBufferSharedPtr indexBuffer,
const Light light,
ShadowRenderableList shadowRenderables,
unsigned long  flags 
)
protectedvirtualinherited

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
edgeDataThe edge information to use
indexBufferThe buffer into which to write data into; current contents are assumed to be discardable.
lightThe light, mainly for type info as silhouette calculations should already have been done in updateEdgeListLightFacing
shadowRenderablesA list of shadow renderables which has already been constructed but will need populating with details of the index ranges to be used.
flagsAdditional controller flags, see ShadowRenderableFlags
virtual const String& Ogre::AnimableObject::getAnimableDictionaryName ( void  ) const
inlineprotectedvirtualinherited

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 248 of file OgreAnimable.h.

References Ogre::StringUtil::BLANK.

const StringVector& Ogre::AnimableObject::getAnimableValueNames ( void  ) const
inlineinherited

Gets a list of animable value names for this object.

Definition at line 294 of file OgreAnimable.h.

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

virtual Real Ogre::Frustum::getAspectRatio ( void  ) const
virtual

Retreives the current aspect ratio.

const AxisAlignedBox& Ogre::Frustum::getBoundingBox ( void  ) const
virtual

Overridden from MovableObject.

Implements Ogre::MovableObject.

Reimplemented in Ogre::PCZCamera.

Real Ogre::Frustum::getBoundingRadius ( void  ) const
virtual

Overridden from MovableObject.

Implements Ogre::MovableObject.

bool Ogre::MovableObject::getCastShadows ( void  ) const
inlinevirtualinherited

Returns whether shadow casting is enabled for this object.

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::TerrainQuadTreeNode::Movable.

Definition at line 502 of file OgreMovableObject.h.

virtual bool Ogre::Renderable::getCastsShadows ( void  ) const
inlinevirtualinherited

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::TerrainQuadTreeNode::Rend, Ogre::StaticGeometry::GeometryBucket, Ogre::InstancedGeometry::GeometryBucket, and Ogre::SubEntity.

Definition at line 223 of file OgreRenderable.h.

const Vector4& Ogre::Renderable::getCustomParameter ( size_t  index) const
inlineinherited

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

Parameters
see setCustomParameter for full details.

Definition at line 249 of file OgreRenderable.h.

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

const AxisAlignedBox& Ogre::MovableObject::getDarkCapBounds ( const Light light,
Real  dirLightExtrusionDist 
) const
virtualinherited

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

static uint32 Ogre::MovableObject::getDefaultQueryFlags ( )
inlinestaticinherited

Get the default query flags for all future MovableObject instances.

Definition at line 392 of file OgreMovableObject.h.

static uint32 Ogre::MovableObject::getDefaultVisibilityFlags ( )
inlinestaticinherited

Get the default visibility flags for all future MovableObject instances.

Definition at line 420 of file OgreMovableObject.h.

EdgeData* Ogre::MovableObject::getEdgeList ( void  )
inlinevirtualinherited

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::StaticGeometry::Region.

Definition at line 475 of file OgreMovableObject.h.

Real Ogre::ShadowCaster::getExtrusionDistance ( const Vector3 objectPos,
const Light light 
) const
protectedinherited

Helper method for calculating extrusion distance.

virtual Real Ogre::Frustum::getFarClipDistance ( void  ) const
virtual

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

Reimplemented in Ogre::Camera.

virtual Real Ogre::Frustum::getFocalLength ( ) const
virtual

Returns focal length of frustum.

virtual const Radian& Ogre::Frustum::getFOVy ( void  ) const
virtual

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

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 Vector2& Ogre::Frustum::getFrustumOffset ( ) const
virtual

Retrieves the frustum offsets.

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 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.
const AxisAlignedBox& Ogre::MovableObject::getLightCapBounds ( void  ) const
virtualinherited

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

virtual uint32 Ogre::MovableObject::getLightMask ( ) const
inlinevirtualinherited

Get a bitwise mask which will filter the lights affecting this object.

Remarks
By default, this mask is fully set meaning all lights will affect this object

Definition at line 457 of file OgreMovableObject.h.

const LightList& Ogre::Frustum::getLights ( void  ) const
virtual

Overridden from Renderable.

Implements Ogre::Renderable.

virtual Listener* Ogre::MovableObject::getListener ( void  ) const
inlinevirtualinherited

Gets the current listener for this object.

Definition at line 431 of file OgreMovableObject.h.

const MaterialPtr& Ogre::Frustum::getMaterial ( void  ) const
virtual

Overridden from Renderable.

Implements Ogre::Renderable.

const String& Ogre::Frustum::getMovableType ( void  ) const
virtual

Overridden from MovableObject.

Implements Ogre::MovableObject.

virtual const String& Ogre::MovableObject::getName ( void  ) const
inlinevirtualinherited

Returns the name of this object.

Definition at line 190 of file OgreMovableObject.h.

virtual Real Ogre::Frustum::getNearClipDistance ( void  ) const
virtual

Sets the position of the near clipping plane.

Reimplemented in Ogre::Camera.

virtual unsigned short Ogre::Renderable::getNumWorldTransforms ( void  ) const
inlinevirtualinherited

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 152 of file OgreRenderable.h.

virtual const Quaternion& Ogre::Frustum::getOrientationForViewUpdate ( void  ) const
virtual

Get the derived orientation of this frustum.

Reimplemented in Ogre::Camera.

OrientationMode Ogre::Frustum::getOrientationMode ( ) const

Get the orientation mode of the frustum.

Remarks
Getting the orientation of a frustum is only supported on iPhone at this time. An exception is thrown on other platforms.
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 Node* Ogre::MovableObject::getParentNode ( void  ) const
virtualinherited

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
virtualinherited

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.
PlaneBoundedVolume Ogre::Frustum::getPlaneBoundedVolume ( )

Gets a world-space list of planes enclosing the frustum.

Real Ogre::MovableObject::getPointExtrusionDistance ( const Light l) const
virtualinherited

Get the distance to extrude for a point/spot light.

Implements Ogre::ShadowCaster.

virtual bool Ogre::Renderable::getPolygonModeOverrideable ( void  ) const
inlinevirtualinherited

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

Reimplemented in Ogre::BorderRenderable.

Definition at line 313 of file OgreRenderable.h.

virtual const Vector3& Ogre::Frustum::getPositionForViewUpdate ( void  ) const
virtual

Get the derived position of this frustum.

Reimplemented in Ogre::Camera.

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::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 ProjectionType Ogre::Frustum::getProjectionType ( void  ) const
virtual

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

virtual uint32 Ogre::MovableObject::getQueryFlags ( void  ) const
inlinevirtualinherited

Returns the query flags relevant for this object.

Reimplemented in Ogre::TerrainQuadTreeNode::Movable.

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

virtual const Matrix4& Ogre::Frustum::getReflectionMatrix ( void  ) const
inlinevirtual

Returns the reflection matrix of the frustum if appropriate.

Definition at line 567 of file OgreFrustum.h.

virtual const Plane& Ogre::Frustum::getReflectionPlane ( void  ) const
inlinevirtual

Returns the reflection plane of the frustum if appropriate.

Definition at line 569 of file OgreFrustum.h.

virtual Real Ogre::MovableObject::getRenderingDistance ( void  ) const
inlinevirtualinherited

Gets the distance at which batches are no longer rendered.

Definition at line 301 of file OgreMovableObject.h.

void Ogre::Frustum::getRenderOperation ( RenderOperation op)
virtual

Overridden from Renderable.

Implements Ogre::Renderable.

virtual uint8 Ogre::MovableObject::getRenderQueueGroup ( void  ) const
virtualinherited

Gets the queue group for this entity, see setRenderQueueGroup for full details.

virtual RenderSystemData* Ogre::Renderable::getRenderSystemData ( ) const
inlinevirtualinherited

Sets render system private data.

Remarks
This should only be used by a render system

Definition at line 380 of file OgreRenderable.h.

ShadowRenderableListIterator Ogre::MovableObject::getShadowVolumeRenderableIterator ( ShadowTechnique  shadowTechnique,
const Light light,
HardwareIndexBufferSharedPtr indexBuffer,
bool  extrudeVertices,
Real  extrusionDist,
unsigned long  flags = 0 
)
virtualinherited

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::StaticGeometry::Region.

Real Ogre::Frustum::getSquaredViewDepth ( const Camera cam) const
virtual

Overridden from Renderable.

Implements Ogre::Renderable.

virtual Technique* Ogre::Renderable::getTechnique ( void  ) const
inlinevirtualinherited

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::TerrainQuadTreeNode::Rend, Ogre::StaticGeometry::GeometryBucket, Ogre::InstancedGeometry::GeometryBucket, and Ogre::SubEntity.

Definition at line 93 of file OgreRenderable.h.

uint32 Ogre::Frustum::getTypeFlags ( void  ) const
virtual

Overridden from MovableObject::getTypeFlags.

Reimplemented from Ogre::MovableObject.

bool Ogre::Renderable::getUseIdentityProjection ( void  ) const
inlineinherited

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 177 of file OgreRenderable.h.

bool Ogre::Renderable::getUseIdentityView ( void  ) const
inlineinherited

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 202 of file OgreRenderable.h.

virtual const Any& Ogre::MovableObject::getUserAny ( void  ) const
inlinevirtualinherited
Deprecated:
use UserObjectBindings::getUserAny via getUserObjectBindings() instead. Retrieves the custom user value associated with this object.

Definition at line 315 of file OgreMovableObject.h.

virtual const Any& Ogre::Renderable::getUserAny ( void  ) const
inlinevirtualinherited
Deprecated:
use UserObjectBindings::getUserAny via getUserObjectBindings() instead. Retrieves the custom user value associated with this object.

Definition at line 330 of file OgreRenderable.h.

UserObjectBindings& Ogre::MovableObject::getUserObjectBindings ( )
inlineinherited

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also
UserObjectBindings::setUserAny.

Definition at line 321 of file OgreMovableObject.h.

const UserObjectBindings& Ogre::MovableObject::getUserObjectBindings ( ) const
inlineinherited

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also
UserObjectBindings::setUserAny.

Definition at line 327 of file OgreMovableObject.h.

UserObjectBindings& Ogre::Renderable::getUserObjectBindings ( )
inlineinherited

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also
UserObjectBindings::setUserAny.

Definition at line 336 of file OgreRenderable.h.

const UserObjectBindings& Ogre::Renderable::getUserObjectBindings ( ) const
inlineinherited

Return an instance of user objects binding associated with this class.

You can use it to associate one or more custom objects with this class instance.

See also
UserObjectBindings::setUserAny.

Definition at line 342 of file OgreRenderable.h.

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 uint32 Ogre::MovableObject::getVisibilityFlags ( void  ) const
inlinevirtualinherited

Returns the visibility flags relevant for this object.

Reimplemented in Ogre::TerrainQuadTreeNode::Movable.

Definition at line 412 of file OgreMovableObject.h.

virtual bool Ogre::MovableObject::getVisible ( void  ) const
virtualinherited

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 const AxisAlignedBox& Ogre::MovableObject::getWorldBoundingBox ( bool  derive = false) const
virtualinherited

Retrieves the axis-aligned bounding box for this object in world coordinates.

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::Entity, and Ogre::PortalBase.

virtual const Sphere& Ogre::MovableObject::getWorldBoundingSphere ( bool  derive = false) const
virtualinherited

Retrieves the worldspace bounding sphere for this object.

Reimplemented in Ogre::Entity, and Ogre::PortalBase.

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.

void Ogre::Frustum::getWorldTransforms ( Matrix4 xform) const
virtual

Overridden from Renderable.

Implements Ogre::Renderable.

bool Ogre::MovableObject::hasEdgeList ( void  )
inlinevirtualinherited

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::StaticGeometry::Region.

Definition at line 477 of file OgreMovableObject.h.

virtual void Ogre::AnimableObject::initialiseAnimableDictionary ( StringVector ) const
inlineprotectedvirtualinherited

Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters.

Reimplemented in Ogre::Light.

Definition at line 286 of file OgreAnimable.h.

virtual void Ogre::Frustum::invalidateFrustum ( void  ) const
protectedvirtual

Signal to update frustum information.

Reimplemented in Ogre::Camera.

virtual void Ogre::Frustum::invalidateView ( void  ) const
protectedvirtual

Signal to update view information.

Reimplemented in Ogre::Camera.

virtual bool Ogre::MovableObject::isAttached ( void  ) const
virtualinherited

Returns true if this object is attached to a SceneNode or TagPoint.

virtual bool Ogre::Frustum::isCustomNearClipPlaneEnabled ( void  ) const
inlinevirtual

Is a custom near clip plane in use?

Definition at line 634 of file OgreFrustum.h.

virtual bool Ogre::Frustum::isCustomProjectionMatrixEnabled ( void  ) const
inlinevirtual

Returns whether a custom projection matrix is in use.

Definition at line 416 of file OgreFrustum.h.

virtual bool Ogre::Frustum::isCustomViewMatrixEnabled ( void  ) const
inlinevirtual

Returns whether a custom view matrix is in use.

Definition at line 391 of file OgreFrustum.h.

virtual bool Ogre::MovableObject::isDebugDisplayEnabled ( void  ) const
inlinevirtualinherited

Gets whether debug display of this object is enabled.

Definition at line 546 of file OgreMovableObject.h.

virtual bool Ogre::Frustum::isFrustumOutOfDate ( void  ) const
protectedvirtual
virtual bool Ogre::MovableObject::isInScene ( void  ) const
virtualinherited

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 bool Ogre::MovableObject::isParentTagPoint ( ) const
inlinevirtualinherited

Gets whether the parent node is a TagPoint (or a SceneNode)

Definition at line 213 of file OgreMovableObject.h.

virtual bool Ogre::Frustum::isReflected ( void  ) const
inlinevirtual

Returns whether this frustum is being reflected.

Definition at line 565 of file OgreFrustum.h.

virtual bool Ogre::Frustum::isViewOutOfDate ( void  ) const
protectedvirtual

Reimplemented in Ogre::Camera.

virtual bool Ogre::MovableObject::isVisible ( void  ) const
virtualinherited

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, Ogre::StaticGeometry::Region, and Ogre::TerrainQuadTreeNode::Movable.

virtual bool Ogre::Frustum::isVisible ( const AxisAlignedBox bound,
FrustumPlane culledBy = 0 
) const
virtual

Tests whether the given container is visible in the Frustum.

Parameters
boundBounding box to be checked (world space)
culledByOptional 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, and Ogre::PCZCamera.

virtual bool Ogre::Frustum::isVisible ( const Sphere bound,
FrustumPlane culledBy = 0 
) const
virtual

Tests whether the given container is visible in the Frustum.

Parameters
boundBounding sphere to be checked (world space)
culledByOptional 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
vertVertex to be checked (world space)
culledByOptional 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.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 72 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 85 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 90 of file OgreMemoryAllocatedObject.h.

virtual void Ogre::Renderable::postRender ( SceneManager sm,
RenderSystem rsys 
)
inlinevirtualinherited

Called immediately after the Renderable has been rendered.

Definition at line 127 of file OgreRenderable.h.

virtual bool Ogre::Renderable::preRender ( SceneManager sm,
RenderSystem rsys 
)
inlinevirtualinherited

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 122 of file OgreRenderable.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
sphereThe world-space sphere to project
radiusRadius of the sphere
left,top,right,bottomPointers 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 const LightList& Ogre::MovableObject::queryLights ( void  ) const
virtualinherited

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 void Ogre::MovableObject::removeQueryFlags ( uint32  flags)
inlinevirtualinherited

As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.

Definition at line 381 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::removeVisibilityFlags ( uint32  flags)
inlinevirtualinherited

As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object.

Definition at line 409 of file OgreMovableObject.h.

virtual void Ogre::Frustum::resetFrustumExtents ( )
virtual

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

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.
void Ogre::MovableObject::setCastShadows ( bool  enabled)
inlineinherited

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 500 of file OgreMovableObject.h.

void Ogre::Renderable::setCustomParameter ( size_t  index,
const Vector4 value 
)
inlineinherited

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
indexThe 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.
valueThe value to associate.

Definition at line 240 of file OgreRenderable.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
enableIf 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.
projectionMatrixThe custom view matrix to use
See also
Frustum::setCustomViewMatrix
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
enableIf 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.
viewMatrixThe custom view matrix to use, the matrix must be an affine matrix.
See also
Frustum::setCustomProjectionMatrix, Matrix4::isAffine
virtual void Ogre::MovableObject::setDebugDisplayEnabled ( bool  enabled)
inlinevirtualinherited

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 544 of file OgreMovableObject.h.

static void Ogre::MovableObject::setDefaultQueryFlags ( uint32  flags)
inlinestaticinherited

Set the default query flags for all future MovableObject instances.

Definition at line 388 of file OgreMovableObject.h.

static void Ogre::MovableObject::setDefaultVisibilityFlags ( uint32  flags)
inlinestaticinherited

Set the default visibility flags for all future MovableObject instances.

Definition at line 416 of file OgreMovableObject.h.

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
farThe 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 void Ogre::Frustum::setFocalLength ( Real  focalLength = 1.0)
virtual

Sets frustum focal length (used in stereo rendering).

Parameters
focalLengthThe distance to the focal plane from the frustum in world coordinates.
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 void Ogre::Frustum::setFrustumExtents ( Real  left,
Real  right,
Real  top,
Real  bottom 
)
virtual

Manually set the extents of the frustum.

Parameters
left,right,top,bottomThe position where the side clip planes intersect the near clip plane, in eye space
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
offsetThe 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
horizontalThe horizontal plane offset.
verticalThe vertical plane offset.
virtual void Ogre::MovableObject::setLightMask ( uint32  lightMask)
virtualinherited

Set a bitwise mask which will filter the lights affecting this object.

Remarks
This mask will be compared against the mask held against Light to determine if a light should affect a given object. By default, this mask is fully set meaning all lights will affect this object
virtual void Ogre::MovableObject::setListener ( Listener listener)
inlinevirtualinherited

Sets a listener for this object.

Remarks
Note for size and performance reasons only one listener per object is allowed.

Definition at line 427 of file OgreMovableObject.h.

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
nearThe distance to the near clipping plane from the frustum in world coordinates.
void Ogre::Frustum::setOrientationMode ( OrientationMode  orientationMode)

Set the orientation mode of the frustum.

Default is OR_DEGREE_0

Remarks
Setting the orientation of a frustum is only supported on iPhone at this time. An exception is thrown on other platforms.
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,hThe 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
hThe 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
wThe width of the view window in world units
virtual void Ogre::Renderable::setPolygonModeOverrideable ( bool  override)
inlinevirtualinherited

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

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

Definition at line 305 of file OgreRenderable.h.

virtual void Ogre::Frustum::setProjectionType ( ProjectionType  pt)
virtual

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

Default is perspective.

Reimplemented in Ogre::PCZCamera.

virtual void Ogre::MovableObject::setQueryFlags ( uint32  flags)
inlinevirtualinherited

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 373 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setRenderingDistance ( Real  dist)
inlinevirtualinherited

Sets the distance at which the object is no longer rendered.

Parameters
distDistance beyond which the object will not be rendered (the default is 0, which means objects are always rendered).

Definition at line 295 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setRenderQueueGroup ( uint8  queueID)
virtualinherited

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
queueIDEnumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here.

Reimplemented in Ogre::ParticleSystem, and Ogre::Entity.

virtual void Ogre::MovableObject::setRenderQueueGroupAndPriority ( uint8  queueID,
ushort  priority 
)
virtualinherited

Sets the render queue group and group priority this entity will be rendered through.

Remarks
Render queues are grouped to allow you to more tightly control the ordering of rendered objects. Within a single render group there another type of grouping called priority which allows further control. If you do not call this method, all Entity objects default to the default queue and priority (RenderQueue::getDefaultQueueGroup, RenderQueue::getDefaultRenderablePriority), 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
queueIDEnumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here.
priorityThe priority within a group to use.

Reimplemented in Ogre::Entity.

virtual void Ogre::Renderable::setRenderSystemData ( RenderSystemData val) const
inlinevirtualinherited

gets render system private data

Remarks
This should only be used by a render system

Definition at line 388 of file OgreRenderable.h.

void Ogre::Renderable::setUseIdentityProjection ( bool  useIdentityProjection)
inlineinherited

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 163 of file OgreRenderable.h.

void Ogre::Renderable::setUseIdentityView ( bool  useIdentityView)
inlineinherited

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 188 of file OgreRenderable.h.

virtual void Ogre::MovableObject::setUserAny ( const Any anything)
inlinevirtualinherited
Deprecated:
use UserObjectBindings::setUserAny via getUserObjectBindings() instead.

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.

Definition at line 310 of file OgreMovableObject.h.

virtual void Ogre::Renderable::setUserAny ( const Any anything)
inlinevirtualinherited
Deprecated:
use UserObjectBindings::setUserAny via getUserObjectBindings() instead.

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 325 of file OgreRenderable.h.

virtual void Ogre::MovableObject::setVisibilityFlags ( uint32  flags)
inlinevirtualinherited

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 401 of file OgreMovableObject.h.

virtual void Ogre::MovableObject::setVisible ( bool  visible)
virtualinherited

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 void Ogre::ShadowCaster::updateEdgeListLightFacing ( EdgeData edgeData,
const Vector4 lightPos 
)
protectedvirtualinherited

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
edgeDataThe edge information to update
lightPos4D vector representing the light, a directional light has w=0.0
virtual void Ogre::Frustum::updateFrustum ( void  ) const
protectedvirtual

Update frustum if out of date.

virtual void Ogre::Frustum::updateFrustumImpl ( void  ) const
protectedvirtual

Implementation of updateFrustum (called if out of date)

virtual void Ogre::Frustum::updateFrustumPlanes ( void  ) const
protectedvirtual
virtual void Ogre::Frustum::updateFrustumPlanesImpl ( void  ) const
protectedvirtual

Implementation of updateFrustumPlanes (called if out of date)

virtual void Ogre::Frustum::updateVertexData ( void  ) const
protectedvirtual
virtual void Ogre::Frustum::updateView ( void  ) const
protectedvirtual

Update view if out of date.

virtual void Ogre::Frustum::updateViewImpl ( void  ) const
protectedvirtual

Implementation of updateView (called if out of date)

virtual void Ogre::Frustum::updateWorldSpaceCorners ( void  ) const
protectedvirtual
virtual void Ogre::Frustum::updateWorldSpaceCornersImpl ( void  ) const
protectedvirtual

Implementation of updateWorldSpaceCorners (called if out of date)

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
visitorPointer to a class implementing the Renderable::Visitor interface which will be called back for each Renderable which will be queued. Bear in mind that the state of the Renderable instances may not be finalised depending on when you call this.
debugRenderablesIf false, only regular renderables will be visited (those for normal display). If true, debug renderables will be included too.

Implements Ogre::MovableObject.

Member Data Documentation

const Real Ogre::Frustum::INFINITE_FAR_PLANE_ADJUST
static

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

Definition at line 642 of file OgreFrustum.h.

Real Ogre::Frustum::mAspect
protected

x/y viewport ratio - default 1.3333

Definition at line 97 of file OgreFrustum.h.

bool Ogre::MovableObject::mBeyondFarDistance
protectedinherited

Hidden because of distance?

Definition at line 125 of file OgreMovableObject.h.

Real Ogre::Frustum::mBottom
mutableprotected

Definition at line 137 of file OgreFrustum.h.

AxisAlignedBox Ogre::Frustum::mBoundingBox
mutableprotected

Definition at line 168 of file OgreFrustum.h.

bool Ogre::MovableObject::mCastShadows
protectedinherited

Does this object cast shadows?

Definition at line 147 of file OgreMovableObject.h.

MovableObjectFactory* Ogre::MovableObject::mCreator
protectedinherited

Creator of this object (if created by a factory)

Definition at line 111 of file OgreMovableObject.h.

CustomParameterMap Ogre::Renderable::mCustomParameters
protectedinherited

Definition at line 396 of file OgreRenderable.h.

bool Ogre::Frustum::mCustomProjMatrix
protected

Are we using a custom projection matrix?

Definition at line 133 of file OgreFrustum.h.

bool Ogre::Frustum::mCustomViewMatrix
protected

Are we using a custom view matrix?

Definition at line 131 of file OgreFrustum.h.

bool Ogre::MovableObject::mDebugDisplay
protectedinherited

Is debug display enabled?

Definition at line 120 of file OgreMovableObject.h.

Real Ogre::Frustum::mFarDist
protected

Far clip distance - default 10000.

Definition at line 93 of file OgreFrustum.h.

Real Ogre::Frustum::mFocalLength
protected

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

Definition at line 103 of file OgreFrustum.h.

Radian Ogre::Frustum::mFOVy
protected

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

Definition at line 91 of file OgreFrustum.h.

bool Ogre::Frustum::mFrustumExtentsManuallySet
protected

Have the frustum extents been manually set?

Definition at line 135 of file OgreFrustum.h.

Vector2 Ogre::Frustum::mFrustumOffset
protected

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

Definition at line 101 of file OgreFrustum.h.

Plane Ogre::Frustum::mFrustumPlanes[6]
mutableprotected

The 6 main clipping planes.

Definition at line 106 of file OgreFrustum.h.

Plane Ogre::Frustum::mLastLinkedObliqueProjPlane
mutableprotected

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

Definition at line 192 of file OgreFrustum.h.

Plane Ogre::Frustum::mLastLinkedReflectionPlane
mutableprotected

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

Definition at line 183 of file OgreFrustum.h.

Quaternion Ogre::Frustum::mLastParentOrientation
mutableprotected

Stored versions of parent orientation / position.

Definition at line 109 of file OgreFrustum.h.

Vector3 Ogre::Frustum::mLastParentPosition
mutableprotected

Definition at line 110 of file OgreFrustum.h.

Real Ogre::Frustum::mLeft
mutableprotected

Frustum extents.

Definition at line 137 of file OgreFrustum.h.

LightList Ogre::MovableObject::mLightList
mutableprotectedinherited

List of lights for this object.

Definition at line 155 of file OgreMovableObject.h.

ulong Ogre::MovableObject::mLightListUpdated
mutableprotectedinherited

The last frame that this light list was updated in.

Definition at line 157 of file OgreMovableObject.h.

uint32 Ogre::MovableObject::mLightMask
protectedinherited

the light mask defined for this movable. This will be taken into consideration when deciding which light should affect this movable

Definition at line 160 of file OgreMovableObject.h.

const MovablePlane* Ogre::Frustum::mLinkedObliqueProjPlane
protected

Pointer to oblique projection plane (automatically updated)

Definition at line 190 of file OgreFrustum.h.

const MovablePlane* Ogre::Frustum::mLinkedReflectPlane
protected

Pointer to a reflection plane (automatically updated)

Definition at line 181 of file OgreFrustum.h.

Listener* Ogre::MovableObject::mListener
protectedinherited

MovableObject listener - only one allowed (no list) for size & performance reasons. */.

Definition at line 152 of file OgreMovableObject.h.

SceneManager* Ogre::MovableObject::mManager
protectedinherited

SceneManager holding this object (if applicable)

Definition at line 113 of file OgreMovableObject.h.

MaterialPtr Ogre::Frustum::mMaterial
protected

Definition at line 171 of file OgreFrustum.h.

String Ogre::MovableObject::mName
protectedinherited

Name of this object.

Definition at line 109 of file OgreMovableObject.h.

Real Ogre::Frustum::mNearDist
protected

Near clip distance - default 100.

Definition at line 95 of file OgreFrustum.h.

bool Ogre::Frustum::mObliqueDepthProjection
protected

Is this frustum using an oblique depth projection?

Definition at line 186 of file OgreFrustum.h.

Plane Ogre::Frustum::mObliqueProjPlane
mutableprotected

Fixed oblique projection plane.

Definition at line 188 of file OgreFrustum.h.

OrientationMode Ogre::Frustum::mOrientationMode
mutableprotected

Frustum orientation mode.

Definition at line 139 of file OgreFrustum.h.

Real Ogre::Frustum::mOrthoHeight
protected

Ortho height size (world units)

Definition at line 99 of file OgreFrustum.h.

bool Ogre::MovableObject::mParentIsTagPoint
protectedinherited

Definition at line 116 of file OgreMovableObject.h.

Node* Ogre::MovableObject::mParentNode
protectedinherited

node to which this object is attached

Definition at line 115 of file OgreMovableObject.h.

bool Ogre::Renderable::mPolygonModeOverrideable
protectedinherited

Definition at line 397 of file OgreRenderable.h.

Matrix4 Ogre::Frustum::mProjMatrix
mutableprotected

Pre-calced standard projection matrix.

Definition at line 117 of file OgreFrustum.h.

Matrix4 Ogre::Frustum::mProjMatrixRS
mutableprotected

Pre-calced projection matrix for the specific render system.

Definition at line 113 of file OgreFrustum.h.

Matrix4 Ogre::Frustum::mProjMatrixRSDepth
mutableprotected

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

Definition at line 115 of file OgreFrustum.h.

ProjectionType Ogre::Frustum::mProjType
protected

Orthographic or perspective?

Definition at line 88 of file OgreFrustum.h.

uint32 Ogre::MovableObject::mQueryFlags
protectedinherited

Flags determining whether this object is included / excluded from scene queries.

Definition at line 137 of file OgreMovableObject.h.

bool Ogre::Frustum::mRecalcFrustum
mutableprotected

Something's changed in the frustum shape?

Definition at line 121 of file OgreFrustum.h.

bool Ogre::Frustum::mRecalcFrustumPlanes
mutableprotected

Something re the frustum planes has changed.

Definition at line 125 of file OgreFrustum.h.

bool Ogre::Frustum::mRecalcVertexData
mutableprotected

Something re the vertex data has changed.

Definition at line 129 of file OgreFrustum.h.

bool Ogre::Frustum::mRecalcView
mutableprotected

Something re the view pos has changed.

Definition at line 123 of file OgreFrustum.h.

bool Ogre::Frustum::mRecalcWorldSpaceCorners
mutableprotected

Something re the world space corners has changed.

Definition at line 127 of file OgreFrustum.h.

bool Ogre::Frustum::mReflect
protected

Is this frustum to act as a reflection of itself?

Definition at line 175 of file OgreFrustum.h.

Matrix4 Ogre::Frustum::mReflectMatrix
mutableprotected

Derived reflection matrix.

Definition at line 177 of file OgreFrustum.h.

Plane Ogre::Frustum::mReflectPlane
mutableprotected

Fixed reflection plane.

Definition at line 179 of file OgreFrustum.h.

bool Ogre::MovableObject::mRenderingDisabled
protectedinherited

Does rendering this object disabled by listener?

Definition at line 150 of file OgreMovableObject.h.

uint8 Ogre::MovableObject::mRenderQueueID
protectedinherited

The render queue to use when rendering this object.

Definition at line 129 of file OgreMovableObject.h.

bool Ogre::MovableObject::mRenderQueueIDSet
protectedinherited

Flags whether the RenderQueue's default should be used.

Definition at line 131 of file OgreMovableObject.h.

ushort Ogre::MovableObject::mRenderQueuePriority
protectedinherited

The render queue group to use when rendering this object.

Definition at line 133 of file OgreMovableObject.h.

bool Ogre::MovableObject::mRenderQueuePrioritySet
protectedinherited

Flags whether the RenderQueue's default should be used.

Definition at line 135 of file OgreMovableObject.h.

RenderSystemData* Ogre::Renderable::mRenderSystemData
mutableprotectedinherited

Definition at line 401 of file OgreRenderable.h.

Real Ogre::Frustum::mRight
mutableprotected

Definition at line 137 of file OgreFrustum.h.

AnimableDictionaryMap Ogre::AnimableObject::msAnimableDictionary
staticprotectedinherited

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

Definition at line 242 of file OgreAnimable.h.

uint32 Ogre::MovableObject::msDefaultQueryFlags
staticprotectedinherited

Default query flags.

Definition at line 164 of file OgreMovableObject.h.

uint32 Ogre::MovableObject::msDefaultVisibilityFlags
staticprotectedinherited

Default visibility flags.

Definition at line 166 of file OgreMovableObject.h.

String Ogre::Frustum::msMovableType
staticprotected

Shared class-level name for Movable type.

Definition at line 166 of file OgreFrustum.h.

Real Ogre::MovableObject::mSquaredUpperDistance
protectedinherited

Definition at line 123 of file OgreMovableObject.h.

Real Ogre::Frustum::mTop
mutableprotected

Definition at line 137 of file OgreFrustum.h.

Real Ogre::MovableObject::mUpperDistance
protectedinherited

Upper distance to still render.

Definition at line 122 of file OgreMovableObject.h.

bool Ogre::Renderable::mUseIdentityProjection
protectedinherited

Definition at line 398 of file OgreRenderable.h.

bool Ogre::Renderable::mUseIdentityView
protectedinherited

Definition at line 399 of file OgreRenderable.h.

UserObjectBindings Ogre::MovableObject::mUserObjectBindings
protectedinherited

User objects binding.

Definition at line 127 of file OgreMovableObject.h.

UserObjectBindings Ogre::Renderable::mUserObjectBindings
protectedinherited

Definition at line 400 of file OgreRenderable.h.

VertexData Ogre::Frustum::mVertexData
mutableprotected

Definition at line 169 of file OgreFrustum.h.

Matrix4 Ogre::Frustum::mViewMatrix
mutableprotected

Pre-calced view matrix.

Definition at line 119 of file OgreFrustum.h.

uint32 Ogre::MovableObject::mVisibilityFlags
protectedinherited

Flags determining whether this object is visible (compared to SceneManager mask)

Definition at line 139 of file OgreMovableObject.h.

bool Ogre::MovableObject::mVisible
protectedinherited

Is this object visible?

Definition at line 118 of file OgreMovableObject.h.

AxisAlignedBox Ogre::MovableObject::mWorldAABB
mutableprotectedinherited

Cached world AABB of this object.

Definition at line 141 of file OgreMovableObject.h.

Sphere Ogre::MovableObject::mWorldBoundingSphere
mutableprotectedinherited

Definition at line 143 of file OgreMovableObject.h.

AxisAlignedBox Ogre::MovableObject::mWorldDarkCapBounds
mutableprotectedinherited

World space AABB of this object's dark cap.

Definition at line 145 of file OgreMovableObject.h.

Vector3 Ogre::Frustum::mWorldSpaceCorners[8]
mutableprotected

Definition at line 172 of file OgreFrustum.h.


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