OGRE  1.11.6
Object-Oriented Graphics Rendering Engine
Ogre::PCZCamera Class Reference

Specialized viewpoint from which an PCZone Scene can be rendered. More...

#include <OgrePCZCamera.h>

+ Inheritance diagram for Ogre::PCZCamera:

Public Types

typedef SharedPtr< RenderSystemDataRenderSystemDataPtr
 
typedef std::vector< ShadowRenderable * > ShadowRenderableList
 
typedef VectorIterator< ShadowRenderableListShadowRenderableListIterator
 
enum  Visibility { NONE, PARTIAL, FULL }
 Visibility types. More...
 

Public Member Functions

 PCZCamera (const String &name, SceneManager *sm)
 
 ~PCZCamera ()
 
void _autoTrack (void)
 Internal method used by OGRE to update auto-tracking cameras. More...
 
MovableObjectFactory_getCreator (void) const
 Get the creator of this object, if any (internal use only) More...
 
LightList_getLightList ()
 Returns a pointer to the current list of lights for this object. More...
 
Real _getLodBiasInverse (void) const
 Internal method for OGRE to use for LOD calculations. More...
 
SceneManager_getManager (void) const
 Get the manager of this object, if any (internal use only) More...
 
unsigned int _getNumRenderedBatches (void) const
 Internal method to retrieve the number of visible batches in the last render. More...
 
unsigned int _getNumRenderedFaces (void) const
 Internal method to retrieve the number of visible faces in the last render. More...
 
virtual const Affine3_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...
 
void _notifyRenderedBatches (unsigned int numbatches)
 Internal method to notify camera of the visible batches in the last render. More...
 
void _notifyRenderedFaces (unsigned int numfaces)
 Internal method to notify camera of the visible faces in the last render. More...
 
void _notifyViewport (Viewport *viewport)
 Notifies this camera that a viewport is using it. More...
 
virtual void _releaseManualHardwareResources ()
 Notifies the movable object that hardware resources were lost. More...
 
void _renderScene (Viewport *vp, bool includeOverlays)
 Tells the Camera to contact the SceneManager to render from it's viewpoint. More...
 
virtual void _restoreManualHardwareResources ()
 Notifies the movable object that hardware resources should be restored. 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 addListener (Listener *l)
 Add a listener to this camera. More...
 
int addPortalCullingPlanes (PortalBase *portal)
 Calculate extra culling planes from portal and camera origin and add to list of extra culling planes. 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 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 (void)
 Detaches an object from a parent SceneNode or TagPoint, if attached. More...
 
void disableCustomNearClipPlane (void)
 Disables any custom near clip plane. More...
 
void disableReflection (void)
 Disables reflection modification previously turned on with enableReflection. More...
 
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...
 
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...
 
void enableReflection (const Plane &p)
 Modifies this frustum so it always renders from the reflection of itself through the plane specified. More...
 
void enableReflection (const MovablePlane *p)
 Modifies this frustum so it always renders from the reflection of itself through the plane specified. More...
 
virtual void forwardIntersect (const Plane &worldPlane, std::vector< Vector4 > *intersect3d) const
 Forward projects frustum rays to find forward intersection with plane. More...
 
const StringVectorgetAnimableValueNames (void) const
 Gets a list of animable value names for this object. More...
 
Real getAspectRatio (void) const
 Retrieves the current aspect ratio. More...
 
bool getAutoAspectRatio (void) const
 Retrieves if AutoAspectRatio is currently set or not. More...
 
const Vector3getAutoTrackOffset (void) const
 Get the auto tracking offset for this camera, if it is auto tracking. More...
 
SceneNodegetAutoTrackTarget (void) const
 Get the auto tracking target for this camera, if any. More...
 
virtual const AxisAlignedBoxgetBoundingBox (void) const
 Overridden: Retrieves the local axis-aligned bounding box for this object. More...
 
Real getBoundingRadius (void) const
 Overridden from MovableObject. More...
 
PlaneBoundedVolume getCameraToViewportBoxVolume (Real screenLeft, Real screenTop, Real screenRight, Real screenBottom, bool includeFarPlane=false)
 Gets a world-space list of planes enclosing a volume based on a viewport rectangle. More...
 
void getCameraToViewportBoxVolume (Real screenLeft, Real screenTop, Real screenRight, Real screenBottom, PlaneBoundedVolume *outVolume, bool includeFarPlane=false)
 
Ray getCameraToViewportRay (Real screenx, Real screeny) const
 Gets a world space ray as cast from the camera through a viewport position. More...
 
void getCameraToViewportRay (Real screenx, Real screeny, Ray *outRay) const
 Gets a world space ray as cast from the camera through a viewport position. 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...
 
FrustumgetCullingFrustum (void) const
 Returns the custom culling frustum in use. More...
 
const Vector4getCustomParameter (size_t index) const
 Gets the custom value associated with this Renderable at the given index. More...
 
const AxisAlignedBoxgetDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const
 Overridden member from ShadowCaster. More...
 
Vector3 getDerivedDirection (void) const
 Gets the derived direction vector of the camera, including any rotation inherited from a node attachment and reflection matrix. More...
 
const QuaterniongetDerivedOrientation (void) const
 Gets the derived orientation of the camera, including any rotation inherited from a node attachment and reflection matrix. More...
 
const Vector3getDerivedPosition (void) const
 Gets the derived position of the camera, including any translation inherited from a node attachment and reflection matrix. More...
 
Vector3 getDerivedRight (void) const
 Gets the derived right vector of the camera, including any rotation inherited from a node attachment and reflection matrix. More...
 
Vector3 getDerivedUp (void) const
 Gets the derived up vector of the camera, including any rotation inherited from a node attachment and reflection matrix. More...
 
Vector3 getDirection (void) const
 Gets the camera's direction. More...
 
EdgeDatagetEdgeList (void)
 Returns details of the edges which might be used to determine a silhouette. More...
 
Real getFarClipDistance (void) const
 Retrieves the distance from the frustum to the far clipping plane. More...
 
Real getFocalLength () const
 Returns focal length of frustum. More...
 
const RadiangetFOVy (void) const
 Retrieves the frustums Y-dimension Field Of View (FOV). More...
 
RealRect getFrustumExtents () const
 Get the extents of the frustum in view space. More...
 
void getFrustumExtents (Real &outleft, Real &outright, Real &outtop, Real &outbottom) const
 
const Vector2getFrustumOffset () const
 Retrieves the frustum offsets. More...
 
const PlanegetFrustumPlane (unsigned short plane) const
 Retrieves a specified plane of the frustum (world space). More...
 
virtual const PlanegetFrustumPlanes (void) const
 Retrieves the clipping planes of the frustum (world space). More...
 
const AxisAlignedBoxgetLightCapBounds (void) const
 Overridden member from ShadowCaster. More...
 
uint32 getLightMask () const
 Get a bitwise mask which will filter the lights affecting this object. More...
 
const LightListgetLights (void) const
 Overridden from Renderable. More...
 
ListenergetListener (void) const
 Gets the current listener for this object. More...
 
Real getLodBias (void) const
 Returns the level-of-detail bias factor currently applied to this camera. More...
 
virtual const CameragetLodCamera () const
 Get a pointer to the camera which should be used to determine LOD settings. More...
 
const MaterialPtrgetMaterial (void) const
 Overridden from Renderable. More...
 
const StringgetMovableType (void) const
 Overridden from MovableObject. More...
 
const StringgetName (void) const
 Returns the name of this object. More...
 
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...
 
const QuaterniongetOrientation (void) const
 Returns the camera's current orientation. More...
 
const QuaterniongetOrientationForViewUpdate (void) const
 Get the derived orientation of this frustum. More...
 
OrientationMode getOrientationMode () const
 Get the orientation mode of the frustum. More...
 
Real getOrthoWindowHeight () const
 Gets the orthographic window height, for use with orthographic rendering only. More...
 
Real getOrthoWindowWidth () const
 Gets the orthographic window width, for use with orthographic rendering only. More...
 
NodegetParentNode (void) const
 Returns the node to which this object is attached. More...
 
SceneNodegetParentSceneNode (void) const
 Returns the scene node to which this object is attached. More...
 
Real getPixelDisplayRatio () const
 Returns an estimated ratio between a pixel and the display area it represents. 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...
 
PolygonMode getPolygonMode (void) const
 Retrieves the level of detail that the camera will render. More...
 
bool getPolygonModeOverrideable (void) const
 Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
 
const Vector3getPosition (void) const
 Retrieves the camera's position. More...
 
const Vector3getPositionForViewUpdate (void) const
 Get the derived position of this frustum. More...
 
const Matrix4getProjectionMatrix (void) const
 Gets the normal projection matrix for this frustum, ie the projection matrix which conforms to standard right-handed rules and uses depth range [-1,+1]. More...
 
const Matrix4getProjectionMatrixRS (void) const
 Gets the projection matrix for this frustum adjusted for the current rendersystem specifics (may be right or left-handed, depth range may vary). More...
 
const Matrix4getProjectionMatrixWithRSDepth (void) const
 Gets the depth-adjusted projection matrix for the current rendersystem, but one which still conforms to right-hand rules. More...
 
ProjectionType getProjectionType (void) const
 Retrieves info on the type of projection used (orthographic or perspective). More...
 
uint32 getQueryFlags (void) const
 Returns the query flags relevant for this object. More...
 
Vector3 getRealDirection (void) const
 Gets the real world direction vector of the camera, including any rotation inherited from a node attachment. More...
 
const QuaterniongetRealOrientation (void) const
 Gets the real world orientation of the camera, including any rotation inherited from a node attachment. More...
 
const Vector3getRealPosition (void) const
 Gets the real world position of the camera, including any translation inherited from a node attachment. More...
 
Vector3 getRealRight (void) const
 Gets the real world right vector of the camera, including any rotation inherited from a node attachment. More...
 
Vector3 getRealUp (void) const
 Gets the real world up vector of the camera, including any rotation inherited from a node attachment. More...
 
bool getReceivesShadows ()
 Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows. More...
 
const Affine3getReflectionMatrix (void) const
 Returns the reflection matrix of the frustum if appropriate. More...
 
const PlanegetReflectionPlane (void) const
 Returns the reflection plane of the frustum if appropriate. More...
 
Real getRenderingDistance (void) 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 (RenderOperation &op)
 Overridden from Renderable. More...
 
uint8 getRenderQueueGroup (void) const
 Gets the queue group for this entity. More...
 
const RenderSystemDataPtrgetRenderSystemData () const
 Gets RenderSystem private data. More...
 
