A frustum represents a pyramid, capped at the near and far end which is used to represent either a visible area or a projection area. More...
#include <OgreFrustum.h>
Public Types | |
typedef 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 StringVector & | getAnimableValueNames (void) const |
Gets a list of animable value names for this object. More... | |
virtual Real | getAspectRatio (void) const |
Retrieves the current aspect ratio. More... | |
const AxisAlignedBox & | getBoundingBox (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 Vector4 & | getCustomParameter (size_t index) const |
Gets the custom value associated with this Renderable at the given index. More... | |
const AxisAlignedBox & | getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const |
Overridden member from ShadowCaster. More... | |
EdgeData * | getEdgeList (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 Radian & | getFOVy (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 Vector2 & | getFrustumOffset () const |
Retrieves the frustum offsets. More... | |
virtual const Plane & | getFrustumPlane (unsigned short plane) const |
Retrieves a specified plane of the frustum (world space). More... | |
virtual const Plane * | getFrustumPlanes (void) const |
Retrieves the clipping planes of the frustum (world space). More... | |
const AxisAlignedBox & | getLightCapBounds (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 LightList & | getLights (void) const |
Overridden from Renderable. More... | |
virtual Listener * | getListener (void) const |
Gets the current listener for this object. More... | |
const MaterialPtr & | getMaterial (void) const |
Overridden from Renderable. More... | |
const String & | getMovableType (void) const |
Overridden from MovableObject. More... | |
virtual const String & | getName (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 Quaternion & | getOrientationForViewUpdate (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 Node * | getParentNode (void) const |
Returns the node to which this object is attached. More... | |
virtual SceneNode * | getParentSceneNode (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 Vector3 & | getPositionForViewUpdate (void) const |
Get the derived position of this frustum. More... | |
virtual const Matrix4 & | getProjectionMatrix (void) const |
Gets the normal projection matrix for this frustum, ie the projection matrix which conforms to standard right-handed rules and uses depth range [-1,+1]. More... | |
virtual const Matrix4 & | getProjectionMatrixRS (void) const |
Gets the projection matrix for this frustum adjusted for the current rendersystem specifics (may be right or left-handed, depth range may vary). More... | |
virtual const Matrix4 & | getProjectionMatrixWithRSDepth (void) const |
Gets the depth-adjusted projection matrix for the current rendersystem, but one which still conforms to right-hand rules. 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 Matrix4 & | getReflectionMatrix (void) const |
Returns the reflection matrix of the frustum if appropriate. More... | |
virtual const Plane & | getReflectionPlane (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... | |
virtual Real | getRenderingMinPixelSize () const |
Returns the minimum pixel size an object needs to be in both screen axes in order to be 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 RenderSystemData * | getRenderSystemData () const |
Gets RenderSystem private data. More... | |
ShadowRenderableListIterator | getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, size_t *indexBufferUsedSize, bool extrudeVertices, Real extrusionDist, unsigned long flags=0) |
Define a default implementation of method from ShadowCaster which implements no shadows. More... | |
Real | getSquaredViewDepth (const Camera *cam) const |
Overridden from Renderable. More... | |
virtual Technique * | getTechnique (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 OGRE_DEPRECATED const Any & | getUserAny (void) const |
virtual OGRE_DEPRECATED const Any & | getUserAny (void) const |
UserObjectBindings & | getUserObjectBindings () |
Return an instance of user objects binding associated with this class. More... | |
const UserObjectBindings & | getUserObjectBindings () const |
Return an instance of user objects binding associated with this class. More... | |
UserObjectBindings & | getUserObjectBindings () |
Return an instance of user objects binding associated with this class. More... | |
const UserObjectBindings & | getUserObjectBindings () const |
Return an instance of user objects binding associated with this class. More... | |
virtual const Matrix4 & | getViewMatrix (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 AxisAlignedBox & | getWorldBoundingBox (bool derive=false) const |
Retrieves the axis-aligned bounding box for this object in world coordinates. More... | |
virtual const Sphere & | getWorldBoundingSphere (bool derive=false) const |
Retrieves the worldspace bounding sphere for this object. More... | |
virtual const Vector3 * | getWorldSpaceCorners (void) const |
Gets the world space corners of the frustum. More... | |
void | getWorldTransforms (Matrix4 *xform) const |
Overridden from Renderable. More... | |
bool | hasCustomParameter (size_t index) const |
Checks whether a custom value is associated with this Renderable at the given index. 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 LightList & | queryLights (void) const |
Gets a list of lights, ordered relative to how close they are to this movable object. More... | |
void | removeCustomParameter (size_t index) |
Removes a custom value which is associated with this Renderable at the given index. 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 | setRenderingMinPixelSize (Real pixelSize) |
Sets the minimum pixel size an object needs to be in both screen axes in order to be 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 |
Sets RenderSystem 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 OGRE_DEPRECATED void | setUserAny (const Any &anything) |
virtual OGRE_DEPRECATED void | setUserAny (const Any &anything) |
virtual void | setVisibilityFlags (uint32 flags) |
Sets the visibility 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, size_t &indexBufferUsedSize, 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 String & | getAnimableDictionaryName (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... | |
MovableObjectFactory * | mCreator |
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 MovablePlane * | mLinkedObliqueProjPlane |
Pointer to oblique projection plane (automatically updated) More... | |
const MovablePlane * | mLinkedReflectPlane |
Pointer to a reflection plane (automatically updated) More... | |
Listener * | mListener |
MovableObject listener - only one allowed (no list) for size & performance reasons. */. More... | |
SceneManager * | mManager |
SceneManager holding this object (if applicable) More... | |
MaterialPtr | mMaterial |
Real | mMinPixelSize |
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 |
Node * | mParentNode |
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... | |
RenderSystemData * | mRenderSystemData |
User objects binding. More... | |
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... | |
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 85 of file OgreFrustum.h.
|
protectedinherited |
Definition at line 241 of file OgreAnimable.h.
|
protectedinherited |
Definition at line 414 of file OgreRenderable.h.
|
inherited |
Definition at line 136 of file OgreShadowCaster.h.
|
inherited |
Definition at line 137 of file OgreShadowCaster.h.
Ogre::Frustum::Frustum | ( | const String & | name = StringUtil::BLANK | ) |
Named constructor.
|
virtual |
|
inlineprotectedinherited |
Get an updateable reference to animable value list.
Definition at line 267 of file OgreAnimable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
inlinevirtualinherited |
Get the creator of this object, if any (internal use only)
Definition at line 186 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Returns a pointer to the current list of lights for this object.
Definition at line 491 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Get the manager of this object, if any (internal use only)
Definition at line 190 of file OgreMovableObject.h.
|
virtualinherited |
return the full transformation of the parent sceneNode or the attachingPoint node
Reimplemented in Ogre::InstancedEntity.
|
virtualinherited |
Internal method called to notify the object that it has been attached to a node.
Reimplemented in Ogre::Entity, Ogre::ParticleSystem, Ogre::Light, Ogre::PortalBase, and Ogre::InstancedEntity.
Referenced by Ogre::PortalBase::_notifyAttached().
|
inlinevirtualinherited |
Notify the object of it's creator (internal use only)
Definition at line 184 of file OgreMovableObject.h.
|
virtual |
Overridden from MovableObject.
Reimplemented from Ogre::MovableObject.
|
inlinevirtualinherited |
Notify the object of it's manager (internal use only)
Definition at line 188 of file OgreMovableObject.h.
|
virtualinherited |
Internal method called to notify the object that it has been moved.
Reimplemented in Ogre::Light, Ogre::PortalBase, Ogre::InstancedEntity, and Ogre::PCZLight.
|
inlinevirtualinherited |
Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.
constantEntry | The auto constant entry referring to the parameter being updated |
params | The parameters object which this method should call to set the updated parameters. |
Reimplemented in Ogre::SubEntity.
Definition at line 307 of file OgreRenderable.h.
References Ogre::GpuProgramParameters::_writeRawConstant(), Ogre::GpuProgramParameters::AutoConstantEntry::data, Ogre::GpuProgramParameters::AutoConstantEntry::elementCount, and Ogre::GpuProgramParameters::AutoConstantEntry::physicalIndex.
|
virtual |
Overridden from MovableObject.
Implements Ogre::MovableObject.
|
inlinevirtualinherited |
As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.
Definition at line 396 of file OgreMovableObject.h.
|
inlinevirtualinherited |
As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object.
Definition at line 424 of file OgreMovableObject.h.
|
protectedvirtual |
|
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)
|
inlineprotectedinherited |
Internal method for creating a dictionary of animable value names for the class, if it does not already exist.
Definition at line 254 of file OgreAnimable.h.
|
inlinevirtualinherited |
Create a reference-counted AnimableValuePtr for the named value.
Reimplemented in Ogre::Light.
Definition at line 320 of file OgreAnimable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
virtualinherited |
|
virtual |
Disables any custom near clip plane.
|
virtual |
Disables reflection modification previously turned on with enableReflection.
|
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.
plane | The plane to link to to perform the clipping. This plane must continue to exist while the camera is linked to it; do not destroy it before the frustum. |
|
virtual |
Links the frustum to a custom near clip plane, which can be used to clip geometry in a custom manner without using user clip planes.
plane | The plane to link to to perform the clipping. This plane must continue to exist while the camera is linked to it; do not destroy it before the frustum. |
|
virtual |
Modifies this frustum so it always renders from the reflection of itself through the plane specified.
|
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.
|
protectedvirtualinherited |
Utility method for extruding a bounding box.
box | Original bounding box, will be updated in-place. |
lightPos | 4D light position in object space, when w=0.0f this represents a directional light. |
extrudeDist | The distance to extrude. |
|
staticinherited |
Utility method for extruding vertices based on a light.
vertexBuffer | The vertex buffer containing ONLY xyz position values, which must be originalVertexCount * 2 * 3 floats long. |
originalVertexCount | The count of the original number of vertices, i.e. the number in the mesh, not counting the doubling which has already been done (by VertexData::prepareForShadowVolume) to provide the extruded area of the buffer. |
lightPos | 4D light position in object space, when w=0.0f this represents a directional light. |
extrudeDist | The distance to extrude. |
|
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.
edgeData | The edge information to use. |
indexBuffer | The buffer into which to write data into; current contents are assumed to be discardable. |
indexBufferUsedSize | If the rest of buffer is enough than it would be locked with HBL_NO_OVERWRITE semantic and indexBufferUsedSize would be increased, otherwise HBL_DISCARD would be used and indexBufferUsedSize would be reset. |
light | The light, mainly for type info as silhouette calculations should already have been done in updateEdgeListLightFacing |
shadowRenderables | A list of shadow renderables which has already been constructed but will need populating with details of the index ranges to be used. |
flags | Additional controller flags, see ShadowRenderableFlags. |
|
inlineprotectedvirtualinherited |
Get the name of the animable dictionary for this class.
Reimplemented in Ogre::Light.
Definition at line 249 of file OgreAnimable.h.
References Ogre::StringUtil::BLANK.
|
inlineinherited |
Gets a list of animable value names for this object.
Definition at line 295 of file OgreAnimable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
virtual |
Retrieves the current aspect ratio.
|
virtual |
|
virtual |
Overridden from MovableObject.
Implements Ogre::MovableObject.
|
inlinevirtualinherited |
Returns whether shadow casting is enabled for this object.
Implements Ogre::ShadowCaster.
Reimplemented in Ogre::TerrainQuadTreeNode::Movable.
Definition at line 521 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Method which reports whether this renderable would normally cast a shadow.
Reimplemented in Ogre::TerrainQuadTreeNode::Rend, Ogre::SubEntity, Ogre::InstancedGeometry::GeometryBucket, and Ogre::StaticGeometry::GeometryBucket.
Definition at line 224 of file OgreRenderable.h.
|
inlineinherited |
Gets the custom value associated with this Renderable at the given index.
index | Index of the parameter to retrieve. |
Definition at line 268 of file OgreRenderable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
virtualinherited |
Overridden member from ShadowCaster.
Implements Ogre::ShadowCaster.
|
inlinestaticinherited |
Get the default query flags for all future MovableObject instances.
Definition at line 411 of file OgreMovableObject.h.
|
inlinestaticinherited |
Get the default visibility flags for all future MovableObject instances.
Definition at line 439 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Define a default implementation of method from ShadowCaster which implements no shadows.
Implements Ogre::ShadowCaster.
Reimplemented in Ogre::StaticGeometry::Region.
Definition at line 494 of file OgreMovableObject.h.
|
protectedinherited |
Helper method for calculating extrusion distance.
|
virtual |
Retrieves the distance from the frustum to the far clipping plane.
Reimplemented in Ogre::Camera.
|
virtual |
Returns focal length of frustum.
|
virtual |
Retrieves the frustums Y-dimension Field Of View (FOV).
|
virtual |
Get the extents of the frustum in view space.
|
virtual |
Retrieves the frustum offsets.
|
virtual |
Retrieves a specified plane of the frustum (world space).
Reimplemented in Ogre::Camera.
|
virtual |
Retrieves the clipping planes of the frustum (world space).
|
virtualinherited |
Overridden member from ShadowCaster.
Implements Ogre::ShadowCaster.
|
inlinevirtualinherited |
Get a bitwise mask which will filter the lights affecting this object.
Definition at line 476 of file OgreMovableObject.h.
|
virtual |
Overridden from Renderable.
Implements Ogre::Renderable.
|
inlinevirtualinherited |
Gets the current listener for this object.
Definition at line 450 of file OgreMovableObject.h.
|
virtual |
Overridden from Renderable.
Implements Ogre::Renderable.
|
virtual |
Overridden from MovableObject.
Implements Ogre::MovableObject.
|
inlinevirtualinherited |
Returns the name of this object.
Definition at line 193 of file OgreMovableObject.h.
|
virtual |
Sets the position of the near clipping plane.
Reimplemented in Ogre::Camera.
|
inlinevirtualinherited |
Returns the number of world transform matrices this renderable requires.
Reimplemented in Ogre::BorderRenderable, Ogre::SubEntity, Ogre::InstancedGeometry::GeometryBucket, Ogre::BaseInstanceBatchVTF, Ogre::InstanceBatchHW, and Ogre::InstanceBatchShader.
Definition at line 153 of file OgreRenderable.h.
|
virtual |
Get the derived orientation of this frustum.
Reimplemented in Ogre::Camera.
OrientationMode Ogre::Frustum::getOrientationMode | ( | ) | const |
Get the orientation mode of the frustum.
|
virtual |
Gets the orthographic window height, for use with orthographic rendering only.
|
virtual |
Gets the orthographic window width, for use with orthographic rendering only.
|
virtualinherited |
Returns the node to which this object is attached.
|
virtualinherited |
Returns the scene node to which this object is attached.
PlaneBoundedVolume Ogre::Frustum::getPlaneBoundedVolume | ( | ) |
Gets a world-space list of planes enclosing the frustum.
Get the distance to extrude for a point/spot light.
Implements Ogre::ShadowCaster.
|
inlinevirtualinherited |
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
Reimplemented in Ogre::BorderRenderable.
Definition at line 332 of file OgreRenderable.h.
|
virtual |
Get the derived position of this frustum.
Reimplemented in Ogre::Camera.
|
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].
|
virtual |
Gets the projection matrix for this frustum adjusted for the current rendersystem specifics (may be right or left-handed, depth range may vary).
|
virtual |
Gets the depth-adjusted projection matrix for the current rendersystem, but one which still conforms to right-hand rules.
|
virtual |
Retrieves info on the type of projection used (orthographic or perspective).
|
inlinevirtualinherited |
Returns the query flags relevant for this object.
Reimplemented in Ogre::TerrainQuadTreeNode::Movable.
Definition at line 403 of file OgreMovableObject.h.
|
inherited |
Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows.
|
inlinevirtual |
Returns the reflection matrix of the frustum if appropriate.
Definition at line 574 of file OgreFrustum.h.
|
inlinevirtual |
Returns the reflection plane of the frustum if appropriate.
Definition at line 576 of file OgreFrustum.h.
|
inlinevirtualinherited |
Gets the distance at which batches are no longer rendered.
Definition at line 305 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered.
Definition at line 318 of file OgreMovableObject.h.
|
virtual |
Overridden from Renderable.
Implements Ogre::Renderable.
|
virtualinherited |
Gets the queue group for this entity, see setRenderQueueGroup for full details.
|
inlinevirtualinherited |
Gets RenderSystem private data.
Definition at line 399 of file OgreRenderable.h.
|
virtualinherited |
Define a default implementation of method from ShadowCaster which implements no shadows.
Implements Ogre::ShadowCaster.
Reimplemented in Ogre::StaticGeometry::Region.
Overridden from Renderable.
Implements Ogre::Renderable.
|
inlinevirtualinherited |
Retrieves a pointer to the Material Technique this renderable object uses.
Reimplemented in Ogre::TerrainQuadTreeNode::Rend, Ogre::InstanceBatch, Ogre::InstancedGeometry::GeometryBucket, Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity.
Definition at line 94 of file OgreRenderable.h.
|
virtual |
Overridden from MovableObject::getTypeFlags.
Reimplemented from Ogre::MovableObject.
|
inlineinherited |
Returns whether or not to use an 'identity' projection.
Definition at line 178 of file OgreRenderable.h.
|
inlineinherited |
Returns whether or not to use an 'identity' view.
Definition at line 203 of file OgreRenderable.h.
|
inlinevirtualinherited |
Definition at line 334 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Definition at line 349 of file OgreRenderable.h.
|
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.
Definition at line 340 of file OgreMovableObject.h.
|
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.
Definition at line 346 of file OgreMovableObject.h.
|
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.
Definition at line 355 of file OgreRenderable.h.
|
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.
Definition at line 361 of file OgreRenderable.h.
|
virtual |
Gets the view matrix for this frustum.
Mainly for use by OGRE internally.
Reimplemented in Ogre::Camera.
|
inlinevirtualinherited |
Returns the visibility flags relevant for this object.
Reimplemented in Ogre::TerrainQuadTreeNode::Movable.
Definition at line 431 of file OgreMovableObject.h.
|
virtualinherited |
Gets this object whether to be visible or not, if it has a renderable component.
|
virtualinherited |
Retrieves the axis-aligned bounding box for this object in world coordinates.
Implements Ogre::ShadowCaster.
Reimplemented in Ogre::Entity, and Ogre::PortalBase.
|
virtualinherited |
Retrieves the worldspace bounding sphere for this object.
Reimplemented in Ogre::Entity, and Ogre::PortalBase.
|
virtual |
Gets the world space corners of the frustum.
Reimplemented in Ogre::Camera.
|
virtual |
Overridden from Renderable.
Implements Ogre::Renderable.
|
inlineinherited |
Checks whether a custom value is associated with this Renderable at the given index.
index | Index of the parameter to check for existence. |
Definition at line 259 of file OgreRenderable.h.
|
inlinevirtualinherited |
Define a default implementation of method from ShadowCaster which implements no shadows.
Implements Ogre::ShadowCaster.
Reimplemented in Ogre::StaticGeometry::Region.
Definition at line 496 of file OgreMovableObject.h.
|
inlineprotectedvirtualinherited |
Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters.
Reimplemented in Ogre::Light.
Definition at line 287 of file OgreAnimable.h.
|
protectedvirtual |
Signal to update frustum information.
Reimplemented in Ogre::Camera.
|
protectedvirtual |
Signal to update view information.
Reimplemented in Ogre::Camera.
|
virtualinherited |
|
inlinevirtual |
Is a custom near clip plane in use?
Definition at line 651 of file OgreFrustum.h.
|
inlinevirtual |
Returns whether a custom projection matrix is in use.
Definition at line 418 of file OgreFrustum.h.
|
inlinevirtual |
Returns whether a custom view matrix is in use.
Definition at line 391 of file OgreFrustum.h.
|
inlinevirtualinherited |
Gets whether debug display of this object is enabled.
Definition at line 565 of file OgreMovableObject.h.
|
protectedvirtual |
|
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.
Reimplemented in Ogre::InstancedEntity.
|
inlinevirtualinherited |
Gets whether the parent node is a TagPoint (or a SceneNode)
Definition at line 216 of file OgreMovableObject.h.
|
inlinevirtual |
Returns whether this frustum is being reflected.
Definition at line 572 of file OgreFrustum.h.
|
protectedvirtual |
Reimplemented in Ogre::Camera.
|
virtualinherited |
Returns whether or not this object is supposed to be visible or not.
Reimplemented in Ogre::InstancedGeometry::BatchInstance, Ogre::StaticGeometry::Region, and Ogre::TerrainQuadTreeNode::Movable.
|
virtual |
Tests whether the given container is visible in the Frustum.
bound | Bounding box to be checked (world space). |
culledBy | Optional pointer to an int which will be filled by the plane number which culled the box if the result was false ; |
true
is returned. false
is returned. Reimplemented in Ogre::Camera, and Ogre::PCZCamera.
|
virtual |
Tests whether the given container is visible in the Frustum.
bound | Bounding sphere to be checked (world space). |
culledBy | Optional pointer to an int which will be filled by the plane number which culled the box if the result was false ; |
true
is returned. false
is returned. Reimplemented in Ogre::Camera.
|
virtual |
Tests whether the given vertex is visible in the Frustum.
vert | Vertex to be checked (world space). |
culledBy | Optional pointer to an int which will be filled by the plane number which culled the box if the result was false ; |
true
is returned. false
is returned. Reimplemented in Ogre::Camera.
|
inlineinherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
inlinevirtualinherited |
Called immediately after the Renderable has been rendered.
Definition at line 128 of file OgreRenderable.h.
|
inlinevirtualinherited |
Called just prior to the Renderable being rendered.
Reimplemented in Ogre::BillboardChain.
Definition at line 123 of file OgreRenderable.h.
|
virtual |
Project a sphere onto the near plane and get the bounding rectangle.
sphere | The world-space sphere to project. |
left | Pointers to destination values, these will be completed with the normalised device coordinates (in the range {-1,1}). |
top | Pointers to destination values, these will be completed with the normalised device coordinates (in the range {-1,1}). |
right | Pointers to destination values, these will be completed with the normalised device coordinates (in the range {-1,1}). |
bottom | Pointers to destination values, these will be completed with the normalised device coordinates (in the range {-1,1}). |
true
if the sphere was projected to a subset of the near plane, false
if the entire near plane was contained. Reimplemented in Ogre::Camera.
|
virtualinherited |
Gets a list of lights, ordered relative to how close they are to this movable object.
|
inlineinherited |
Removes a custom value which is associated with this Renderable at the given index.
index | Index of the parameter to remove. |
Definition at line 250 of file OgreRenderable.h.
|
inlinevirtualinherited |
As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.
Definition at line 400 of file OgreMovableObject.h.
|
inlinevirtualinherited |
As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object.
Definition at line 428 of file OgreMovableObject.h.
|
virtual |
Reset the frustum extents to be automatically derived from other params.
|
virtual |
Sets the aspect ratio for the frustum viewport.
|
inlineinherited |
Sets whether or not this object will cast shadows.
Definition at line 519 of file OgreMovableObject.h.
|
inlineinherited |
Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters.
index | The index with which to associate the value. Note that this does not have to start at 0, and can include gaps. It also has no direct correlation with a GPU program parameter index - the mapping between the two is performed by the ACT_CUSTOM entry, if that is used. |
value | The value to associate. |
Definition at line 241 of file OgreRenderable.h.
|
virtual |
Set whether to use a custom projection matrix on this frustum.
enable | If true , the custom projection matrix passed as the second parameter will be used in preference to an auto calculated one. If false , the frustum will revert to auto calculating the projection matrix. |
projectionMatrix | The custom view matrix to use. |
|
virtual |
Set whether to use a custom view matrix on this frustum.
enable | If true , the custom view matrix passed as the second parameter will be used in preference to an auto calculated one. If false, the frustum will revert to auto calculating the view matrix. |
viewMatrix | The custom view matrix to use, the matrix must be an affine matrix. |
|
inlinevirtualinherited |
Sets whether or not the debug display of this object is enabled.
Definition at line 563 of file OgreMovableObject.h.
|
inlinestaticinherited |
Set the default query flags for all future MovableObject instances.
Definition at line 407 of file OgreMovableObject.h.
|
inlinestaticinherited |
Set the default visibility flags for all future MovableObject instances.
Definition at line 435 of file OgreMovableObject.h.
|
virtual |
Sets the distance to the far clipping plane.
farDist | The distance to the far clipping plane from the frustum in world coordinates.If you specify 0, this means an infinite view distance which is useful especially when projecting shadows; but be careful not to use a near distance too close. |
|
virtual |
Sets frustum focal length (used in stereo rendering).
focalLength | The distance to the focal plane from the frustum in world coordinates. |
|
virtual |
Sets the Y-dimension Field Of View (FOV) of the frustum.
|
virtual |
Manually set the extents of the frustum.
left,right,top,bottom | The position where the side clip planes intersect the near clip plane, in eye space |
|
virtual |
Sets frustum offsets, used in stereo rendering.
offset | The horizontal and vertical plane offsets. |
Sets frustum offsets, used in stereo rendering.
horizontal | The horizontal plane offset. |
vertical | The vertical plane offset. |
|
virtualinherited |
Set a bitwise mask which will filter the lights affecting this object.
|
inlinevirtualinherited |
Sets a listener for this object.
Definition at line 446 of file OgreMovableObject.h.
|
virtual |
Sets the position of the near clipping plane.
nearDist | The 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
Sets the orthographic window settings, for use with orthographic rendering only.
w | The width of the view window in world units. |
h | The height of the view window in world units. |
|
virtual |
Sets the orthographic window height, for use with orthographic rendering only.
h | The height of the view window in world units. |
|
virtual |
Sets the orthographic window width, for use with orthographic rendering only.
w | The width of the view window in world units. |
|
inlinevirtualinherited |
Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
override | true means that a lower camera detail will override this renderables detail level, false means it won't. |
Definition at line 324 of file OgreRenderable.h.
|
virtual |
Sets the type of projection to use (orthographic or perspective).
Default is perspective.
Reimplemented in Ogre::PCZCamera.
|
inlinevirtualinherited |
Sets the query flags for this object.
Definition at line 392 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Sets the distance at which the object is no longer rendered.
dist | Distance beyond which the object will not be rendered (the default is 0, which means objects are always rendered). |
Definition at line 299 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered.
pixelSize | Number of minimum pixels (the default is 0, which means objects are always rendered). |
Definition at line 312 of file OgreMovableObject.h.
|
virtualinherited |
Sets the render queue group this entity will be rendered through.
queueID | Enumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here. |
Reimplemented in Ogre::ParticleSystem, and Ogre::Entity.
|
virtualinherited |
Sets the render queue group and group priority this entity will be rendered through.
queueID | Enumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here. |
priority | The priority within a group to use. |
Reimplemented in Ogre::ParticleSystem, and Ogre::Entity.
|
inlinevirtualinherited |
Sets RenderSystem private data.
Definition at line 407 of file OgreRenderable.h.
|
inlineinherited |
Sets whether or not to use an 'identity' projection.
Definition at line 164 of file OgreRenderable.h.
|
inlineinherited |
Sets whether or not to use an 'identity' view.
Definition at line 189 of file OgreRenderable.h.
|
inlinevirtualinherited |
Sets any kind of user value on this object.
Definition at line 329 of file OgreMovableObject.h.
|
inlinevirtualinherited |
Sets any kind of user value on this object.
Definition at line 344 of file OgreRenderable.h.
|
inlinevirtualinherited |
Sets the visibility flags for this object.
Definition at line 420 of file OgreMovableObject.h.
|
virtualinherited |
Tells this object whether to be visible or not, if it has a renderable component.
Reimplemented in Ogre::Light.
|
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.
edgeData | The edge information to update. |
lightPos | 4D vector representing the light, a directional light has w=0.0. |
|
protectedvirtual |
Update frustum if out of date.
|
protectedvirtual |
Implementation of updateFrustum (called if out of date)
|
protectedvirtual |
|
protectedvirtual |
Implementation of updateFrustumPlanes (called if out of date)
|
protectedvirtual |
|
protectedvirtual |
Update view if out of date.
|
protectedvirtual |
Implementation of updateView (called if out of date)
|
protectedvirtual |
|
protectedvirtual |
Implementation of updateWorldSpaceCorners (called if out of date)
|
virtual |
Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any.
visitor | Pointer to a class implementing the Renderable::Visitor interface which will be called back for each Renderable which will be queued. Bear in mind that the state of the Renderable instances may not be finalised depending on when you call this. |
debugRenderables | If false, only regular renderables will be visited (those for normal display). If true, debug renderables will be included too. |
Implements Ogre::MovableObject.
|
static |
Small constant used to reduce far plane projection to avoid inaccuracies.
Definition at line 659 of file OgreFrustum.h.
|
protected |
x/y viewport ratio - default 1.3333
Definition at line 98 of file OgreFrustum.h.
|
protectedinherited |
Hidden because of distance?
Definition at line 128 of file OgreMovableObject.h.
|
mutableprotected |
Definition at line 138 of file OgreFrustum.h.
|
mutableprotected |
Definition at line 169 of file OgreFrustum.h.
|
protectedinherited |
Does this object cast shadows?
Definition at line 150 of file OgreMovableObject.h.
|
protectedinherited |
Creator of this object (if created by a factory)
Definition at line 112 of file OgreMovableObject.h.
|
protectedinherited |
Definition at line 415 of file OgreRenderable.h.
|
protected |
Are we using a custom projection matrix?
Definition at line 134 of file OgreFrustum.h.
|
protected |
Are we using a custom view matrix?
Definition at line 132 of file OgreFrustum.h.
|
protectedinherited |
Is debug display enabled?
Definition at line 121 of file OgreMovableObject.h.
|
protected |
Far clip distance - default 10000.
Definition at line 94 of file OgreFrustum.h.
|
protected |
Focal length of frustum (for stereo rendering, defaults to 1.0)
Definition at line 104 of file OgreFrustum.h.
|
protected |
y-direction field-of-view (default 45)
Definition at line 92 of file OgreFrustum.h.
|
protected |
Have the frustum extents been manually set?
Definition at line 136 of file OgreFrustum.h.
|
protected |
Off-axis frustum center offset - default (0.0, 0.0)
Definition at line 102 of file OgreFrustum.h.
|
mutableprotected |
The 6 main clipping planes.
Definition at line 107 of file OgreFrustum.h.
|
mutableprotected |
Record of the last world-space oblique depth projection plane info used.
Definition at line 193 of file OgreFrustum.h.
|
mutableprotected |
Record of the last world-space reflection plane info used.
Definition at line 184 of file OgreFrustum.h.
|
mutableprotected |
Stored versions of parent orientation / position.
Definition at line 110 of file OgreFrustum.h.
|
mutableprotected |
Definition at line 111 of file OgreFrustum.h.
|
mutableprotected |
Frustum extents.
Definition at line 138 of file OgreFrustum.h.
|
mutableprotectedinherited |
List of lights for this object.
Definition at line 158 of file OgreMovableObject.h.
|
mutableprotectedinherited |
The last frame that this light list was updated in.
Definition at line 160 of file OgreMovableObject.h.
|
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 163 of file OgreMovableObject.h.
|
protected |
Pointer to oblique projection plane (automatically updated)
Definition at line 191 of file OgreFrustum.h.
|
protected |
Pointer to a reflection plane (automatically updated)
Definition at line 182 of file OgreFrustum.h.
|
protectedinherited |
MovableObject listener - only one allowed (no list) for size & performance reasons. */.
Definition at line 155 of file OgreMovableObject.h.
|
protectedinherited |
SceneManager holding this object (if applicable)
Definition at line 114 of file OgreMovableObject.h.
|
protected |
Definition at line 172 of file OgreFrustum.h.
|
protectedinherited |
Definition at line 126 of file OgreMovableObject.h.
|
protectedinherited |
Name of this object.
Definition at line 110 of file OgreMovableObject.h.
|
protected |
Near clip distance - default 100.
Definition at line 96 of file OgreFrustum.h.
|
protected |
Is this frustum using an oblique depth projection?
Definition at line 187 of file OgreFrustum.h.
|
mutableprotected |
Fixed oblique projection plane.
Definition at line 189 of file OgreFrustum.h.
|
mutableprotected |
Frustum orientation mode.
Definition at line 140 of file OgreFrustum.h.
|
protected |
Ortho height size (world units)
Definition at line 100 of file OgreFrustum.h.
|
protectedinherited |
Definition at line 117 of file OgreMovableObject.h.
|
protectedinherited |
node to which this object is attached
Definition at line 116 of file OgreMovableObject.h.
|
protectedinherited |
Definition at line 416 of file OgreRenderable.h.
|
mutableprotected |
Pre-calced standard projection matrix.
Definition at line 118 of file OgreFrustum.h.
|
mutableprotected |
Pre-calced projection matrix for the specific render system.
Definition at line 114 of file OgreFrustum.h.
|
mutableprotected |
Pre-calced standard projection matrix but with render system depth range.
Definition at line 116 of file OgreFrustum.h.
|
protected |
Orthographic or perspective?
Definition at line 89 of file OgreFrustum.h.
|
protectedinherited |
Flags determining whether this object is included / excluded from scene queries.
Definition at line 140 of file OgreMovableObject.h.
|
mutableprotected |
Something's changed in the frustum shape?
Definition at line 122 of file OgreFrustum.h.
|
mutableprotected |
Something re the frustum planes has changed.
Definition at line 126 of file OgreFrustum.h.
|
mutableprotected |
Something re the vertex data has changed.
Definition at line 130 of file OgreFrustum.h.
|
mutableprotected |
Something re the view pos has changed.
Definition at line 124 of file OgreFrustum.h.
|
mutableprotected |
Something re the world space corners has changed.
Definition at line 128 of file OgreFrustum.h.
|
protected |
Is this frustum to act as a reflection of itself?
Definition at line 176 of file OgreFrustum.h.
|
mutableprotected |
Derived reflection matrix.
Definition at line 178 of file OgreFrustum.h.
|
mutableprotected |
Fixed reflection plane.
Definition at line 180 of file OgreFrustum.h.
|
protectedinherited |
Does rendering this object disabled by listener?
Definition at line 153 of file OgreMovableObject.h.
|
protectedinherited |
The render queue to use when rendering this object.
Definition at line 132 of file OgreMovableObject.h.
|
protectedinherited |
Flags whether the RenderQueue's default should be used.
Definition at line 134 of file OgreMovableObject.h.
|
protectedinherited |
The render queue group to use when rendering this object.
Definition at line 136 of file OgreMovableObject.h.
|
protectedinherited |
Flags whether the RenderQueue's default should be used.
Definition at line 138 of file OgreMovableObject.h.
|
mutableprotectedinherited |
User objects binding.
Definition at line 420 of file OgreRenderable.h.
|
mutableprotected |
Definition at line 138 of file OgreFrustum.h.
|
staticprotectedinherited |
Static map of class name to list of animable value names.
Definition at line 243 of file OgreAnimable.h.
|
staticprotectedinherited |
Default query flags.
Definition at line 167 of file OgreMovableObject.h.
|
staticprotectedinherited |
Default visibility flags.
Definition at line 169 of file OgreMovableObject.h.
|
staticprotected |
Shared class-level name for Movable type.
Definition at line 167 of file OgreFrustum.h.
|
protectedinherited |
Definition at line 124 of file OgreMovableObject.h.
|
mutableprotected |
Definition at line 138 of file OgreFrustum.h.
|
protectedinherited |
Upper distance to still render.
Definition at line 123 of file OgreMovableObject.h.
|
protectedinherited |
Definition at line 417 of file OgreRenderable.h.
|
protectedinherited |
Definition at line 418 of file OgreRenderable.h.
|
protectedinherited |
User objects binding.
Definition at line 130 of file OgreMovableObject.h.
|
protectedinherited |
Definition at line 419 of file OgreRenderable.h.
|
mutableprotected |
Definition at line 170 of file OgreFrustum.h.
|
mutableprotected |
Pre-calced view matrix.
Definition at line 120 of file OgreFrustum.h.
|
protectedinherited |
Flags determining whether this object is visible (compared to SceneManager mask)
Definition at line 142 of file OgreMovableObject.h.
|
protectedinherited |
Is this object visible?
Definition at line 119 of file OgreMovableObject.h.
|
mutableprotectedinherited |
Cached world AABB of this object.
Definition at line 144 of file OgreMovableObject.h.
|
mutableprotectedinherited |
Definition at line 146 of file OgreMovableObject.h.
|
mutableprotectedinherited |
World space AABB of this object's dark cap.
Definition at line 148 of file OgreMovableObject.h.
|
mutableprotected |
Definition at line 173 of file OgreFrustum.h.