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...
|
| Frustum (IdType id, ObjectMemoryManager *objectMemoryManager) |
| Named constructor. More...
|
|
| ~Frustum () override |
|
const Plane * | _getCachedFrustumPlanes () const |
| Returns the frustum planes, doesn't check if dirty. More...
|
|
const Vector3 * | _getCachedWorldSpaceCorners () const |
|
virtual void | calcViewMatrixRelative (const Vector3 &relPos, Matrix4 &matToUpdate) const |
| Calculate a view matrix for this frustum, relative to a potentially dynamic point. 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...
|
|
virtual Real | getAspectRatio () const |
| Retrieves the current aspect ratio. More...
|
|
const AxisAlignedBox & | getBoundingBox () const |
| Overridden from MovableObject. More...
|
|
void | getCustomWorldSpaceCorners (ArrayVector3 outCorners[(8+ARRAY_PACKED_REALS - 1)/ARRAY_PACKED_REALS], Real customFarPlane) 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...
|
|
const LightList & | getLights () const override |
| Overridden from Renderable. More...
|
|
const String & | getMovableType () const override |
| Overridden from MovableObject. More...
|
|
virtual Real | getNearClipDistance () const |
| Sets the position of the near clipping plane. 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...
|
|
Radian | getOrientationModeAngle () const |
| Get the orientation mode angle 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...
|
|
PlaneBoundedVolume | getPlaneBoundedVolume () |
| Gets a world-space list of planes enclosing the frustum. More...
|
|
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. More...
|
|
virtual ProjectionType | getProjectionType () const |
| Retrieves info on the type of projection used (orthographic or perspective). 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...
|
|
void | getRenderOperation (v1::RenderOperation &op, bool casterPass) override |
| Overridden from Renderable. More...
|
|
Real | getSquaredViewDepth (const Camera *cam) const |
| Overridden from Renderable. More...
|
|
virtual const Matrix4 & | getViewMatrix () const |
| Gets the view matrix for this frustum. 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...
|
|
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...
|
|
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...
|
|
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 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...
|
|
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 | 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...
|
|
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 | setProjectionType (ProjectionType pt) |
| Sets the type of projection to use (orthographic or perspective). More...
|
|
| MovableObject (IdType id, ObjectMemoryManager *objectMemoryManager, SceneManager *manager, uint8 renderQueueId) |
| Constructor. More...
|
|
| MovableObject (ObjectData *objectDataPtrs) |
| Don't use this constructor unless you know what you're doing. More...
|
|
virtual | ~MovableObject () |
| Virtual destructor - read Scott Meyers if you don't know why this is needed. More...
|
|
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 () |
|
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 | _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 | 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...
|
|
void | detachFromParent () |
| Detaches an object from a parent SceneNode if attached. 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...
|
|
unsigned char | getCurrentMeshLod () const |
|
uint32 | getLightMask () const |
| Get a bitwise mask which will filter the lights affecting this object. 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...
|
|
const String & | getName () const |
| Returns the name of this object. More...
|
|
Node * | getParentNode () const |
| Returns the node to which this object is attached. More...
|
|
SceneNode * | getParentSceneNode () const |
|
uint32 | getQueryFlags () const |
| Returns the query flags relevant for this object. 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...
|
|
uint8 | getRenderQueueGroup () const |
| Gets the queue group for this entity, see setRenderQueueGroup for full details. More...
|
|
Real | getShadowRenderingDistance () const |
| Gets the distance at which batches are no longer casting shadows. More...
|
|
SkeletonInstance * | getSkeletonInstance () 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...
|
|
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 void | instanceBatchCullFrustumThreaded (const Frustum *frustum, const Camera *lodCamera, uint32 combinedVisibilityFlags) |
|
bool | isAttached () const |
| Returns true if this object is attached to a Node. More...
|
|
bool | isStatic () const |
| Checks whether this MovableObject is static. More...
|
|
bool | isVisible () const |
| Returns whether or not this object is supposed to be visible or not. More...
|
|
const LightList & | queryLights () const |
| Gets a list of lights, ordered relative to how close they are to this movable object. 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...
|
|
void | setCastShadows (bool enabled) |
| Sets whether or not this object will cast shadows. 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...
|
|
void | setName (const String &name) |
| Sets a custom name for this node. 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 | 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 | 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...
|
|
| AnimableObject () |
|
virtual | ~AnimableObject () |
|
virtual AnimableValuePtr | createAnimableValue (const String &valueName) |
| Create a reference-counted AnimableValuePtr for the named value. More...
|
|
const StringVector & | getAnimableValueNames () const |
| Gets a list of animable value names for this object. More...
|
|
| IdObject (IdType id) |
| We don't call generateNewId() here, to prevent objects in the stack (i.e. More...
|
|
IdType | getId () const |
| Get the unique id of this object. More...
|
|
bool | operator() (const IdObject &left, const IdObject &right) |
|
bool | operator() (const IdObject *left, const IdObject *right) |
|
| Renderable () |
|
virtual | ~Renderable () |
| Virtual destructor needed as class has virtual methods. 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...
|
|
void | addPoseWeight (size_t index, float w) |
|
virtual bool | getCastsShadows () const |
| Method which reports whether this renderable would normally cast a shadow. More...
|
|
uint8 | getCurrentMaterialLod () 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 |
|
HlmsDatablock * | getDatablock () const |
|
const String & | getDatablockOrMaterialName () const |
|
uint32 | getHlmsCasterHash () const |
|
uint32 | getHlmsHash () const |
|
MaterialPtr | getMaterial () const |
| Retrieves the material this renderable object uses. More...
|
|
unsigned short | getNumPoses () const |
|
virtual unsigned short | getNumWorldTransforms () const |
| Returns the number of world transform matrices this renderable requires. 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 |
|
uint8 | getRenderQueueSubGroup () const |
|
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...
|
|
const UserObjectBindings & | getUserObjectBindings () const |
| Return an instance of user objects binding associated with this class. More...
|
|
const VertexArrayObjectArray & | getVaos (VertexPass vertexPass) const |
|
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 | 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...
|
|
void | removeCustomParameter (size_t index) |
| Removes a custom value which is associated with this Renderable at the given index. 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 | 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 | 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. 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) |
|
void | setRenderQueueSubGroup (uint8 subGroup) |
| Sets the render queue sub group. 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) |
|