Vector3 getRight (void) const
 Gets the camera's right vector. More...
 
SceneManagergetSceneManager (void) const
 Returns a pointer to the SceneManager this camera is rendering through. 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 TechniquegetTechnique (void) const
 Retrieves a pointer to the Material Technique this renderable object uses. More...
 
uint32 getTypeFlags (void) const
 Overridden from MovableObject::getTypeFlags. More...
 
Vector3 getUp (void) const
 Gets the camera's up vector. 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...
 
bool getUseMinPixelSize () const
 Returns whether to use min display size calculations. More...
 
const AnygetUserAny (void) const
 
const AnygetUserAny (void) const
 
virtual bool getUseRenderingDistance (void) const
 Get whether this camera should use the 'rendering distance' on objects to exclude distant objects from the final image. More...
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
const Affine3getViewMatrix (void) const
 Gets the view matrix for this frustum. More...
 
const Affine3getViewMatrix (bool ownFrustumOnly) const
 Specialised version of getViewMatrix allowing caller to differentiate whether the custom culling frustum should be allowed or not. More...
 
ViewportgetViewport (void) const
 Get the last viewport which was attached to this camera. More...
 
PCZCamera::Visibility getVisibility (const AxisAlignedBox &bound)
 Returns the detailed visibility of the box. More...
 
uint32 getVisibilityFlags (void) const
 Returns the visibility flags relevant for this object. More...
 
bool getVisible (void) const
 Gets this object whether to be visible or not, if it has a renderable component. More...
 
const std::vector< Plane > & getWindowPlanes (void) const
 Gets the window clip planes, only applicable if isWindowSet == true. More...
 
virtual const AxisAlignedBoxgetWorldBoundingBox (bool derive=false) const
 Retrieves the axis-aligned bounding box for this object in world coordinates. More...
 
virtual const SpheregetWorldBoundingSphere (bool derive=false) const
 Retrieves the worldspace bounding sphere for this object. More...
 
const Vector3getWorldSpaceCorners (void) const
 Gets the world space corners of the frustum. More...
 
void getWorldTransforms (Matrix4 *mat) const
 Overridden from Frustum/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)
 Returns whether the object has a valid edge list. More...
 
bool isAttached (void) const
 Returns true if this object is attached to a SceneNode or TagPoint. More...
 
bool isCustomNearClipPlaneEnabled (void) const
 Is a custom near clip plane in use? More...
 
bool isCustomProjectionMatrixEnabled (void) const
 Returns whether a custom projection matrix is in use. More...
 
bool isCustomViewMatrixEnabled (void) const
 Returns whether a custom view matrix is in use. More...
 
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...
 
bool isParentTagPoint () const
 Gets whether the parent node is a TagPoint (or a SceneNode) More...
 
bool isReflected (void) const
 Returns whether this frustum is being reflected. More...
 
bool isVisibile (const AxisAlignedBox &bound)
 Returns the visibility of the box. More...
 
virtual bool isVisible (const AxisAlignedBox &bound, FrustumPlane *culledBy=0) const
 Tests whether the given container is visible in the Frustum. More...
 
bool isVisible (PortalBase *portal, FrustumPlane *culledBy=0) const
 
virtual bool isVisible (void) const
 Returns whether or not this object is supposed to be visible or not. More...
 
bool isVisible (const Sphere &bound, FrustumPlane *culledBy=0) const
 Tests whether the given container is visible in the Frustum. More...
 
bool isVisible (const Vector3 &vert, FrustumPlane *culledBy=0) const
 Tests whether the given vertex is visible in the Frustum. More...
 
virtual bool isWindowSet (void) const
 Returns if a viewport window is being used. More...
 
void lookAt (const Vector3 &targetPoint)
 Points the camera at a location in worldspace. More...
 
void lookAt (Real x, Real y, Real z)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
void move (const Vector3 &vec)
 Moves the camera's position by the vector offset provided along world axes. More...
 
void moveRelative (const Vector3 &vec)
 Moves the camera's position by the vector offset provided along it's own axes (relative to orientation). More...
 
void pitch (const Radian &angle)
 Pitches the camera up/down anticlockwise around it's local z axis. More...
 
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...
 
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 LightListqueryLights (void) const
 Gets a list of lights, ordered relative to how close they are to this movable object. More...
 
void removeAllExtraCullingPlanes (void)
 Remove all extra culling planes. More...
 
void removeCustomParameter (size_t index)
 Removes a custom value which is associated with this Renderable at the given index. More...
 
virtual void removeListener (Listener *l)
 Remove a listener to this camera. More...
 
void removePortalCullingPlanes (PortalBase *portal)
 Remove extra culling planes created from the given portal. 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 resetFrustumExtents ()
 Reset the frustum extents to be automatically derived from other params. More...
 
virtual void resetWindow (void)
 Cancel view window. More...
 
void roll (const Radian &angle)
 Rolls the camera anticlockwise, around its local z axis. More...
 
void rotate (const Vector3 &axis, const Radian &angle)
 Rotate the camera around an arbitrary axis. More...
 
void rotate (const Quaternion &q)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
void setAspectRatio (Real ratio)
 Sets the aspect ratio for the frustum viewport. More...
 
void setAutoAspectRatio (bool autoratio)
 If set to true a viewport that owns this frustum will be able to recalculate the aspect ratio whenever the frustum is resized. More...
 
void setAutoTracking (bool enabled, SceneNode *const target=0, const Vector3 &offset=Vector3::ZERO)
 Enables / disables automatic tracking of a SceneNode. More...
 
void setCastShadows (bool enabled)
 Sets whether or not this object will cast shadows. More...
 
void setCullingFrustum (Frustum *frustum)
 Tells the camera to use a separate Frustum instance to perform culling. 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...
 
void setCustomProjectionMatrix (bool enable, const Matrix4 &projectionMatrix=Matrix4::IDENTITY)
 Set whether to use a custom projection matrix on this frustum. More...
 
void setCustomViewMatrix (bool enable, const Affine3 &viewMatrix=Affine3::IDENTITY)
 Set whether to use a custom view matrix on this frustum. More...
 
void setDebugDisplayEnabled (bool enabled)
 Sets whether or not the debug display of this object is enabled. More...
 
void setDirection (Real x, Real y, Real z)
 Sets the camera's direction vector. More...
 
void setDirection (const Vector3 &vec)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
void setFarClipDistance (Real farDist)
 Sets the distance to the far clipping plane. More...
 
void setFixedYawAxis (bool useFixed, const Vector3 &fixedAxis=Vector3::UNIT_Y)
 Tells the camera whether to yaw around it's own local Y axis or a fixed axis of choice. More...
 
void setFocalLength (Real focalLength=1.0)
 Sets frustum focal length (used in stereo rendering). More...
 
void setFOVy (const Radian &fovy)
 Sets the Y-dimension Field Of View (FOV) of the frustum. More...
 
void setFrustumExtents (Real left, Real right, Real top, Real bottom)
 Manually set the extents of the frustum. More...
 
void setFrustumOffset (const Vector2 &offset)
 Sets frustum offsets, used in stereo rendering. More...
 
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 setLodBias (Real factor=1.0)
 Sets the level-of-detail factor for this Camera. More...
 
virtual void setLodCamera (const Camera *lodCam)
 Set a pointer to the camera which should be used to determine LOD settings. More...
 
void setMaterial (const MaterialPtr &mat)
 material to use for debug display More...
 
void setNearClipDistance (Real nearDist)
 Sets the position of the near clipping plane. More...
 
void setOrientation (const Quaternion &q)
 Sets the camera's orientation. More...
 
void setOrientationMode (OrientationMode orientationMode)
 Set the orientation mode of the frustum. More...
 
void setOrthoWindow (Real w, Real h)
 Sets the orthographic window settings, for use with orthographic rendering only. More...
 
void setOrthoWindowHeight (Real h)
 Sets the orthographic window height, for use with orthographic rendering only. More...
 
void setOrthoWindowWidth (Real w)
 Sets the orthographic window width, for use with orthographic rendering only. More...
 
void setPolygonMode (PolygonMode sd)
 Sets the level of rendering detail required from this camera. More...
 
void setPolygonModeOverrideable (bool override)
 Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
 
void setPosition (Real x, Real y, Real z)
 Sets the camera's position. More...
 
void setPosition (const Vector3 &vec)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
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...
 
virtual void setRenderQueueGroupAndPriority (uint8 queueID, ushort priority)
 Sets the render queue group and group priority this entity will be rendered through. More...
 
