 |
OGRE-Next
2.3
Object-Oriented Graphics Rendering Engine
|
|
OGRE-Next
2.3
Object-Oriented Graphics Rendering Engine
|
A frustum represents a pyramid, capped at the near and far end which is used to represent either a visible area or a projection area. More...
#include <OgreFrustum.h>
Inheritance diagram for Ogre::Frustum:Public Types | |
| typedef map< size_t, Vector4 >::type | CustomParameterMap |
| typedef FastArray< MovableObject * > | MovableObjectArray |
| @See SceneManager::cullFrustum More... | |
Public Member Functions | |
| Frustum (IdType id, ObjectMemoryManager *objectMemoryManager) | |
| Named constructor. More... | |
| virtual | ~Frustum () |
| const Plane * | _getCachedFrustumPlanes () const |
| Returns the frustum planes, doesn't check if dirty. More... | |
| const Vector3 * | _getCachedWorldSpaceCorners () const |
| LightList * | _getLightList () |
| Returns a pointer to the current list of lights for this object. More... | |
| SceneManager * | _getManager () const |
| Get the manager of this object, if any (internal use only) More... | |
| ObjectData & | _getObjectData () |
| Returns a direct access to the ObjectData state. More... | |
| const Matrix4 & | _getParentNodeFullTransform () const |
| Returns the full transformation of the parent sceneNode or the attachingPoint node. More... | |
| virtual void | _notifyAttached (Node *parent) |
| Internal method called to notify the object that it has been attached to a node. More... | |
| void | _notifyManager (SceneManager *man) |
| Notify the object of it's manager (internal use only) More... | |
| virtual void | _notifyParentNodeMemoryChanged () |
| @See Node::_callMemoryChangeListeners More... | |
| virtual void | _notifyStaticDirty () const |
| Called by SceneManager when it is telling we're a static MovableObject being dirty Don't call this directly. More... | |
| virtual void | _releaseManualHardwareResources () |
| Notifies the movable object that hardware resources were lost. More... | |
| virtual void | _restoreManualHardwareResources () |
| Notifies the movable object that hardware resources should be restored. More... | |
| virtual void | _setHlmsHashes (uint32 hash, uint32 casterHash) |
| Manually sets the hlms hashes. Don't call this directly. More... | |
| virtual void | _setNullDatablock () |
| Sets the datablock to a null pointer. 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... | |
| virtual void | _updateRenderQueue (RenderQueue *queue, Camera *camera, const Camera *lodCamera) |
| Internal method by which the movable object must add Renderable subclass instances to the rendering queue. More... | |
| void | addPoseWeight (size_t index, float w) |
| void | addQueryFlags (uint32 flags) |
| As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. More... | |
| 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... | |
| void | detachFromParent () |
| Detaches an object from a parent SceneNode if attached. More... | |
| virtual void | disableCustomNearClipPlane () |
| Disables any custom near clip plane. More... | |
| virtual void | disableReflection () |
| 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 MovablePlane *p) |
| Modifies this frustum so it always renders from the reflection of itself through the plane specified. More... | |
| virtual void | enableReflection (const Plane &p) |
| Modifies this frustum so it always renders from the reflection of itself through the plane specified. More... | |
| const StringVector & | getAnimableValueNames () const |
| Gets a list of animable value names for this object. More... | |
| virtual Real | getAspectRatio () const |
| Retrieves the current aspect ratio. More... | |
| const AxisAlignedBox & | getBoundingBox () const |
| Overridden from MovableObject. More... | |
| RealAsUint | getCachedDistanceToCamera () const |
| Returns the distance to camera as calculated in @cullFrustum. More... | |
| Real | getCachedDistanceToCameraAsReal () const |
| Returns the distance to camera as calculated in @cullFrustum. More... | |
| bool | getCastShadows () const |
| Returns whether shadow casting is enabled for this object. More... | |
| virtual bool | getCastsShadows () const |
| Method which reports whether this renderable would normally cast a shadow. More... | |
| uint8 | getCurrentMaterialLod () const |
| unsigned char | getCurrentMeshLod () const |
| const Vector4 & | getCustomParameter (size_t index) const |
| Gets the custom value associated with this Renderable at the given index. More... | |
| const CustomParameterMap & | getCustomParameters () const |
| void | getCustomWorldSpaceCorners (ArrayVector3 outCorners[(8+ARRAY_PACKED_REALS - 1)/ARRAY_PACKED_REALS], Real customFarPlane) const |
| HlmsDatablock * | getDatablock () const |
| const String & | getDatablockOrMaterialName () const |
| virtual Real | getFarClipDistance () 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 () const |
| Retrieves the frustums Y-dimension Field Of View (FOV). More... | |
| virtual void | getFrustumExtents (Real &outleft, Real &outright, Real &outtop, Real &outbottom, FrustrumExtentsType frustrumExtentsType=FET_PROJ_PLANE_POS) const |
| Get the extents of the frustum in view space. More... | |
| bool | getFrustumExtentsManuallySet () const |
| 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... | |
| const Plane * | getFrustumPlanes () const |
| Retrieves the clipping planes of the frustum (world space). More... | |
| uint32 | getHlmsCasterHash () const |
| uint32 | getHlmsHash () const |
| IdType | getId () const |
| Get the unique id of this object. More... | |
| uint32 | getLightMask () const |
| Get a bitwise mask which will filter the lights affecting this object. More... | |
| const LightList & | getLights () const override |
| Overridden from Renderable. More... | |
| Listener * | getListener () const |
| Gets the current listener for this object. More... | |
| Aabb | getLocalAabb () const |
| Retrieves the local axis-aligned bounding box for this object. More... | |
| float | getLocalRadius () const |
| See getLocalAabb and getWorldRadius. More... | |
| MaterialPtr | getMaterial () const |
| Retrieves the material this renderable object uses. More... | |
| const String & | getMovableType () const override |
| Overridden from MovableObject. More... | |
| const String & | getName () const |
| Returns the name of this object. More... | |
| virtual Real | getNearClipDistance () const |
| Sets the position of the near clipping plane. More... | |
| unsigned short | getNumPoses () const |
| virtual unsigned short | getNumWorldTransforms () const |
| Returns the number of world transform matrices this renderable requires. More... | |
| virtual const Quaternion & | getOrientationForViewUpdate () 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... | |
| Node * | getParentNode () const |
| Returns the node to which this object is attached. More... | |
| SceneNode * | getParentSceneNode () const |
| PlaneBoundedVolume | getPlaneBoundedVolume () |
| Gets a world-space list of planes enclosing the frustum. More... | |
| virtual bool | getPolygonModeOverrideable () const |
| Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More... | |
| bool | getPoseHalfPrecision () const |
| bool | getPoseNormals () const |
| TexBufferPacked * | getPoseTexBuffer () const |
| float | getPoseWeight (size_t index) const |
| float * | getPoseWeights () const |
| virtual const Vector3 & | getPositionForViewUpdate () const |
| Get the derived position of this frustum. More... | |
| virtual const Matrix4 & | getProjectionMatrix () 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 & | getProjectionMatrixWithRSDepth () const |
| Gets the depth-adjusted projection matrix for the current rendersystem, but one which still conforms to right-hand rules. More... | |
| Vector2 | getProjectionParamsAB () const |
| Returns the terms projectionA and projectionB in .x and .y respectively, which can be used to reconstruct linear depth from a Z buffer with the following formula: linearDepth = projectionParams.y / (fDepth - projectionParams.x);. More... | |
| virtual ProjectionType | getProjectionType () const |
| Retrieves info on the type of projection used (orthographic or perspective). More... | |
| uint32 | getQueryFlags () const |
| Returns the query flags relevant for this object. More... | |
| virtual const Matrix4 & | getReflectionMatrix () const |
| Returns the reflection matrix of the frustum if appropriate. More... | |
| virtual const Plane & | getReflectionPlane () const |
| Returns the reflection plane of the frustum if appropriate. More... | |
| Real | getRenderingDistance () const |
| Gets the distance at which batches are no longer rendered. More... | |
| 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 (v1::RenderOperation &op, bool casterPass) override |
| Overridden from Renderable. More... | |
| uint8 | getRenderQueueGroup () const |
| Gets the queue group for this entity, see setRenderQueueGroup for full details. More... | |
| uint8 | getRenderQueueSubGroup () const |
| Real | getShadowRenderingDistance () const |
| Gets the distance at which batches are no longer casting shadows. More... | |
| SkeletonInstance * | getSkeletonInstance () const |
| Real | getSquaredViewDepth (const Camera *cam) const |
| Overridden from Renderable. More... | |
| bool | getUseIdentityProjection () const |
| Returns whether or not to use an 'identity' projection. More... | |
| bool | getUseIdentityView () const |
| Returns whether or not to use an 'identity' view. More... | |
| virtual bool | getUseIdentityViewProjMatrixIsDynamic () const |
| Returns whether the Hlms implementation should evaluate getUseIdentityProjection per object at runtime, or if it can assume the Renderable will remain with the same setting until the datablock is flushed (performance optimization) More... | |
| virtual bool | getUseIdentityWorldMatrix () const |
| Returns whether the world matrix is an identity matrix. More... | |
| virtual OGRE_DEPRECATED const Any & | getUserAny () const |
| UserObjectBindings & | getUserObjectBindings () |
| 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... | |
| const UserObjectBindings & | getUserObjectBindings () const |
| Return an instance of user objects binding associated with this class. More... | |
| const VertexArrayObjectArray & | getVaos (VertexPass vertexPass) const |
| virtual const Matrix4 & | getViewMatrix () const |
| Gets the view matrix for this frustum. More... | |
| uint32 | getVisibilityFlags () const |
| Returns the visibility flags relevant for this object. More... | |
| bool | getVisible () const |
| Gets this object whether to be visible or not, if it has a renderable component. More... | |
| Aabb | getWorldAabb () const |
| Gets the axis aligned box in world space. More... | |
| Aabb | getWorldAabbUpdated () |
| Gets the axis aligned box in world space. More... | |
| float | getWorldRadius () const |
| Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ). More... | |
| float | getWorldRadiusUpdated () |
| Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ). More... | |
| virtual const Vector3 * | getWorldSpaceCorners () const |
| Gets the world space corners of the frustum. More... | |
| void | getWorldTransforms (Matrix4 *xform) const override |
| 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 | hasSkeletonAnimation () const |
| virtual void | instanceBatchCullFrustumThreaded (const Frustum *frustum, const Camera *lodCamera, uint32 combinedVisibilityFlags) |
| @See InstancingTheadedCullingMethod, More... | |
| bool | isAttached () const |
| Returns true if this object is attached to a Node. More... | |
| virtual bool | isCustomNearClipPlaneEnabled () const |
| Is a custom near clip plane in use? More... | |
| virtual bool | isCustomProjectionMatrixEnabled () const |
| Returns whether a custom projection matrix is in use. More... | |
| virtual bool | isCustomViewMatrixEnabled () const |
| Returns whether a custom view matrix is in use. More... | |
| virtual bool | isReflected () const |
| Returns whether this frustum is being reflected. More... | |
| bool | isStatic () const |
| Checks whether this MovableObject is static. @See setStatic. More... | |
| bool | isVisible () 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, const char *, int, const char *) |
| void | operator delete (void *ptr, void *) |
| void | operator delete[] (void *ptr) |
| void | operator delete[] (void *ptr, const char *, int, const char *) |
| void * | operator new (size_t sz) |
| 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 *ptr) |
| placement operator new More... | |
| void * | operator new[] (size_t sz) |
| void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
| array operator new, with debug line info More... | |
| bool | operator() (const IdObject &left, const IdObject &right) |
| bool | operator() (const IdObject *left, const IdObject *right) |
| 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... | |
| const LightList & | queryLights () 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... | |
| void | removeQueryFlags (uint32 flags) |
| As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. More... | |
| 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, bool alternateDepthRange=false) |
| 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 | setDatablock (HlmsDatablock *datablock) |
| Assigns a datablock (i.e. HLMS Material) to this renderable. More... | |
| void | setDatablock (IdString datablockName) |
| Assigns a datablock (i.e. More... | |
| void | setDatablockOrMaterialName (String materialName, String groupName) |
| First tries to see if an HLMS datablock exist with the given name, if not, tries to search among low level materials. 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, FrustrumExtentsType frustrumExtentsType=FET_PROJ_PLANE_POS) |
| 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... | |
| void | setLightMask (uint32 lightMask) |
| Set a bitwise mask which will filter the lights affecting this object. More... | |
| void | setListener (Listener *listener) |
| Sets a listener for this object. More... | |
| void | setLocalAabb (const Aabb box) |
| Sets the local axis-aligned bounding box for this object. More... | |
| virtual void | setMaterial (const MaterialPtr &material) |
| Sets the given material. Overrides HLMS materials. More... | |
| void | setMaterialName (const String &name, const String &groupName) |
| Sets the name of the Material to be used. Prefer using HLMS @See setHlms. More... | |
| void | setName (const String &name) |
| Sets a custom name for this node. 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... | |
| void | setPoseWeight (size_t index, float w) |
| virtual void | setProjectionType (ProjectionType pt) |
| Sets the type of projection to use (orthographic or perspective). More... | |
| void | setQueryFlags (uint32 flags) |
| Sets the query flags for this object. More... | |
| void | setRenderingDistance (Real dist) |
| Sets the distance at which the object is no longer rendered. More... | |
| 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... | |
| void | setRenderQueueSubGroup (uint8 subGroup) |
| Sets the render queue sub group. More... | |
| void | setShadowRenderingDistance (Real dist) |
| Sets the distance at which the object is no longer casting shadows. More... | |
| bool | setStatic (bool bStatic) |
| Turns this Node into static or dynamic. 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) |
| void | setVisibilityFlags (uint32 flags) |
| Sets the visibility flags for this object. More... | |
| void | setVisible (bool visible) |
| Tells this object whether to be visible or not, if it has a renderable component. More... | |
Static Public Member Functions | |
| static void | buildLightList (const size_t numNodes, ObjectData t, const LightListInfo &globalLightList) |
| @See SceneManager::buildLightList More... | |
| static ArrayReal | calculateCameraDistance (uint32 _cameraSortMode, const ArrayVector3 &cameraPos, const ArrayVector3 &cameraDir, ArrayAabb *RESTRICT_ALIAS worldAabb, ArrayReal *RESTRICT_ALIAS worldRadius) |
| static void | calculateCastersBox (const size_t numNodes, ObjectData t, uint32 sceneVisibilityFlags, AxisAlignedBox *outBox) |
| static void | cullFrustum (const size_t numNodes, ObjectData t, const Camera *frustum, uint32 sceneVisibilityFlags, MovableObjectArray &outCulledObjects, const Camera *lodCamera) |
| static void | cullLights (const size_t numNodes, ObjectData t, uint32 sceneLightMask, LightListInfo &outGlobalLightList, const FrustumVec &frustums, const FrustumVec &cubemapFrustums) |
| @See SceneManager::cullLights & More... | |
| static uint32 | getDefaultLightMask () |
| Get the default light mask for all future MovableObject instances. More... | |
| static uint32 | getDefaultQueryFlags () |
| Get the default query flags for all future MovableObject instances. More... | |
| static uint8 | getDefaultRenderQueueSubGroup () |
| static uint32 | getDefaultVisibilityFlags () |
| Get the default visibility flags for all future MovableObject instances. More... | |
| static void | setDefaultLightMask (uint32 mask) |
| Set the default light mask for all future MovableObject instances. More... | |
| static void | setDefaultQueryFlags (uint32 flags) |
| Set the default query flags for all future MovableObject instances. More... | |
| static void | setDefaultRenderQueueSubGroup (uint8 subGroup) |
| Sets the default render queue sub group for all future Renderable instances. More... | |
| static void | setDefaultVisibilityFlags (uint32 flags) |
| Set the default visibility flags for all future MovableObject instances. More... | |
| static void | updateAllBounds (const size_t numNodes, ObjectData t) |
| @See SceneManager::updateAllBounds More... | |
Public Attributes | |
| uint8 | mCustomParameter |
| Only valid when using low level materials. More... | |
| size_t | mGlobalIndex |
| Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks). More... | |
| uint32 | mHlmsGlobalIndex |
| Index in the vector holding this Rendrable reference in the HLMS datablock. More... | |
| size_t | mParentIndex |
| Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks). More... | |
| RenderableArray | mRenderables |
| bool | mRenderableVisible |
| Control visibility at Renderable (e.g. More... | |
Static Public Attributes | |
| static const FastArray< Real > | c_DefaultLodMesh |
| static const Real | INFINITE_FAR_PLANE_ADJUST |
| Small constant used to reduce far plane projection to avoid inaccuracies. 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.
|
inherited |
|
inherited |
@See SceneManager::cullFrustum
| frustum | Frustum to clip against |
| sceneVisibilityFlags | Combined scene's visibility flags (i.e. viewport | scene). Set LAYER_SHADOW_CASTER bit if you want to exclude non-shadow casters. |
| outCulledObjects | Out. List of objects that are (fully or partially) inside the frustum and should be rendered |
| lodCamera | Camera in which lod levels calculations are based (i.e. during shadow pass renders) Note however, we only use this camera to calulate if should be visible according to mUpperDistance |
| Ogre::Frustum::Frustum | ( | IdType | id, |
| ObjectMemoryManager * | objectMemoryManager | ||
| ) |
Named constructor.
|
virtual |
|
inline |
Returns the frustum planes, doesn't check if dirty.
|
inline |
|
inlineinherited |
Returns a pointer to the current list of lights for this object.
|
inlineinherited |
Get the manager of this object, if any (internal use only)
|
inlineinherited |
Returns a direct access to the ObjectData state.
|
inherited |
Returns the full transformation of the parent sceneNode or the attachingPoint node.
|
virtualinherited |
Internal method called to notify the object that it has been attached to a node.
Reimplemented in Ogre::ParticleSystem, and Ogre::v1::Entity.
|
inlineinherited |
Notify the object of it's manager (internal use only)
|
inlinevirtualinherited |
@See Node::_callMemoryChangeListeners
Reimplemented in Ogre::Item.
|
inlinevirtualinherited |
Called by SceneManager when it is telling we're a static MovableObject being dirty Don't call this directly.
|
inlinevirtualinherited |
Notifies the movable object that hardware resources were lost.
Reimplemented in Ogre::v1::Rectangle2D, Ogre::ManualObject, Ogre::v1::ManualObject, and Ogre::v1::BillboardSet.
|
inlinevirtualinherited |
Notifies the movable object that hardware resources should be restored.
Reimplemented in Ogre::v1::Rectangle2D.
Manually sets the hlms hashes. Don't call this directly.
Reimplemented in Ogre::SubItem.
|
virtualinherited |
Sets the datablock to a null pointer.
Use case: If you will be destroying an HlmsDatablock and all Renderables associated by it; it makes no sense to change the Renderable's datablock to a default one, only to be destroyed immediately after (you pay an unnecessary performance price).
Reimplemented in Ogre::v1::SubEntity, and Ogre::v1::BillboardSet.
|
virtualinherited |
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::v1::SubEntity.
|
inlinevirtualinherited |
Internal method by which the movable object must add Renderable subclass instances to the rendering queue.
Reimplemented in Ogre::ParticleSystem, Ogre::v1::ManualObject, Ogre::Light, Ogre::v1::Entity, Ogre::v1::BillboardSet, Ogre::v1::BillboardChain, and Ogre::MovablePlane.
|
inherited |
|
inlineinherited |
As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.
|
inlineinherited |
As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object.
|
staticinherited |
@See SceneManager::buildLightList
| globalLightList | List of lights already culled against all possible frustums and reorganized contiguously for SoA |
|
inlinestaticinherited |
|
staticinherited |
|
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)
|
inlinevirtualinherited |
Create a reference-counted AnimableValuePtr for the named value.
Reimplemented in Ogre::Light.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
staticinherited |
|
staticinherited |
@See SceneManager::cullLights &
| outGlobalLightList | Output, a list of lights, contiguously placed |
| frustums | An array of all frustums we need to check against |
| cubemapFrustums | An array of all frustums that are used at least once as cubemaps (@See SceneManager::createCamera) |
|
inherited |
Detaches an object from a parent SceneNode if attached.
|
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.
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.
|
virtual |
Modifies this frustum so it always renders from the reflection of itself through the plane specified.
|
inlineinherited |
Gets a list of animable value names for this object.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
virtual |
Retrieves the current aspect ratio.
| const AxisAlignedBox& Ogre::Frustum::getBoundingBox | ( | ) | const |
Overridden from MovableObject.
|
inlineinherited |
Returns the distance to camera as calculated in @cullFrustum.
|
inlineinherited |
Returns the distance to camera as calculated in @cullFrustum.
|
inlineinherited |
Returns whether shadow casting is enabled for this object.
|
inlinevirtualinherited |
Method which reports whether this renderable would normally cast a shadow.
Reimplemented in Ogre::WireAabb, Ogre::SubItem, Ogre::v1::SubEntity, Ogre::Rectangle2D, Ogre::ManualObject::ManualObjectSection, Ogre::VoxelVisualizer, and Ogre::IfdProbeVisualizer.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
Gets the custom value associated with this Renderable at the given index.
| index | Index of the parameter to retrieve. |
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
inlineinherited |
| void Ogre::Frustum::getCustomWorldSpaceCorners | ( | ArrayVector3 | outCorners[(8+ARRAY_PACKED_REALS - 1)/ARRAY_PACKED_REALS], |
| Real | customFarPlane | ||
| ) | const |
|
inlineinherited |
|
inherited |
|
inlinestaticinherited |
Get the default light mask for all future MovableObject instances.
|
inlinestaticinherited |
Get the default query flags for all future MovableObject instances.
|
inlinestaticinherited |
|
inlinestaticinherited |
Get the default visibility flags for all future MovableObject instances.
|
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.
| left,right,top,bottom | The position where the side clip planes intersect the near clip plane, in eye space OR the tangent of the half angles from the eye to the edges of the near clip plane |
| frustrumExtentsType | Specifies in what format the extents are returned. See OgreFrustrum::setFrustumExtents for more information |
| bool Ogre::Frustum::getFrustumExtentsManuallySet | ( | ) | const |
|
virtual |
Retrieves the frustum offsets.
|
virtual |
Retrieves a specified plane of the frustum (world space).
Reimplemented in Ogre::Camera.
| const Plane* Ogre::Frustum::getFrustumPlanes | ( | ) | const |
Retrieves the clipping planes of the frustum (world space).
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
Get the unique id of this object.
|
inlineinherited |
Get a bitwise mask which will filter the lights affecting this object.
|
overridevirtual |
Overridden from Renderable.
Implements Ogre::Renderable.
|
inlineinherited |
Gets the current listener for this object.
|
inherited |
Retrieves the local axis-aligned bounding box for this object.
|
inherited |
See getLocalAabb and getWorldRadius.
|
inherited |
Retrieves the material this renderable object uses.
It may be null if it's using the HLMS. @See getDatablock
|
overridevirtual |
Overridden from MovableObject.
Implements Ogre::MovableObject.
|
inlineinherited |
Returns the name of this object.
|
virtual |
Sets the position of the near clipping plane.
Reimplemented in Ogre::Camera.
|
inherited |
|
inlinevirtualinherited |
Returns the number of world transform matrices this renderable requires.
Reimplemented in Ogre::v1::SubEntity, and Ogre::v1::BorderRenderable.
|
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.
|
inlineinherited |
Returns the node to which this object is attached.
|
inlineinherited |
| PlaneBoundedVolume Ogre::Frustum::getPlaneBoundedVolume | ( | ) |
Gets a world-space list of planes enclosing the frustum.
|
inlinevirtualinherited |
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
Reimplemented in Ogre::v1::BorderRenderable.
Referenced by Ogre::v1::BorderRenderable::getPolygonModeOverrideable().
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
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 depth-adjusted projection matrix for the current rendersystem, but one which still conforms to right-hand rules.
| Vector2 Ogre::Frustum::getProjectionParamsAB | ( | ) | const |
Returns the terms projectionA and projectionB in .x and .y respectively, which can be used to reconstruct linear depth from a Z buffer with the following formula: linearDepth = projectionParams.y / (fDepth - projectionParams.x);.
|
virtual |
Retrieves info on the type of projection used (orthographic or perspective).
|
inlineinherited |
Returns the query flags relevant for this object.
|
inlinevirtual |
Returns the reflection matrix of the frustum if appropriate.
|
inlinevirtual |
Returns the reflection plane of the frustum if appropriate.
|
inlineinherited |
Gets the distance at which batches are no longer rendered.
|
inlineinherited |
Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered.
|
overridevirtual |
Overridden from Renderable.
Implements Ogre::Renderable.
|
inlineinherited |
Gets the queue group for this entity, see setRenderQueueGroup for full details.
|
inlineinherited |
|
inlineinherited |
Gets the distance at which batches are no longer casting shadows.
|
inlineinherited |
Overridden from Renderable.
|
inlineinherited |
Returns whether or not to use an 'identity' projection.
|
inlineinherited |
Returns whether or not to use an 'identity' view.
|
inlinevirtualinherited |
Returns whether the Hlms implementation should evaluate getUseIdentityProjection per object at runtime, or if it can assume the Renderable will remain with the same setting until the datablock is flushed (performance optimization)
|
inlinevirtualinherited |
Returns whether the world matrix is an identity matrix.
Reimplemented in Ogre::v1::BillboardSet.
|
inlinevirtualinherited |
Retrieves the custom user value associated with this object.
|
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.
|
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.
|
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.
|
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.
|
inlineinherited |
|
virtual |
Gets the view matrix for this frustum.
Mainly for use by OGRE internally.
Reimplemented in Ogre::Camera.
|
inlineinherited |
Returns the visibility flags relevant for this object.
Reserved visibility flags are not returned.
|
inlineinherited |
Gets this object whether to be visible or not, if it has a renderable component.
|
inherited |
Gets the axis aligned box in world space.
|
inherited |
Gets the axis aligned box in world space.
|
inherited |
Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ).
|
inherited |
Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ).
|
virtual |
Gets the world space corners of the frustum.
Reimplemented in Ogre::Camera.
|
overridevirtual |
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. |
|
inlineinherited |
|
inlinevirtualinherited |
@See InstancingTheadedCullingMethod,
|
inlineinherited |
Returns true if this object is attached to a Node.
|
inlinevirtual |
Is a custom near clip plane in use?
|
inlinevirtual |
Returns whether a custom projection matrix is in use.
|
inlinevirtual |
Returns whether a custom view matrix is in use.
|
inlinevirtual |
Returns whether this frustum is being reflected.
|
inherited |
Checks whether this MovableObject is static. @See setStatic.
|
inherited |
Returns whether or not this object is supposed to be visible or not.
|
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.
|
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 |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
operator new, with debug line info
|
inlineinherited |
placement operator new
|
inlineinherited |
|
inlineinherited |
array operator new, with debug line info
|
inlinevirtualinherited |
Called immediately after the Renderable has been rendered.
|
inlinevirtualinherited |
Called just prior to the Renderable being rendered.
Reimplemented in Ogre::v1::BillboardChain.
|
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.
|
inlineinherited |
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. |
|
inlineinherited |
As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.
|
inlineinherited |
As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object.
|
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.
|
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. |
|
virtual |
Set whether to use a custom projection matrix on this frustum.
See Frustum::setCustomViewMatrix
| 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. |
| alternateDepthRange | Set this to true if the input projectionMatrix has the depth in range [0; 1] instead of the range [-1; 1] that Ogre expects. |
Projection matrices obtained from Oculus SDK's need to set this to true.
Note that we will internally convert the projection matrix by performing the range conversion, so don't expect Frustum::getProjectionMatrix to return you exactly the same projection matrix you passed to us!
|
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. |
|
virtualinherited |
Assigns a datablock (i.e. HLMS Material) to this renderable.
Reimplemented in Ogre::v1::SubEntity, and Ogre::v1::BillboardSet.
|
inherited |
Assigns a datablock (i.e.
HLMS material) based on its unique name.
|
inherited |
First tries to see if an HLMS datablock exist with the given name, if not, tries to search among low level materials.
|
inlinestaticinherited |
Set the default light mask for all future MovableObject instances.
|
inlinestaticinherited |
Set the default query flags for all future MovableObject instances.
|
inlinestaticinherited |
Sets the default render queue sub group for all future Renderable instances.
|
inlinestaticinherited |
Set the default visibility flags for all future MovableObject instances.
|
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 OR the tangent of the half angles from the eye to the edges of the near clip plane |
| frustrumExtentsType | Specifies how the extents are represented. Be default they are the positions on near clip plane. However if this is a scene camera it is recommended that you actually use the tangent of the half angles. ie Half the FoV angles. This is because Ogre uses this camera setup to calculate custom clipping planes for PSSM algorithms, and Forward+ algorithms, but alter the near and far clip distances. |
|
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. |
|
inlineinherited |
Set a bitwise mask which will filter the lights affecting this object.
|
inlineinherited |
Sets a listener for this object.
|
inherited |
Sets the local axis-aligned bounding box for this object.
|
virtualinherited |
Sets the given material. Overrides HLMS materials.
Reimplemented in Ogre::v1::SubEntity, Ogre::v1::BillboardSet, and Ogre::v1::SimpleRenderable.
Sets the name of the Material to be used. Prefer using HLMS @See setHlms.
|
inlineinherited |
Sets a custom name for this node.
Doesn't have to be unique
|
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. |
|
inherited |
|
virtual |
Sets the type of projection to use (orthographic or perspective).
Default is perspective.
|
inlineinherited |
Sets the query flags for this object.
|
inlineinherited |
Sets the distance at which the object is no longer rendered.
| dist | Distance beyond which the object will not be rendered (the default is FLT_MAX, which means objects are always rendered). Values equal or below zero will be ignored, and cause an assertion in debug mode. |
|
inlineinherited |
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). |
|
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, Ogre::Light, Ogre::InternalCubemapProbe, Ogre::v1::Entity, and Ogre::Decal.
|
inlineinherited |
Sets the render queue sub group.
| subGroup | The sub group. This value can't exceed OGRE_MAKE_MASK( SubRqIdBits ) @See RenderQueue |
|
inlineinherited |
Sets the distance at which the object is no longer casting shadows.
| dist | Distance beyond which the object will not cast shadows (the default is FLT_MAX, which means objects are always casting shadows). Values equal or below zero will be ignored, and cause an assertion in debug mode. |
|
inherited |
Turns this Node into static or dynamic.
|
inlineinherited |
Sets whether or not to use an 'identity' projection.
|
inlineinherited |
Sets whether or not to use an 'identity' view.
|
inlinevirtualinherited |
Sets any kind of user value on this object.
|
inlineinherited |
Sets the visibility flags for this object.
|
inlineinherited |
Tells this object whether to be visible or not, if it has a renderable component.
|
staticinherited |
@See SceneManager::updateAllBounds
|
static |
Small constant used to reduce far plane projection to avoid inaccuracies.
|
inherited |
Only valid when using low level materials.
|
inherited |
Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks).
Used for O(1) removals.
|
inherited |
Index in the vector holding this Rendrable reference in the HLMS datablock.
Used for O(1) removals.
|
inherited |
Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks).
Used for O(1) removals.
|
inherited |
|
inherited |
Control visibility at Renderable (e.g.
SubMesh) level
Note that if our MovableObject owner called MovableObject::setVisible( false ) we won't get rendered. Both must be true in order to render.
1.9.1