void setRenderSystemData (RenderSystemDataPtr 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...
 
void setUseMinPixelSize (bool enable)
 Sets whether to use min display size calculations. More...
 
void setUserAny (const Any &anything)
 
void setUserAny (const Any &anything)
 
virtual void setUseRenderingDistance (bool use)
 Set whether this camera should use the 'rendering distance' on objects to exclude distant objects from the final image. 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...
 
virtual void setWindow (Real left, Real top, Real right, Real bottom)
 Sets the viewing window inside of viewport. More...
 
virtual void synchroniseBaseSettingsWith (const Camera *cam)
 Synchronise core camera settings with another. More...
 
void update (void)
 
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...
 
void yaw (const Radian &angle)
 Rotates the camera anticlockwise around it's local y axis. More...
 

Static Public Member Functions

static void clearShadowRenderableList (ShadowRenderableList &shadowRenderables)
 Common implementation of releasing shadow renderables. More...
 
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...
 

Detailed Description

Specialized viewpoint from which an PCZone Scene can be rendered.

Member Typedef Documentation

◆ ShadowRenderableList

◆ ShadowRenderableListIterator

◆ RenderSystemDataPtr

Member Enumeration Documentation

◆ Visibility

Visibility types.

Enumerator
NONE 
PARTIAL 
FULL 

Constructor & Destructor Documentation

◆ PCZCamera()

Ogre::PCZCamera::PCZCamera ( const String name,
SceneManager sm 
)

◆ ~PCZCamera()

Ogre::PCZCamera::~PCZCamera ( )

Member Function Documentation

◆ getBoundingBox()

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

Overridden: Retrieves the local axis-aligned bounding box for this object.

Remarks
This bounding box is in local coordinates.

Reimplemented from Ogre::Frustum.

◆ isVisible() [1/5]

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

Tests whether the given container is visible in the Frustum.

Parameters
boundBounding box to be checked (world space).
culledByOptional pointer to an int which will be filled by the plane number which culled the box if the result was false;
Returns
If the box was visible, true is returned.
Otherwise, false is returned.

Reimplemented from Ogre::Camera.

◆ isVisible() [2/5]

bool Ogre::PCZCamera::isVisible ( PortalBase portal,
FrustumPlane culledBy = 0 
) const

◆ isVisibile()

bool Ogre::PCZCamera::isVisibile ( const AxisAlignedBox bound)

Returns the visibility of the box.

◆ getVisibility()

PCZCamera::Visibility Ogre::PCZCamera::getVisibility ( const AxisAlignedBox bound)

Returns the detailed visibility of the box.

◆ setProjectionType()

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

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

Reimplemented from Ogre::Frustum.

◆ update()

void Ogre::PCZCamera::update ( void  )

◆ addPortalCullingPlanes()

int Ogre::PCZCamera::addPortalCullingPlanes ( PortalBase portal)

Calculate extra culling planes from portal and camera origin and add to list of extra culling planes.

◆ removePortalCullingPlanes()

void Ogre::PCZCamera::removePortalCullingPlanes ( PortalBase portal)

Remove extra culling planes created from the given portal.

◆ removeAllExtraCullingPlanes()

void Ogre::PCZCamera::removeAllExtraCullingPlanes ( void  )

Remove all extra culling planes.

◆ addListener()

virtual void Ogre::Camera::addListener ( Listener l)
virtualinherited

Add a listener to this camera.

◆ removeListener()

virtual void Ogre::Camera::removeListener ( Listener l)
virtualinherited

Remove a listener to this camera.

◆ getSceneManager()

SceneManager* Ogre::Camera::getSceneManager ( void  ) const
inherited

Returns a pointer to the SceneManager this camera is rendering through.

◆ setPolygonMode()

void Ogre::Camera::setPolygonMode ( PolygonMode  sd)
inherited

Sets the level of rendering detail required from this camera.

Remarks
Each camera is set to render at full detail by default, that is with full texturing, lighting etc. This method lets you change that behaviour, allowing you to make the camera just render a wireframe view, for example.

◆ getPolygonMode()

PolygonMode Ogre::Camera::getPolygonMode ( void  ) const
inherited

Retrieves the level of detail that the camera will render.

◆ setPosition() [1/2]

void Ogre::Camera::setPosition ( Real  x,
Real  y,
Real  z 
)
inherited

Sets the camera's position.

Deprecated:
attach to SceneNode and use SceneNode::setPosition

◆ setPosition() [2/2]

void Ogre::Camera::setPosition ( const Vector3 vec)
inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Deprecated:
attach to SceneNode and use SceneNode::setPosition

◆ getPosition()

const Vector3& Ogre::Camera::getPosition ( void  ) const
inherited

Retrieves the camera's position.

Deprecated:
attach to SceneNode and use SceneNode::getPosition

◆ move()

void Ogre::Camera::move ( const Vector3 vec)
inherited

Moves the camera's position by the vector offset provided along world axes.

Deprecated:
attach to SceneNode and use SceneNode::translate

◆ moveRelative()

void Ogre::Camera::moveRelative ( const Vector3 vec)
inherited

Moves the camera's position by the vector offset provided along it's own axes (relative to orientation).

Deprecated:
attach to SceneNode and use SceneNode::translate(vec, Node::TS_LOCAL)

◆ setDirection() [1/2]

void Ogre::Camera::setDirection ( Real  x,
Real  y,
Real  z 
)
inherited

Sets the camera's direction vector.

Remarks
Note that the 'up' vector for the camera will automatically be recalculated based on the current 'up' vector (i.e. the roll will remain the same).
Deprecated:
attach to SceneNode and use SceneNode::setDirection

◆ setDirection() [2/2]

void Ogre::Camera::setDirection ( const Vector3 vec)
inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Deprecated:
attach to SceneNode and use SceneNode::setDirection

◆ getDirection()

Vector3 Ogre::Camera::getDirection ( void  ) const
inherited

Gets the camera's direction.

Deprecated:
attach to SceneNode and use SceneNode::getLocalAxes

◆ getUp()

Vector3 Ogre::Camera::getUp ( void  ) const
inherited

Gets the camera's up vector.

Deprecated:
attach to SceneNode and use SceneNode::getLocalAxes

◆ getRight()

Vector3 Ogre::Camera::getRight ( void  ) const
inherited

Gets the camera's right vector.

Deprecated:
attach to SceneNode and use SceneNode::getLocalAxes

◆ lookAt() [1/2]

void Ogre::Camera::lookAt ( const Vector3 targetPoint)
inherited

Points the camera at a location in worldspace.

Remarks
This is a helper method to automatically generate the direction vector for the camera, based on it's current position and the supplied look-at point.
Parameters
targetPointA vector specifying the look at point.
Deprecated:
attach to SceneNode and use SceneNode::lookAt

◆ lookAt() [2/2]

void Ogre::Camera::lookAt ( Real  x,
Real  y,
Real  z 
)
inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Deprecated:
attach to SceneNode and use SceneNode::lookAt

◆ roll()

void Ogre::Camera::roll ( const Radian angle)
inherited

Rolls the camera anticlockwise, around its local z axis.

Deprecated:
attach to SceneNode and use SceneNode::roll

◆ yaw()

void Ogre::Camera::yaw ( const Radian angle)
inherited

Rotates the camera anticlockwise around it's local y axis.

Deprecated:
attach to SceneNode and use SceneNode::yaw

◆ pitch()

void Ogre::Camera::pitch ( const Radian angle)
inherited

Pitches the camera up/down anticlockwise around it's local z axis.

Deprecated:
attach to SceneNode and use SceneNode::pitch

◆ rotate() [1/2]

void Ogre::Camera::rotate ( const Vector3 axis,
const Radian angle 
)
inherited

Rotate the camera around an arbitrary axis.

Deprecated:
attach to SceneNode and use SceneNode::rotate

◆ rotate() [2/2]

void Ogre::Camera::rotate ( const Quaternion q)
inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Deprecated:
attach to SceneNode and use SceneNode::rotate

◆ setFixedYawAxis()

void Ogre::Camera::setFixedYawAxis ( bool  useFixed,
const Vector3 fixedAxis = Vector3::UNIT_Y 
)
inherited

Tells the camera whether to yaw around it's own local Y axis or a fixed axis of choice.

Remarks
This method allows you to change the yaw behaviour of the camera
  • by default, the camera yaws around a fixed Y axis. This is often what you want - for example if you're making a first-person shooter, you really don't want the yaw axis to reflect the local camera Y, because this would mean a different yaw axis if the player is looking upwards rather than when they are looking straight ahead. You can change this behaviour by calling this method, which you will want to do if you are making a completely free camera like the kind used in a flight simulator.
Parameters
useFixedIf true, the axis passed in the second parameter will always be the yaw axis no matter what the camera orientation. If false, the camera yaws around the local Y.
fixedAxisThe axis to use if the first parameter is true.
Deprecated:
attach to SceneNode and use SceneNode::yaw(angle, Node::TS_PARENT)

◆ getOrientation()

const Quaternion& Ogre::Camera::getOrientation ( void  ) const
inherited

Returns the camera's current orientation.

Deprecated:
attach to SceneNode and use SceneNode::getOrientation

◆ setOrientation()

void Ogre::Camera::setOrientation ( const Quaternion q)
inherited

Sets the camera's orientation.

Deprecated:
attach to SceneNode and use SceneNode::setOrientation

◆ _renderScene()

void Ogre::Camera::_renderScene ( Viewport vp,
bool  includeOverlays 
)
inherited

Tells the Camera to contact the SceneManager to render from it's viewpoint.

Parameters
vpThe viewport to render to
includeOverlaysWhether or not any overlay objects should be included

◆ _notifyRenderedFaces()

void Ogre::Camera::_notifyRenderedFaces ( unsigned int  numfaces)
inherited

Internal method to notify camera of the visible faces in the last render.

◆ _notifyRenderedBatches()

void Ogre::Camera::_notifyRenderedBatches ( unsigned int  numbatches)
inherited

Internal method to notify camera of the visible batches in the last render.

◆ _getNumRenderedFaces()

unsigned int Ogre::Camera::_getNumRenderedFaces ( void  ) const
inherited

Internal method to retrieve the number of visible faces in the last render.

◆ _getNumRenderedBatches()

unsigned int Ogre::Camera::_getNumRenderedBatches ( void  ) const
inherited

Internal method to retrieve the number of visible batches in the last render.

◆ getDerivedOrientation()

const Quaternion& Ogre::Camera::getDerivedOrientation ( void  ) const
inherited

Gets the derived orientation of the camera, including any rotation inherited from a node attachment and reflection matrix.

◆ getDerivedPosition()

const Vector3& Ogre::Camera::getDerivedPosition ( void  ) const
inherited

Gets the derived position of the camera, including any translation inherited from a node attachment and reflection matrix.

◆ getDerivedDirection()

Vector3 Ogre::Camera::getDerivedDirection ( void  ) const
inherited

Gets the derived direction vector of the camera, including any rotation inherited from a node attachment and reflection matrix.

◆ getDerivedUp()

Vector3 Ogre::Camera::getDerivedUp ( void  ) const
inherited

Gets the derived up vector of the camera, including any rotation inherited from a node attachment and reflection matrix.

◆ getDerivedRight()

Vector3 Ogre::Camera::getDerivedRight ( void  ) const
inherited

Gets the derived right vector of the camera, including any rotation inherited from a node attachment and reflection matrix.

◆ getRealOrientation()

const Quaternion& Ogre::Camera::getRealOrientation ( void  ) const
inherited

Gets the real world orientation of the camera, including any rotation inherited from a node attachment.

◆ getRealPosition()

const Vector3& Ogre::Camera::getRealPosition ( void  ) const
inherited

Gets the real world position of the camera, including any translation inherited from a node attachment.

◆ getRealDirection()

Vector3 Ogre::Camera::getRealDirection ( void  ) const
inherited

Gets the real world direction vector of the camera, including any rotation inherited from a node attachment.

◆ getRealUp()

Vector3 Ogre::Camera::getRealUp ( void  ) const
inherited

Gets the real world up vector of the camera, including any rotation inherited from a node attachment.

◆ getRealRight()

Vector3 Ogre::Camera::getRealRight ( void  ) const
inherited

Gets the real world right vector of the camera, including any rotation inherited from a node attachment.

◆ getWorldTransforms()

void Ogre::Camera::getWorldTransforms ( Matrix4 mat) const
virtualinherited

Overridden from Frustum/Renderable.

Implements Ogre::Renderable.

◆ getMovableType()

const String& Ogre::Camera::getMovableType ( void  ) const
virtualinherited

Overridden from MovableObject.

Implements Ogre::MovableObject.

◆ setAutoTracking()

void Ogre::Camera::setAutoTracking ( bool  enabled,
SceneNode *const  target = 0,
const Vector3 offset = Vector3::ZERO 
)
inherited

Enables / disables automatic tracking of a SceneNode.

Remarks
If you enable auto-tracking, this Camera will automatically rotate to look at the target SceneNode every frame, no matter how it or SceneNode move. This is handy if you want a Camera to be focused on a single object or group of objects. Note that by default the Camera looks at the origin of the SceneNode, if you want to tweak this, e.g. if the object which is attached to this target node is quite big and you want to point the camera at a specific point on it, provide a vector in the 'offset' parameter and the camera's target point will be adjusted.
Parameters
enabledIf true, the Camera will track the SceneNode supplied as the next parameter (cannot be null). If false the camera will cease tracking and will remain in it's current orientation.
targetPointer to the SceneNode which this Camera will track. Make sure you don't delete this SceneNode before turning off tracking (e.g. SceneManager::clearScene will delete it so be careful of this). Can be null if and only if the enabled param is false.
offsetIf supplied, the camera targets this point in local space of the target node instead of the origin of the target node. Good for fine tuning the look at point.
Deprecated:
attach to SceneNode and use SceneNode::setAutoTracking

◆ setLodBias()

void Ogre::Camera::setLodBias ( Real  factor = 1.0)
inherited

Sets the level-of-detail factor for this Camera.

Remarks
This method can be used to influence the overall level of detail of the scenes rendered using this camera. Various elements of the scene have level-of-detail reductions to improve rendering speed at distance; this method allows you to hint to those elements that you would like to adjust the level of detail that they would normally use (up or down).
The most common use for this method is to reduce the overall level of detail used for a secondary camera used for sub viewports like rear-view mirrors etc. Note that scene elements are at liberty to ignore this setting if they choose, this is merely a hint.
Parameters
factorThe factor to apply to the usual level of detail calculation. Higher values increase the detail, so 2.0 doubles the normal detail and 0.5 halves it.

◆ getLodBias()

Real Ogre::Camera::getLodBias ( void  ) const
inherited

Returns the level-of-detail bias factor currently applied to this camera.

Remarks
See Camera::setLodBias for more details.

◆ setLodCamera()

virtual void Ogre::Camera::setLodCamera ( const Camera lodCam)
virtualinherited

Set a pointer to the camera which should be used to determine LOD settings.

Remarks
Sometimes you don't want the LOD of a render to be based on the camera that's doing the rendering, you want it to be based on a different camera. A good example is when rendering shadow maps, since they will be viewed from the perspective of another camera. Therefore this method lets you associate a different camera instance to use to determine the LOD.
To revert the camera to determining LOD based on itself, call this method with a pointer to itself.

◆ getLodCamera()

virtual const Camera* Ogre::Camera::getLodCamera ( ) const
virtualinherited

Get a pointer to the camera which should be used to determine LOD settings.

Remarks
If setLodCamera hasn't been called with a different camera, this method will return 'this'.

◆ getCameraToViewportRay() [1/2]

Ray Ogre::Camera::getCameraToViewportRay ( Real  screenx,
Real  screeny 
) const
inherited

Gets a world space ray as cast from the camera through a viewport position.

Parameters
screenx,screenyThe x and y position at which the ray should intersect the viewport, in normalised screen coordinates [0,1]

◆ getCameraToViewportRay() [2/2]

void Ogre::Camera::getCameraToViewportRay ( Real  screenx,
Real  screeny,
Ray outRay 
) const
inherited

Gets a world space ray as cast from the camera through a viewport position.

Parameters
screenx,screenyThe x and y position at which the ray should intersect the viewport, in normalised screen coordinates [0,1]
outRayRay instance to populate with result

◆ getCameraToViewportBoxVolume() [1/2]

PlaneBoundedVolume Ogre::Camera::getCameraToViewportBoxVolume ( Real  screenLeft,
Real  screenTop,
Real  screenRight,
Real  screenBottom,
bool  includeFarPlane = false 
)
inherited

Gets a world-space list of planes enclosing a volume based on a viewport rectangle.

Remarks
Can be useful for populating a PlaneBoundedVolumeListSceneQuery, e.g. for a rubber-band selection.
Parameters
screenLeft,screenTop,screenRight,screenBottomThe bounds of the on-screen rectangle, expressed in normalised screen coordinates [0,1]
includeFarPlaneIf true, the volume is truncated by the camera far plane, by default it is left open-ended

◆ getCameraToViewportBoxVolume() [2/2]

void Ogre::Camera::getCameraToViewportBoxVolume ( Real  screenLeft,
Real  screenTop,
Real  screenRight,
Real  screenBottom,
PlaneBoundedVolume outVolume,
bool  includeFarPlane = false 
)
inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ _getLodBiasInverse()

Real Ogre::Camera::_getLodBiasInverse ( void  ) const
inherited

Internal method for OGRE to use for LOD calculations.

◆ _autoTrack()

void Ogre::Camera::_autoTrack ( void  )
inherited

Internal method used by OGRE to update auto-tracking cameras.

◆ setWindow()

virtual void Ogre::Camera::setWindow ( Real  left,
Real  top,
Real  right,
Real  bottom 
)
virtualinherited

Sets the viewing window inside of viewport.

Remarks
This method can be used to set a subset of the viewport as the rendering target.
Parameters
leftRelative to Viewport - 0 corresponds to left edge, 1 - to right edge (default - 0).
topRelative to Viewport - 0 corresponds to top edge, 1 - to bottom edge (default - 0).
rightRelative to Viewport - 0 corresponds to left edge, 1 - to right edge (default - 1).
bottomRelative to Viewport - 0 corresponds to top edge, 1 - to bottom edge (default - 1).

◆ resetWindow()

virtual void Ogre::Camera::resetWindow ( void  )
virtualinherited

Cancel view window.

◆ isWindowSet()

virtual bool Ogre::Camera::isWindowSet ( void  ) const
inlinevirtualinherited

Returns if a viewport window is being used.

◆ getWindowPlanes()

const std::vector<Plane>& Ogre::Camera::getWindowPlanes ( void  ) const
inherited

Gets the window clip planes, only applicable if isWindowSet == true.

◆ getBoundingRadius()

Real Ogre::Camera::getBoundingRadius ( void  ) const
virtualinherited

Overridden from MovableObject.

Implements Ogre::MovableObject.

◆ getAutoTrackTarget()

SceneNode* Ogre::Camera::getAutoTrackTarget ( void  ) const
inlineinherited

Get the auto tracking target for this camera, if any.

◆ getAutoTrackOffset()

const Vector3& Ogre::Camera::getAutoTrackOffset ( void  ) const
inlineinherited

Get the auto tracking offset for this camera, if it is auto tracking.

◆ getViewport()

Viewport* Ogre::Camera::getViewport ( void  ) const
inlineinherited

Get the last viewport which was attached to this camera.

Note
This is not guaranteed to be the only viewport which is using this camera, just the last once which was created referring to it.

◆ _notifyViewport()

void Ogre::Camera::_notifyViewport ( Viewport viewport)
inlineinherited

Notifies this camera that a viewport is using it.

◆ setAutoAspectRatio()

void Ogre::Camera::setAutoAspectRatio ( bool  autoratio)
inherited

If set to true a viewport that owns this frustum will be able to recalculate the aspect ratio whenever the frustum is resized.

Remarks
You should set this to true only if the frustum / camera is used by one viewport at the same time. Otherwise the aspect ratio for other viewports may be wrong.

◆ getAutoAspectRatio()

bool Ogre::Camera::getAutoAspectRatio ( void  ) const
inherited

Retrieves if AutoAspectRatio is currently set or not.

◆ setCullingFrustum()

void Ogre::Camera::setCullingFrustum ( Frustum frustum)
inlineinherited

Tells the camera to use a separate Frustum instance to perform culling.

Remarks
By calling this method, you can tell the camera to perform culling against a different frustum to it's own. This is mostly useful for debug cameras that allow you to show the culling behaviour of another camera, or a manual frustum instance.
Parameters
frustumPointer to a frustum to use; this can either be a manual Frustum instance (which you can attach to scene nodes like any other MovableObject), or another camera. If you pass 0 to this method it reverts the camera to normal behaviour.

◆ getCullingFrustum()

Frustum* Ogre::Camera::getCullingFrustum ( void  ) const
inlineinherited

Returns the custom culling frustum in use.

◆ forwardIntersect()

virtual void Ogre::Camera::forwardIntersect ( const Plane worldPlane,
std::vector< Vector4 > *  intersect3d 
) const
virtualinherited

Forward projects frustum rays to find forward intersection with plane.

Remarks
Forward projection may lead to intersections at infinity.

◆ isVisible() [3/5]

bool Ogre::Camera::isVisible ( const Sphere bound,
FrustumPlane culledBy = 0 
) const
virtualinherited

Tests whether the given container is visible in the Frustum.

Parameters
boundBounding sphere to be checked (world space).
culledByOptional pointer to an int which will be filled by the plane number which culled the box if the result was false;
Returns
If the sphere was visible, true is returned.
Otherwise, false is returned.

Reimplemented from Ogre::Frustum.

◆ isVisible() [4/5]

bool Ogre::Camera::isVisible ( const Vector3 vert,
FrustumPlane culledBy = 0 
) const
virtualinherited

Tests whether the given vertex is visible in the Frustum.

Parameters
vertVertex to be checked (world space).
culledByOptional pointer to an int which will be filled by the plane number which culled the box if the result was false;
Returns
If the sphere was visible, true is returned.
Otherwise, false is returned.

Reimplemented from Ogre::Frustum.

◆ isVisible() [5/5]

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

Returns whether or not this object is supposed to be visible or not.

Remarks
Takes into account both upper rendering distance and visible flag.

Reimplemented in Ogre::StaticGeometry::Region.

Referenced by Ogre::Frustum::isCustomProjectionMatrixEnabled().

◆ getWorldSpaceCorners()

const Vector3* Ogre::Camera::getWorldSpaceCorners ( void  ) const
virtualinherited

Gets the world space corners of the frustum.

Remarks
The corners are ordered as follows: top-right near, top-left near, bottom-left near, bottom-right near, top-right far, top-left far, bottom-left far, bottom-right far.

Reimplemented from Ogre::Frustum.

◆ getFrustumPlane()

const Plane& Ogre::Camera::getFrustumPlane ( unsigned short  plane) const
virtualinherited

Retrieves a specified plane of the frustum (world space).

Remarks
Gets a reference to one of the planes which make up the frustum frustum, e.g. for clipping purposes.

Reimplemented from Ogre::Frustum.

◆ projectSphere()

bool Ogre::Camera::projectSphere ( const Sphere sphere,
Real left,
Real top,
Real right,
Real bottom 
) const
virtualinherited

Project a sphere onto the near plane and get the bounding rectangle.

Parameters
sphereThe world-space sphere to project.
leftPointers to destination values, these will be completed with the normalised device coordinates (in the range {-1,1}).
topPointers to destination values, these will be completed with the normalised device coordinates (in the range {-1,1}).
rightPointers to destination values, these will be completed with the normalised device coordinates (in the range {-1,1}).
bottomPointers to destination values, these will be completed with the normalised device coordinates (in the range {-1,1}).
Returns
true if the sphere was projected to a subset of the near plane, false if the entire near plane was contained.

Reimplemented from Ogre::Frustum.

◆ getNearClipDistance()

Real Ogre::Camera::getNearClipDistance ( void  ) const
inherited

Sets the position of the near clipping plane.

◆ getFarClipDistance()

Real Ogre::Camera::getFarClipDistance ( void  ) const
inherited

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

◆ getViewMatrix() [1/2]

const Affine3& Ogre::Camera::getViewMatrix ( void  ) const
inherited

Gets the view matrix for this frustum.

Mainly for use by OGRE internally.

◆ getViewMatrix() [2/2]

const Affine3& Ogre::Camera::getViewMatrix ( bool  ownFrustumOnly) const
inherited

Specialised version of getViewMatrix allowing caller to differentiate whether the custom culling frustum should be allowed or not.

Remarks
The default behaviour of the standard getViewMatrix is to delegate to the alternate culling frustum, if it is set. This is expected when performing CPU calculations, but the final rendering must be performed using the real view matrix in order to display the correct debug view.

◆ setUseRenderingDistance()

virtual void Ogre::Camera::setUseRenderingDistance ( bool  use)
inlinevirtualinherited

Set whether this camera should use the 'rendering distance' on objects to exclude distant objects from the final image.

The default behaviour is to use it.

Parameters
useTrue to use the rendering distance, false not to.

◆ getUseRenderingDistance()

virtual bool Ogre::Camera::getUseRenderingDistance ( void  ) const
inlinevirtualinherited

Get whether this camera should use the 'rendering distance' on objects to exclude distant objects from the final image.

◆ synchroniseBaseSettingsWith()

virtual void Ogre::Camera::synchroniseBaseSettingsWith ( const Camera cam)
virtualinherited

Synchronise core camera settings with another.

Remarks
Copies the position, orientation, clip distances, projection type, FOV, focal length and aspect ratio from another camera. Other settings like query flags, reflection etc are preserved.

◆ getPositionForViewUpdate()

const Vector3& Ogre::Camera::getPositionForViewUpdate ( void  ) const
virtualinherited

Get the derived position of this frustum.

Reimplemented from Ogre::Frustum.

◆ getOrientationForViewUpdate()

const Quaternion& Ogre::Camera::getOrientationForViewUpdate ( void  ) const
virtualinherited

Get the derived orientation of this frustum.

Reimplemented from Ogre::Frustum.

◆ setUseMinPixelSize()

void Ogre::Camera::setUseMinPixelSize ( bool  enable)
inlineinherited

Sets whether to use min display size calculations.

When active, objects that derive from MovableObject whose size on the screen is less then a MovableObject::mMinPixelSize will not be rendered.

◆ getUseMinPixelSize()

bool Ogre::Camera::getUseMinPixelSize ( ) const
inlineinherited

Returns whether to use min display size calculations.

See also
Camera::setUseMinDisplaySize

◆ getPixelDisplayRatio()

Real Ogre::Camera::getPixelDisplayRatio ( ) const
inlineinherited

Returns an estimated ratio between a pixel and the display area it represents.

For orthographic cameras this function returns the amount of meters covered by a single pixel along the vertical axis. For perspective cameras the value returned is the amount of meters covered by a single pixel per meter distance from the camera.

Note
This parameter is calculated just before the camera is rendered
This parameter is used in min display size calculations.

◆ setFOVy()

void Ogre::Frustum::setFOVy ( const Radian fovy)
inherited

Sets the Y-dimension Field Of View (FOV) of the frustum.

Remarks
Field Of View (FOV) is the angle made between the frustum's position, and the edges of the 'screen' onto which the scene is projected. High values (90+ degrees) result in a wide-angle, fish-eye kind of view, low values (30- degrees) in a stretched, telescopic kind of view. Typical values are between 45 and 60 degrees.
This value represents the VERTICAL field-of-view. The horizontal field of view is calculated from this depending on the dimensions of the viewport (they will only be the same if the viewport is square).
Note
Setting the FOV overrides the value supplied for frustum::setNearClipPlane.

◆ getFOVy()

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

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

◆ setNearClipDistance()

void Ogre::Frustum::setNearClipDistance ( Real  nearDist)
inherited

Sets the position of the near clipping plane.

Remarks
The position of the near clipping plane is the distance from the frustums position to the screen on which the world is projected. The near plane distance, combined with the field-of-view and the aspect ratio, determines the size of the viewport through which the world is viewed (in world co-ordinates). Note that this world viewport is different to a screen viewport, which has it's dimensions expressed in pixels. The frustums viewport should have the same aspect ratio as the screen viewport it renders into to avoid distortion.
Parameters
nearDistThe distance to the near clipping plane from the frustum in world coordinates.

◆ setFarClipDistance()

void Ogre::Frustum::setFarClipDistance ( Real  farDist)
inherited

Sets the distance to the far clipping plane.

Remarks
The view frustum is a pyramid created from the frustum position and the edges of the viewport. This method sets the distance for the far end of that pyramid. Different applications need different values: e.g. a flight sim needs a much further far clipping plane than a first-person shooter. An important point here is that the larger the ratio between near and far clipping planes, the lower the accuracy of the Z-buffer used to depth-cue pixels. This is because the Z-range is limited to the size of the Z buffer (16 or 32-bit) and the max values must be spread over the gap between near and far clip planes. As it happens, you can affect the accuracy far more by altering the near distance rather than the far distance, but keep this in mind.
Parameters
farDistThe 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.

◆ setAspectRatio()

void Ogre::Frustum::setAspectRatio ( Real  ratio)
inherited

Sets the aspect ratio for the frustum viewport.

Remarks
The ratio between the x and y dimensions of the rectangular area visible through the frustum is known as aspect ratio: aspect = width / height .
The default for most fullscreen windows is 1.3333 - this is also assumed by Ogre unless you use this method to state otherwise.

◆ getAspectRatio()

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

Retrieves the current aspect ratio.

◆ setFrustumOffset() [1/2]

void Ogre::Frustum::setFrustumOffset ( const Vector2 offset)
inherited

Sets frustum offsets, used in stereo rendering.

Remarks
You can set both horizontal and vertical plane offsets of "eye"; in stereo rendering frustum is moved in horizontal plane. To be able to render from two "eyes" you'll need two cameras rendering on two RenderTargets.
The frustum offsets is in world coordinates, and default to (0, 0) - no offsets.
Parameters
offsetThe horizontal and vertical plane offsets.

◆ setFrustumOffset() [2/2]

void Ogre::Frustum::setFrustumOffset ( Real  horizontal = 0.0,
Real  vertical = 0.0 
)
inherited

Sets frustum offsets, used in stereo rendering.

Remarks
You can set both horizontal and vertical plane offsets of "eye"; in stereo rendering frustum is moved in horizontal plane. To be able to render from two "eyes" you'll need two cameras rendering on two RenderTargets.
The frustum offsets is in world coordinates, and default to (0, 0) - no offsets.
Parameters
horizontalThe horizontal plane offset.
verticalThe vertical plane offset.

◆ getFrustumOffset()

const Vector2& Ogre::Frustum::getFrustumOffset ( ) const
inherited

Retrieves the frustum offsets.

◆ setFocalLength()

void Ogre::Frustum::setFocalLength ( Real  focalLength = 1.0)
inherited

Sets frustum focal length (used in stereo rendering).

Parameters
focalLengthThe distance to the focal plane from the frustum in world coordinates.

◆ getFocalLength()

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

Returns focal length of frustum.

◆ setFrustumExtents()

void Ogre::Frustum::setFrustumExtents ( Real  left,
Real  right,
Real  top,
Real  bottom 
)
inherited

Manually set the extents of the frustum.

Parameters
left,right,top,bottomThe position where the side clip planes intersect the near clip plane, in eye space

◆ resetFrustumExtents()

void Ogre::Frustum::resetFrustumExtents ( )
inherited

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

◆ getFrustumExtents() [1/2]

RealRect Ogre::Frustum::getFrustumExtents ( ) const
inherited

Get the extents of the frustum in view space.

◆ getFrustumExtents() [2/2]

void Ogre::Frustum::getFrustumExtents ( Real outleft,
Real outright,
Real outtop,
Real outbottom 
) const
inherited
Deprecated:

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ getProjectionMatrixRS()

const Matrix4& Ogre::Frustum::getProjectionMatrixRS ( void  ) const
inherited

Gets the projection matrix for this frustum adjusted for the current rendersystem specifics (may be right or left-handed, depth range may vary).

Remarks
This method retrieves the rendering-API dependent version of the projection matrix. If you want a 'typical' projection matrix then use getProjectionMatrix.

◆ getProjectionMatrixWithRSDepth()

const Matrix4& Ogre::Frustum::getProjectionMatrixWithRSDepth ( void  ) const
inherited

Gets the depth-adjusted projection matrix for the current rendersystem, but one which still conforms to right-hand rules.

Remarks
This differs from the rendering-API dependent getProjectionMatrix in that it always returns a right-handed projection matrix result no matter what rendering API is being used - this is required for vertex and fragment programs for example. However, the resulting depth range may still vary between render systems since D3D uses [0,1] and GL uses [-1,1], and the range must be kept the same between programmable and fixed-function pipelines.

◆ getProjectionMatrix()

const Matrix4& Ogre::Frustum::getProjectionMatrix ( void  ) const
inherited

Gets the normal projection matrix for this frustum, ie the projection matrix which conforms to standard right-handed rules and uses depth range [-1,+1].

Remarks
This differs from the rendering-API dependent getProjectionMatrixRS in that it always returns a right-handed projection matrix with depth range [-1,+1], result no matter what rendering API is being used - this is required for some uniform algebra for example.

◆ calcViewMatrixRelative()

void Ogre::Frustum::calcViewMatrixRelative ( const Vector3 relPos,
Matrix4 matToUpdate 
) const
inherited

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)

◆ setCustomViewMatrix()

void Ogre::Frustum::setCustomViewMatrix ( bool  enable,
const Affine3 viewMatrix = Affine3::IDENTITY 
)
inherited

Set whether to use a custom view matrix on this frustum.

Remarks
This is an advanced method which allows you to manually set the view matrix on this frustum, rather than having it calculate itself based on it's position and orientation.
Note
After enabling a custom view matrix, the frustum will no longer update on its own based on position / orientation changes. You are completely responsible for keeping the view matrix up to date. The custom matrix will be returned from getViewMatrix.
Parameters
enableIf true, the custom view matrix passed as the second parameter will be used in preference to an auto calculated one. If false, the frustum will revert to auto calculating the view matrix.
viewMatrixThe custom view matrix to use
See also
Frustum::setCustomProjectionMatrix

◆ isCustomViewMatrixEnabled()

bool Ogre::Frustum::isCustomViewMatrixEnabled ( void  ) const
inlineinherited

Returns whether a custom view matrix is in use.

References Ogre::Matrix4::IDENTITY.

◆ setCustomProjectionMatrix()

void Ogre::Frustum::setCustomProjectionMatrix ( bool  enable,
const Matrix4 projectionMatrix = Matrix4::IDENTITY 
)
inherited

Set whether to use a custom projection matrix on this frustum.

Remarks
This is an advanced method which allows you to manually set the projection matrix on this frustum, rather than having it calculate itself based on it's position and orientation.
Note
After enabling a custom projection matrix, the frustum will no longer update on its own based on field of view and near / far distance changes. You are completely responsible for keeping the projection matrix up to date if those values change. The custom matrix will be returned from getProjectionMatrix and derivative functions.
Parameters
enableIf true, the custom projection matrix passed as the second parameter will be used in preference to an auto calculated one. If false, the frustum will revert to auto calculating the projection matrix.
projectionMatrixThe custom view matrix to use.
See also
Frustum::setCustomViewMatrix

◆ isCustomProjectionMatrixEnabled()

bool Ogre::Frustum::isCustomProjectionMatrixEnabled ( void  ) const
inlineinherited

Returns whether a custom projection matrix is in use.

References Ogre::MovableObject::isVisible().

◆ getFrustumPlanes()

virtual const Plane* Ogre::Frustum::getFrustumPlanes ( void  ) const
virtualinherited

Retrieves the clipping planes of the frustum (world space).

Remarks
The clipping planes are ordered as declared in enumerate constants FrustumPlane.

◆ getTypeFlags()

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

Overridden from MovableObject::getTypeFlags.

Reimplemented from Ogre::MovableObject.

◆ _updateRenderQueue()

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

Overridden from MovableObject.

Implements Ogre::MovableObject.

◆ _notifyCurrentCamera()

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

Overridden from MovableObject.

Reimplemented from Ogre::MovableObject.

◆ setMaterial()

void Ogre::Frustum::setMaterial ( const MaterialPtr mat)
inherited

material to use for debug display

◆ getMaterial()

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

Overridden from Renderable.

Implements Ogre::Renderable.

◆ getRenderOperation()

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

Overridden from Renderable.

Implements Ogre::Renderable.

◆ getSquaredViewDepth()

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

Overridden from Renderable.

Implements Ogre::Renderable.

◆ getLights()

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

Overridden from Renderable.

Implements Ogre::Renderable.

◆ getProjectionType()

ProjectionType Ogre::Frustum::getProjectionType ( void  ) const
inherited

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

◆ setOrthoWindow()

void Ogre::Frustum::setOrthoWindow ( Real  w,
Real  h 
)
inherited

Sets the orthographic window settings, for use with orthographic rendering only.

Note
Calling this method will recalculate the aspect ratio, use setOrthoWindowHeight or setOrthoWindowWidth alone if you wish to preserve the aspect ratio but just fit one or other dimension to a particular size.
Parameters
wThe width of the view window in world units.
hThe height of the view window in world units.

◆ setOrthoWindowHeight()

void Ogre::Frustum::setOrthoWindowHeight ( Real  h)
inherited

Sets the orthographic window height, for use with orthographic rendering only.

Note
The width of the window will be calculated from the aspect ratio.
Parameters
hThe height of the view window in world units.

◆ setOrthoWindowWidth()

void Ogre::Frustum::setOrthoWindowWidth ( Real  w)
inherited

Sets the orthographic window width, for use with orthographic rendering only.

Note
The height of the window will be calculated from the aspect ratio.
Parameters
wThe width of the view window in world units.

◆ getOrthoWindowHeight()

Real Ogre::Frustum::getOrthoWindowHeight ( ) const
inherited

Gets the orthographic window height, for use with orthographic rendering only.

◆ getOrthoWindowWidth()

Real Ogre::Frustum::getOrthoWindowWidth ( ) const
inherited

Gets the orthographic window width, for use with orthographic rendering only.

Note
This is calculated from the orthographic height and the aspect ratio

◆ enableReflection() [1/2]

void Ogre::Frustum::enableReflection ( const Plane p)
inherited

Modifies this frustum so it always renders from the reflection of itself through the plane specified.

Remarks
This is obviously useful for performing planar reflections.

◆ enableReflection() [2/2]

void Ogre::Frustum::enableReflection ( const MovablePlane p)
inherited

Modifies this frustum so it always renders from the reflection of itself through the plane specified.

Note that this version of the method links to a plane so that changes to it are picked up automatically. It is important that this plane continues to exist whilst this object does; do not destroy the plane before the frustum.

Remarks
This is obviously useful for performing planar reflections.

◆ disableReflection()

void Ogre::Frustum::disableReflection ( void  )
inherited

Disables reflection modification previously turned on with enableReflection.

◆ isReflected()

bool Ogre::Frustum::isReflected ( void  ) const
inlineinherited

Returns whether this frustum is being reflected.

◆ getReflectionMatrix()

const Affine3& Ogre::Frustum::getReflectionMatrix ( void  ) const
inlineinherited

Returns the reflection matrix of the frustum if appropriate.

◆ getReflectionPlane()

const Plane& Ogre::Frustum::getReflectionPlane ( void  ) const
inlineinherited

Returns the reflection plane of the frustum if appropriate.

◆ enableCustomNearClipPlane() [1/2]

void Ogre::Frustum::enableCustomNearClipPlane ( const MovablePlane plane)
inherited

Links the frustum to a custom near clip plane, which can be used to clip geometry in a custom manner without using user clip planes.

Remarks
There are several applications for clipping a scene arbitrarily by a single plane; the most common is when rendering a reflection to a texture, and you only want to render geometry that is above the water plane (to do otherwise results in artefacts). Whilst it is possible to use user clip planes, they are not supported on all cards, and sometimes are not hardware accelerated when they are available. Instead, where a single clip plane is involved, this technique uses a 'fudging' of the near clip plane, which is available and fast on all hardware, to perform as the arbitrary clip plane. This does change the shape of the frustum, leading to some depth buffer loss of precision, but for many of the uses of this technique that is not an issue.
This version of the method links to a plane, rather than requiring a by-value plane definition, and therefore you can make changes to the plane (e.g. by moving / rotating the node it is attached to) and they will automatically affect this object.
Note
This technique only works for perspective projection.
Parameters
planeThe plane to link to to perform the clipping. This plane must continue to exist while the camera is linked to it; do not destroy it before the frustum.

◆ enableCustomNearClipPlane() [2/2]

void Ogre::Frustum::enableCustomNearClipPlane ( const Plane plane)
inherited

Links the frustum to a custom near clip plane, which can be used to clip geometry in a custom manner without using user clip planes.

Remarks
There are several applications for clipping a scene arbitrarily by a single plane; the most common is when rendering a reflection to a texture, and you only want to render geometry that is above the water plane (to do otherwise results in artefacts). Whilst it is possible to use user clip planes, they are not supported on all cards, and sometimes are not hardware accelerated when they are available. Instead, where a single clip plane is involved, this technique uses a 'fudging' of the near clip plane, which is available and fast on all hardware, to perform as the arbitrary clip plane. This does change the shape of the frustum, leading to some depth buffer loss of precision, but for many of the uses of this technique that is not an issue.
Note
This technique only works for perspective projection.
Parameters
planeThe plane to link to to perform the clipping. This plane must continue to exist while the camera is linked to it; do not destroy it before the frustum.

◆ disableCustomNearClipPlane()

void Ogre::Frustum::disableCustomNearClipPlane ( void  )
inherited

Disables any custom near clip plane.

◆ isCustomNearClipPlaneEnabled()

bool Ogre::Frustum::isCustomNearClipPlaneEnabled ( void  ) const
inlineinherited

Is a custom near clip plane in use?

◆ visitRenderables()

void Ogre::Frustum::visitRenderables ( Renderable::Visitor visitor,
bool  debugRenderables = false 
)
virtualinherited

Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any.

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

Implements Ogre::MovableObject.

◆ getPlaneBoundedVolume()

PlaneBoundedVolume Ogre::Frustum::getPlaneBoundedVolume ( )
inherited

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

◆ setOrientationMode()

void Ogre::Frustum::setOrientationMode ( OrientationMode  orientationMode)
inherited

Set the orientation mode of the frustum.

Default is OR_DEGREE_0

Remarks
Setting the orientation of a frustum is only supported on iOS at this time. An exception is thrown on other platforms.

◆ getOrientationMode()

OrientationMode Ogre::Frustum::getOrientationMode ( ) const
inherited

Get the orientation mode of the frustum.

Remarks
Getting the orientation of a frustum is only supported on iOS at this time. An exception is thrown on other platforms.

◆ _notifyCreator()

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

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

◆ _getCreator()

MovableObjectFactory* Ogre::MovableObject::_getCreator ( void  ) const
inlineinherited

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

◆ _notifyManager()

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

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

◆ _getManager()

SceneManager* Ogre::MovableObject::_getManager ( void  ) const
inlineinherited

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

◆ _releaseManualHardwareResources()

virtual void Ogre::MovableObject::_releaseManualHardwareResources ( )
inlinevirtualinherited

Notifies the movable object that hardware resources were lost.

Remarks
Called automatically by RenderSystem if hardware resources were lost and can not be restored using some internal mechanism. Among affected resources are nested shadow renderables, ManualObjects, etc.

Reimplemented in Ogre::BillboardSet, Ogre::StaticGeometry::Region, Ogre::Entity, and Ogre::ManualObject.

◆ _restoreManualHardwareResources()

virtual void Ogre::MovableObject::_restoreManualHardwareResources ( )
inlinevirtualinherited

Notifies the movable object that hardware resources should be restored.

Remarks
Called automatically by RenderSystem if hardware resources were lost and can not be restored using some internal mechanism. Among affected resources are nested shadow renderables, ManualObjects, etc.

Reimplemented in Ogre::StaticGeometry::Region, and Ogre::Entity.

◆ getName()

const String& Ogre::MovableObject::getName ( void  ) const
inlineinherited

Returns the name of this object.

◆ getParentNode()

Node* Ogre::MovableObject::getParentNode ( void  ) const
inlineinherited

Returns the node to which this object is attached.

Remarks
A MovableObject may be attached to either a SceneNode or to a TagPoint, the latter case if it's attached to a bone on an animated entity. Both are Node subclasses so this method will return either.

◆ getParentSceneNode()

SceneNode* Ogre::MovableObject::getParentSceneNode ( void  ) const
inherited

Returns the scene node to which this object is attached.

Remarks
A MovableObject may be attached to either a SceneNode or to a TagPoint, the latter case if it's attached to a bone on an animated entity. This method will return the scene node of the parent entity if the latter is true.

◆ isParentTagPoint()

bool Ogre::MovableObject::isParentTagPoint ( ) const
inlineinherited

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

◆ _notifyAttached()

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

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

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

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

◆ isAttached()

bool Ogre::MovableObject::isAttached ( void  ) const
inlineinherited

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

◆ detachFromParent()

void Ogre::MovableObject::detachFromParent ( void  )
inherited

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

◆ isInScene()

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

Returns true if this object is attached to a SceneNode or TagPoint, and this SceneNode / TagPoint is currently in an active part of the scene graph.

Reimplemented in Ogre::InstancedEntity.

◆ _notifyMoved()

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

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

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

◆ getWorldBoundingBox()

virtual const AxisAlignedBox& Ogre::MovableObject::getWorldBoundingBox ( bool  derive = false) const
virtualinherited

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

Implements Ogre::ShadowCaster.

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

◆ getWorldBoundingSphere()

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

Retrieves the worldspace bounding sphere for this object.

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

◆ setVisible()

void Ogre::MovableObject::setVisible ( bool  visible)
inlineinherited

Tells this object whether to be visible or not, if it has a renderable component.

Note
An alternative approach of making an object invisible is to detach it from it's SceneNode, or to remove the SceneNode entirely. Detaching a node means that structurally the scene graph changes. Once this change has taken place, the objects / nodes that have been removed have less overhead to the visibility detection pass than simply making the object invisible, so if you do this and leave the objects out of the tree for a long time, it's faster. However, the act of detaching / reattaching nodes is in itself more expensive than setting an object visibility flag, since in the latter case structural changes are not made. Therefore, small or frequent visibility changes are best done using this method; large or more longer term changes are best done by detaching.

Referenced by Ogre::Light::setVisible().

◆ getVisible()

bool Ogre::MovableObject::getVisible ( void  ) const
inlineinherited

Gets this object whether to be visible or not, if it has a renderable component.

Remarks
Returns the value set by MovableObject::setVisible only.

◆ setRenderingDistance()

void Ogre::MovableObject::setRenderingDistance ( Real  dist)
inlineinherited

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

Note
Camera::setUseRenderingDistance() needs to be called for this parameter to be used.
Parameters
distDistance beyond which the object will not be rendered (the default is 0, which means objects are always rendered).

◆ getRenderingDistance()

Real Ogre::MovableObject::getRenderingDistance ( void  ) const
inlineinherited

Gets the distance at which batches are no longer rendered.

◆ setRenderingMinPixelSize()

void Ogre::MovableObject::setRenderingMinPixelSize ( Real  pixelSize)
inlineinherited

Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered.

Note
Camera::setUseMinPixelSize() needs to be called for this parameter to be used.
Parameters
pixelSizeNumber of minimum pixels (the default is 0, which means objects are always rendered).

◆ getRenderingMinPixelSize()

Real Ogre::MovableObject::getRenderingMinPixelSize ( ) const
inlineinherited

Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered.

◆ setUserAny() [1/2]

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

Sets any kind of user value on this object.

Remarks
This method allows you to associate any user value you like with this MovableObject. This can be a pointer back to one of your own classes for instance.

◆ setUserAny() [2/2]

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

Sets any kind of user value on this object.

Remarks
This method allows you to associate any user value you like with this Renderable. This can be a pointer back to one of your own classes for instance.

Referenced by Ogre::InstanceBatch::getRenderOperation().

◆ getUserAny() [1/2]

const Any& Ogre::MovableObject::getUserAny ( void  ) const
inlineinherited
Deprecated:
use UserObjectBindings::getUserAny via getUserObjectBindings() instead.

Retrieves the custom user value associated with this object.

◆ getUserAny() [2/2]

const Any& Ogre::Renderable::getUserAny ( void  ) const
inlineinherited
Deprecated:
use UserObjectBindings::getUserAny via getUserObjectBindings() instead.

Retrieves the custom user value associated with this object.

Referenced by Ogre::InstanceBatch::getRenderOperation().

◆ getUserObjectBindings() [1/4]

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

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

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

See also
UserObjectBindings::setUserAny.

◆ getUserObjectBindings() [2/4]

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

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

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

See also
UserObjectBindings::setUserAny.

◆ getUserObjectBindings() [3/4]

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

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

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

See also
UserObjectBindings::setUserAny.

◆ getUserObjectBindings() [4/4]

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

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

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

See also
UserObjectBindings::setUserAny.

◆ setRenderQueueGroup()

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

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

Remarks
Render queues are grouped to allow you to more tightly control the ordering of rendered objects. If you do not call this method, all Entity objects default to the default queue (RenderQueue::getDefaultQueueGroup), which is fine for most objects. You may want to alter this if you want this entity to always appear in front of other objects, e.g. for a 3D menu system or such.
See RenderQueue for more details.
Parameters
queueIDEnumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here.

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

◆ setRenderQueueGroupAndPriority()

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

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

Remarks
Render queues are grouped to allow you to more tightly control the ordering of rendered objects. Within a single render group there another type of grouping called priority which allows further control. If you do not call this method, all Entity objects default to the default queue and priority (RenderQueue::getDefaultQueueGroup, RenderQueue::getDefaultRenderablePriority), which is fine for most objects. You may want to alter this if you want this entity to always appear in front of other objects, e.g. for a 3D menu system or such.
See RenderQueue for more details.
Parameters
queueIDEnumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here.
priorityThe priority within a group to use.

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

◆ getRenderQueueGroup()

uint8 Ogre::MovableObject::getRenderQueueGroup ( void  ) const
inlineinherited

Gets the queue group for this entity.

See also
setRenderQueueGroup

◆ _getParentNodeFullTransform()

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

Return the full transformation of the parent sceneNode or the attachingPoint node.

Reimplemented in Ogre::InstancedEntity.

◆ setQueryFlags()

void Ogre::MovableObject::setQueryFlags ( uint32  flags)
inlineinherited

Sets the query flags for this object.

Remarks
When performing a scene query, this object will be included or excluded according to flags on the object and flags on the query. This is a bitwise value, so only when a bit on these flags is set, will it be included in a query asking for that flag. The meaning of the bits is application-specific.

◆ addQueryFlags()

void Ogre::MovableObject::addQueryFlags ( uint32  flags)
inlineinherited

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

◆ removeQueryFlags()

void Ogre::MovableObject::removeQueryFlags ( uint32  flags)
inlineinherited

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

◆ getQueryFlags()

uint32 Ogre::MovableObject::getQueryFlags ( void  ) const
inlineinherited

Returns the query flags relevant for this object.

◆ setDefaultQueryFlags()

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

Set the default query flags for all future MovableObject instances.

◆ getDefaultQueryFlags()

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

Get the default query flags for all future MovableObject instances.

◆ setVisibilityFlags()

void Ogre::MovableObject::setVisibilityFlags ( uint32  flags)
inlineinherited

Sets the visibility flags for this object.

Remarks
As well as a simple true/false value for visibility (as seen in setVisible), you can also set visibility flags which when 'and'ed with the SceneManager's visibility mask can also make an object invisible.

◆ addVisibilityFlags()

void Ogre::MovableObject::addVisibilityFlags ( uint32  flags)
inlineinherited

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

◆ removeVisibilityFlags()

void Ogre::MovableObject::removeVisibilityFlags ( uint32  flags)
inlineinherited

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

◆ getVisibilityFlags()

uint32 Ogre::MovableObject::getVisibilityFlags ( void  ) const
inlineinherited

Returns the visibility flags relevant for this object.

◆ setDefaultVisibilityFlags()

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

Set the default visibility flags for all future MovableObject instances.

◆ getDefaultVisibilityFlags()

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

Get the default visibility flags for all future MovableObject instances.

◆ setListener()

void Ogre::MovableObject::setListener ( Listener listener)
inlineinherited

Sets a listener for this object.

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

◆ getListener()

Listener* Ogre::MovableObject::getListener ( void  ) const
inlineinherited

Gets the current listener for this object.

◆ queryLights()

const LightList& Ogre::MovableObject::queryLights ( void  ) const
inherited

Gets a list of lights, ordered relative to how close they are to this movable object.

Remarks
By default, this method gives the listener a chance to populate light list first, if there is no listener or Listener::objectQueryLights returns NULL, it'll query the light list from parent entity if it is present, or returns SceneNode::findLights if it has parent scene node, otherwise it just returns an empty list.
The object internally caches the light list, so it will recalculate it only when object is moved, or lights that affect the frustum have been changed (
See also
SceneManager::_getLightsDirtyCounter), but if listener exists, it will be called each time, so the listener should implement their own cache mechanism to optimise performance.
This method can be useful when implementing Renderable::getLights in case the renderable is a part of the movable.
Returns
The list of lights use to lighting this object.

◆ getLightMask()

uint32 Ogre::MovableObject::getLightMask ( ) const
inlineinherited

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

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

◆ setLightMask()

void Ogre::MovableObject::setLightMask ( uint32  lightMask)
inherited

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

Remarks
This mask will be compared against the mask held against Light to determine if a light should affect a given object. By default, this mask is fully set meaning all lights will affect this object

◆ _getLightList()

LightList* Ogre::MovableObject::_getLightList ( )
inlineinherited

Returns a pointer to the current list of lights for this object.

Remarks
You should not modify this list outside of MovableObject::Listener::objectQueryLights (say if you want to use it to implement this method, and use the pointer as a return value) and for reading it's only accurate as at the last frame.

◆ getEdgeList()

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

Returns details of the edges which might be used to determine a silhouette.

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::StaticGeometry::Region.

◆ hasEdgeList()

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

Returns whether the object has a valid edge list.

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::StaticGeometry::Region.

◆ getShadowVolumeRenderableIterator()

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

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::StaticGeometry::Region.

◆ getLightCapBounds()

const AxisAlignedBox& Ogre::MovableObject::getLightCapBounds ( void  ) const
virtualinherited

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

◆ getDarkCapBounds()

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

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

◆ setCastShadows()

void Ogre::MovableObject::setCastShadows ( bool  enabled)
inlineinherited

Sets whether or not this object will cast shadows.

Remarks
This setting simply allows you to turn on/off shadows for a given object. An object will not cast shadows unless the scene supports it in any case (see SceneManager::setShadowTechnique), and also the material which is in use must also have shadow casting enabled. By default all entities cast shadows. If, however, for some reason you wish to disable this for a single object then you can do so using this method.
Note
This method normally refers to objects which block the light, but since Light is also a subclass of MovableObject, in that context it means whether the light causes shadows itself.

◆ getCastShadows()

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

Returns whether shadow casting is enabled for this object.

Implements Ogre::ShadowCaster.

◆ getReceivesShadows()

bool Ogre::MovableObject::getReceivesShadows ( )
inherited

Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows.

◆ getPointExtrusionDistance()

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

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

Implements Ogre::ShadowCaster.

◆ setDebugDisplayEnabled()

void Ogre::MovableObject::setDebugDisplayEnabled ( bool  enabled)
inlineinherited

Sets whether or not the debug display of this object is enabled.

Remarks
Some objects aren't visible themselves but it can be useful to display a debug representation of them. Or, objects may have an additional debug display on top of their regular display. This option enables / disables that debug display. Objects that are not visible never display debug geometry regardless of this setting.

◆ isDebugDisplayEnabled()

bool Ogre::MovableObject::isDebugDisplayEnabled ( void  ) const
inlineinherited

Gets whether debug display of this object is enabled.

◆ clearShadowRenderableList()

static void Ogre::ShadowCaster::clearShadowRenderableList ( ShadowRenderableList shadowRenderables)
staticinherited

Common implementation of releasing shadow renderables.

◆ extrudeVertices()

static void Ogre::ShadowCaster::extrudeVertices ( const HardwareVertexBufferSharedPtr vertexBuffer,
size_t  originalVertexCount,
const Vector4 lightPos,
Real  extrudeDist 
)
staticinherited

Utility method for extruding vertices based on a light.

Remarks
Unfortunately, because D3D cannot handle homogeneous (4D) position coordinates in the fixed-function pipeline (GL can, but we have to be cross-API), when we extrude in software we cannot extrude to infinity the way we do in the vertex program (by setting w to 0.0f). Therefore we extrude by a fixed distance, which may cause some problems with larger scenes. Luckily better hardware (ie vertex programs) can fix this.
Parameters
vertexBufferThe vertex buffer containing ONLY xyz position values, which must be originalVertexCount * 2 * 3 floats long.
originalVertexCountThe count of the original number of vertices, i.e. the number in the mesh, not counting the doubling which has already been done (by VertexData::prepareForShadowVolume) to provide the extruded area of the buffer.
lightPos4D light position in object space, when w=0.0f this represents a directional light.
extrudeDistThe distance to extrude.

◆ getAnimableValueNames()

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

Gets a list of animable value names for this object.

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

◆ createAnimableValue()

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

Create a reference-counted AnimableValuePtr for the named value.

Remarks
You can use the returned object to animate a value on this object, using AnimationTrack. Subclasses must override this if they wish to support animation of their values.

Reimplemented in Ogre::Light.

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

◆ getTechnique()

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

Retrieves a pointer to the Material Technique this renderable object uses.

Remarks
This is to allow Renderables to use a chosen Technique if they wish, otherwise they will use the best Technique available for the Material they are using.

Reimplemented in Ogre::InstanceBatch, Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity.

◆ preRender()

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

Called just prior to the Renderable being rendered.

Remarks
OGRE is a queued renderer, so the actual render commands are executed at a later time than the point at which an object is discovered to be visible. This allows ordering & grouping of renders without the discovery process having to be aware of it. It also means OGRE uses declarative render information rather than immediate mode rendering - this is very useful in that certain effects and processes can automatically be applied to a wide range of scenes, but the downside is that special cases are more difficult to handle, because there is not the declared state to cope with it.
This method allows a Renderable to do something special at the actual point of rendering if it wishes to. When this method is called, all the material render state as declared by this Renderable has already been set, all that is left to do is to bind the buffers and perform the render. The Renderable may modify render state itself if it wants to (and restore it in the postRender call) before the automated render happens, or by returning 'false' from this method can actually suppress the automatic render and perform one of its own.
Returns
true if the automatic render should proceed, false to skip it on the assumption that the Renderable has done it manually.

Reimplemented in Ogre::BillboardChain.

◆ postRender()

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

Called immediately after the Renderable has been rendered.

◆ getNumWorldTransforms()

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

Returns the number of world transform matrices this renderable requires.

Remarks
When a renderable uses vertex blending, it uses multiple world matrices instead of a single one. Each vertex sent to the pipeline can reference one or more matrices in this list with given weights. If a renderable does not use vertex blending this method returns 1, which is the default for simplicity.

Reimplemented in Ogre::BorderRenderable, Ogre::SubEntity, Ogre::BaseInstanceBatchVTF, Ogre::InstanceBatchHW, and Ogre::InstanceBatchShader.

◆ setUseIdentityProjection()

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

Sets whether or not to use an 'identity' projection.

Remarks
Usually Renderable objects will use a projection matrix as determined by the active camera. However, if they want they can cancel this out and use an identity projection, which effectively projects in 2D using a {-1, 1} view space. Useful for overlay rendering. Normal renderables need not change this. The default is false.
See also
Renderable::getUseIdentityProjection

◆ getUseIdentityProjection()

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

Returns whether or not to use an 'identity' projection.

Remarks
Usually Renderable objects will use a projection matrix as determined by the active camera. However, if they want they can cancel this out and use an identity projection, which effectively projects in 2D using a {-1, 1} view space. Useful for overlay rendering. Normal renderables need not change this.
See also
Renderable::setUseIdentityProjection

◆ setUseIdentityView()

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

Sets whether or not to use an 'identity' view.

Remarks
Usually Renderable objects will use a view matrix as determined by the active camera. However, if they want they can cancel this out and use an identity matrix, which means all geometry is assumed to be relative to camera space already. Useful for overlay rendering. Normal renderables need not change this. The default is false.
See also
Renderable::getUseIdentityView

◆ getUseIdentityView()

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

Returns whether or not to use an 'identity' view.

Remarks
Usually Renderable objects will use a view matrix as determined by the active camera. However, if they want they can cancel this out and use an identity matrix, which means all geometry is assumed to be relative to camera space already. Useful for overlay rendering. Normal renderables need not change this.
See also
Renderable::setUseIdentityView

◆ getCastsShadows()

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

Method which reports whether this renderable would normally cast a shadow.

Remarks
Subclasses should override this if they could have been used to generate a shadow.

Reimplemented in Ogre::SubEntity, and Ogre::StaticGeometry::GeometryBucket.

◆ setCustomParameter()

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

Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters.

Remarks
Calling this method simply associates a numeric index with a 4-dimensional value for this specific Renderable. This is most useful if the material which this Renderable uses a vertex or fragment program, and has an ACT_CUSTOM parameter entry. This parameter entry can refer to the index you specify as part of this call, thereby mapping a custom parameter for this renderable to a program parameter.
Parameters
indexThe index with which to associate the value. Note that this does not have to start at 0, and can include gaps. It also has no direct correlation with a GPU program parameter index - the mapping between the two is performed by the ACT_CUSTOM entry, if that is used.
valueThe value to associate.

◆ removeCustomParameter()

void Ogre::Renderable::removeCustomParameter ( size_t  index)
inlineinherited

Removes a custom value which is associated with this Renderable at the given index.

Parameters
indexIndex of the parameter to remove.
See also
setCustomParameter for full details.

◆ hasCustomParameter()

bool Ogre::Renderable::hasCustomParameter ( size_t  index) const
inlineinherited

Checks whether a custom value is associated with this Renderable at the given index.

Parameters
indexIndex of the parameter to check for existence.
See also
setCustomParameter for full details.

◆ getCustomParameter()

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

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

Parameters
indexIndex of the parameter to retrieve.
See also
setCustomParameter for full details.

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

◆ _updateCustomGpuParameter()

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

Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.

Remarks
This method allows a Renderable to map in a custom GPU program parameter based on it's own data. This is represented by a GPU auto parameter of ACT_CUSTOM, and to allow there to be more than one of these per Renderable, the 'data' field on the auto parameter will identify which parameter is being updated. The implementation of this method must identify the parameter being updated, and call a 'setConstant' method on the passed in GpuProgramParameters object, using the details provided in the incoming auto constant setting to identify the index at which to set the parameter.
You do not need to override this method if you're using the standard sets of data associated with the Renderable as provided by setCustomParameter and getCustomParameter. By default, the implementation will map from the value indexed by the 'constantEntry.data' parameter to a value previously set by setCustomParameter. But custom Renderables are free to override this if they want, in any case.
Parameters
constantEntryThe auto constant entry referring to the parameter being updated
paramsThe parameters object which this method should call to set the updated parameters.

Reimplemented in Ogre::SubEntity.

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

◆ setPolygonModeOverrideable()

void Ogre::Renderable::setPolygonModeOverrideable ( bool  override)
inlineinherited

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

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

◆ getPolygonModeOverrideable()

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

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

Referenced by Ogre::BorderRenderable::getPolygonModeOverrideable().

◆ getRenderSystemData()

const RenderSystemDataPtr& Ogre::Renderable::getRenderSystemData ( ) const
inlineinherited

Gets RenderSystem private data.

Remarks
This should only be used by a RenderSystem

◆ setRenderSystemData()

void Ogre::Renderable::setRenderSystemData ( RenderSystemDataPtr  val) const
inlineinherited

Sets RenderSystem private data.

Remarks
This should only be used by a RenderSystem

Member Data Documentation

◆ INFINITE_FAR_PLANE_ADJUST

const Real Ogre::Frustum::INFINITE_FAR_PLANE_ADJUST
staticinherited

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


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