Ogre::Camera Class Reference
Core » Scene

A viewpoint from which the scene will be rendered. More...

`#include <OgreCamera.h>`

Inheritance diagram for Ogre::Camera:
[legend]

## Classes

class | Listener
| Listener interface so you can be notified of Camera events. More...

## Public Types

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

## Public Member Functions

| Camera (const String &name, SceneManager *sm)
| Standard constructor. More...
virtual | ~Camera ()
| Standard destructor. More...
void | _autoTrack (void)
| Internal method used by OGRE to update auto-tracking cameras. More...
virtual MovableObjectFactory * | _getCreator (void) const
| Get the creator of this object, if any (internal use only) More...
virtual LightList * | _getLightList ()
| Returns a pointer to the current list of lights for this object. More...
Real | _getLodBiasInverse (void) const
| Internal method for OGRE to use for LOD calculations. More...
virtual 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 Matrix4 & | _getParentNodeFullTransform (void) const
| return the full transformation of the parent sceneNode or the attachingPoint node More...
virtual void | _notifyAttached (Node *parent, bool isTagPoint=false)
| Internal method called to notify the object that it has been attached to a node. More...
virtual void | _notifyCreator (MovableObjectFactory *fact)
| Notify the object of it's creator (internal use only) More...
void | _notifyCurrentCamera (Camera *cam)
| Overridden from MovableObject. More...
virtual void | _notifyManager (SceneManager *man)
| Notify the object of it's manager (internal use only) More...
virtual void | _notifyMoved (void)
| Internal method called to notify the object that it has been moved. More...
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...
void | _renderScene (Viewport *vp, bool includeOverlays)
| Tells the Camera to contact the SceneManager to render from it's viewpoint. 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...
virtual void | addQueryFlags (uint32 flags)
| As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
virtual void | addVisibilityFlags (uint32 flags)
| As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. More...
virtual void | calcViewMatrixRelative (const Vector3 &relPos, Matrix4 &matToUpdate) const
| Calculate a view matrix for this frustum, relative to a potentially dynamic point. More...
virtual AnimableValuePtr | createAnimableValue (const String &valueName)
| Create a reference-counted AnimableValuePtr for the named value. More...
virtual void | detachFromParent (void)
| Detaches an object from a parent SceneNode or TagPoint, if attached. More...
virtual void | disableCustomNearClipPlane (void)
| Disables any custom near clip plane. More...
virtual void | disableReflection (void)
| Disables reflection modification previously turned on with enableReflection. More...
virtual void | enableCustomNearClipPlane (const MovablePlane *plane)
| Links the frustum to a custom near clip plane, which can be used to clip geometry in a custom manner without using user clip planes. More...
virtual void | enableCustomNearClipPlane (const Plane &plane)
| Links the frustum to a custom near clip plane, which can be used to clip geometry in a custom manner without using user clip planes. More...
virtual void | enableReflection (const Plane &p)
| Modifies this frustum so it always renders from the reflection of itself through the plane specified. More...
virtual void | enableReflection (const MovablePlane *p)
| Modifies this frustum so it always renders from the reflection of itself through the plane specified. More...
virtual void | forwardIntersect (const Plane &worldPlane, vector< Vector4 >::type *intersect3d) const
| Forward projects frustum rays to find forward intersection with plane. More...
const StringVector & | getAnimableValueNames (void) const
| Gets a list of animable value names for this object. More...
virtual Real | getAspectRatio (void) const
| Retrieves the current aspect ratio. More...
bool | getAutoAspectRatio (void) const
| Retrieves if AutoAspectRatio is currently set or not. More...
const Vector3 & | getAutoTrackOffset (void) const
| Get the auto tracking offset for this camera, if it is auto tracking. More...
SceneNode * | getAutoTrackTarget (void) const
| Get the auto tracking target for this camera, if any. More...
const AxisAlignedBox & | getBoundingBox (void) const
| Overridden from MovableObject. 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)
| Gets a world-space list of planes enclosing a volume based on a viewport rectangle. More...
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...
Frustum * | getCullingFrustum (void) const
| Returns the custom culling frustum in use. More...
const Vector4 & | getCustomParameter (size_t index) const
| Gets the custom value associated with this Renderable at the given index. More...
const AxisAlignedBox & | getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const
| Overridden member from ShadowCaster. More...
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 Quaternion & | getDerivedOrientation (void) const
| Gets the derived orientation of the camera, including any rotation inherited from a node attachment and reflection matrix. More...
const Vector3 & | getDerivedPosition (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...
EdgeData * | getEdgeList (void)
| Define a default implementation of method from ShadowCaster which implements no shadows. More...
Real | getFarClipDistance (void) const
| Retrieves the distance from the frustum to the far clipping plane. More...
virtual Real | getFocalLength () const
| Returns focal length of frustum. More...
virtual const Radian & | getFOVy (void) const
| Retrieves the frustums Y-dimension Field Of View (FOV). More...
virtual void | getFrustumExtents (Real &outleft, Real &outright, Real &outtop, Real &outbottom) const
| Get the extents of the frustum in view space. More...
virtual const Vector2 & | getFrustumOffset () const
| Retrieves the frustum offsets. More...
const Plane & | getFrustumPlane (unsigned short plane) const
| Retrieves a specified plane of the frustum (world space). More...
virtual const Plane * | getFrustumPlanes (void) const
| Retrieves the clipping planes of the frustum (world space). More...
const AxisAlignedBox & | getLightCapBounds (void) const
| Overridden member from ShadowCaster. More...
virtual uint32 | getLightMask () const
| Get a bitwise mask which will filter the lights affecting this object. More...
const LightList & | getLights (void) const
| Overridden from Renderable. More...
virtual Listener * | getListener (void) const
| Gets the current listener for this object. More...
Real | getLodBias (void) const
| Returns the level-of-detail bias factor currently applied to this camera. More...
virtual const Camera * | getLodCamera () const
| Get a pointer to the camera which should be used to determine LOD settings. More...
const MaterialPtr & | getMaterial (void) const
| Overridden from Renderable. More...
const String & | getMovableType (void) const
| Overridden from MovableObject. More...
virtual const String & | getName (void) const
| Returns the name of this object. More...
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 Quaternion & | getOrientation (void) const
| Returns the camera's current orientation. More...
const Quaternion & | getOrientationForViewUpdate (void) const
| Get the derived orientation of this frustum. More...
OrientationMode | getOrientationMode () const
| Get the orientation mode of the frustum. More...
virtual Real | getOrthoWindowHeight () const
| Gets the orthographic window height, for use with orthographic rendering only. More...
virtual Real | getOrthoWindowWidth () const
| Gets the orthographic window width, for use with orthographic rendering only. More...
virtual Node * | getParentNode (void) const
| Returns the node to which this object is attached. More...
virtual SceneNode * | getParentSceneNode (void) const
| Returns the scene node to which this object is attached. More...
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...
virtual bool | getPolygonModeOverrideable (void) const
| Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More...
const Vector3 & | getPosition (void) const
| Retrieves the camera's position. More...
const Vector3 & | getPositionForViewUpdate (void) const
| Get the derived position of this frustum. More...
virtual const Matrix4 & | getProjectionMatrix (void) const
| Gets the normal projection matrix for this frustum, ie the projection matrix which conforms to standard right-handed rules and uses depth range [-1,+1]. More...
virtual const Matrix4 & | getProjectionMatrixRS (void) const
| Gets the projection matrix for this frustum adjusted for the current rendersystem specifics (may be right or left-handed, depth range may vary). More...
virtual const Matrix4 & | getProjectionMatrixWithRSDepth (void) const
| Gets the depth-adjusted projection matrix for the current rendersystem, but one which still conforms to right-hand rules. More...
virtual ProjectionType | getProjectionType (void) const
| Retrieves info on the type of projection used (orthographic or perspective). More...
virtual uint32 | getQueryFlags (void) const
| Returns the query flags relevant for this object. More...
Vector3 | getRealDirection (void) const
| Gets the real world direction vector of the camera, including any rotation inherited from a node attachment. More...
const Quaternion & | getRealOrientation (void) const
| Gets the real world orientation of the camera, including any rotation inherited from a node attachment. More...
const Vector3 & | getRealPosition (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...
virtual const Matrix4 & | getReflectionMatrix (void) const
| Returns the reflection matrix of the frustum if appropriate. More...
virtual const Plane & | getReflectionPlane (void) const
| Returns the reflection plane of the frustum if appropriate. More...
virtual Real | getRenderingDistance (void) const
| Gets the distance at which batches are no longer rendered. More...
virtual Real | getRenderingMinPixelSize () const
| Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...
void | getRenderOperation (RenderOperation &op)
| Overridden from Renderable. More...
virtual uint8 | getRenderQueueGroup (void) const
| Gets the queue group for this entity, see setRenderQueueGroup for full details. More...
virtual RenderSystemData * | getRenderSystemData () const
| Gets RenderSystem private data. More...
Vector3 | getRight (void) const
| Gets the camera's right vector. More...
SceneManager * | getSceneManager (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 Technique * | getTechnique (void) const
| Retrieves a pointer to the Material Technique this renderable object uses. More...
uint32 | getTypeFlags (void) const
| Overridden from MovableObject::getTypeFlags. More...
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...
virtual OGRE_DEPRECATED const Any & | getUserAny (void) const
virtual OGRE_DEPRECATED const Any & | getUserAny (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...
UserObjectBindings & | getUserObjectBindings ()
| Return an instance of user objects binding associated with this class. More...
const UserObjectBindings & | getUserObjectBindings () const
| Return an instance of user objects binding associated with this class. More...
UserObjectBindings & | getUserObjectBindings ()
| Return an instance of user objects binding associated with this class. More...
const UserObjectBindings & | getUserObjectBindings () const
| Return an instance of user objects binding associated with this class. More...
const Matrix4 & | getViewMatrix (void) const
| Gets the view matrix for this frustum. More...
const Matrix4 & | getViewMatrix (bool ownFrustumOnly) const
| Specialised version of getViewMatrix allowing caller to differentiate whether the custom culling frustum should be allowed or not. More...
Viewport * | getViewport (void) const
| Get the last viewport which was attached to this camera. More...
virtual uint32 | getVisibilityFlags (void) const
| Returns the visibility flags relevant for this object. More...
virtual bool | getVisible (void) const
| Gets this object whether to be visible or not, if it has a renderable component. More...
const vector< Plane >::type & | getWindowPlanes (void) const
| Gets the window clip planes, only applicable if isWindowSet == true. More...
virtual const AxisAlignedBox & | getWorldBoundingBox (bool derive=false) const
| Retrieves the axis-aligned bounding box for this object in world coordinates. More...
virtual const Sphere & | getWorldBoundingSphere (bool derive=false) const
| Retrieves the worldspace bounding sphere for this object. More...
const Vector3 * | getWorldSpaceCorners (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)
| Define a default implementation of method from ShadowCaster which implements no shadows. More...
virtual bool | isAttached (void) const
| Returns true if this object is attached to a SceneNode or TagPoint. More...
virtual bool | isCustomNearClipPlaneEnabled (void) const
| Is a custom near clip plane in use? More...
virtual bool | isCustomProjectionMatrixEnabled (void) const
| Returns whether a custom projection matrix is in use. More...
virtual bool | isCustomViewMatrixEnabled (void) const
| Returns whether a custom view matrix is in use. More...
virtual bool | isDebugDisplayEnabled (void) const
| Gets whether debug display of this object is enabled. More...
virtual bool | isInScene (void) const
| Returns true if this object is attached to a SceneNode or TagPoint, and this SceneNode / TagPoint is currently in an active part of the scene graph. More...
virtual bool | isParentTagPoint () const
| Gets whether the parent node is a TagPoint (or a SceneNode) More...
virtual bool | isReflected (void) const
| Returns whether this frustum is being reflected. More...
virtual bool | isVisible (void) const
| Returns whether or not this object is supposed to be visible or not. More...
bool | isVisible (const AxisAlignedBox &bound, FrustumPlane *culledBy=0) const
| Tests whether the given container is visible in the Frustum. 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)
| Points the camera at a location in worldspace. 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 | operator delete (void *ptr)
void | operator delete (void *ptr, void *)
void | operator delete (void *ptr, const char *, int, const char *)
void | operator delete[] (void *ptr)
void | operator delete[] (void *ptr, const char *, int, const char *)
void * | operator new (size_t sz, const char *file, int line, const char *func)
| operator new, with debug line info More...
void * | operator new (size_t sz)
void * | operator new (size_t sz, void *ptr)
| placement operator new More...
void * | operator new[] (size_t sz, const char *file, int line, const char *func)
| array operator new, with debug line info More...
void * | operator new[] (size_t sz)
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...
virtual const LightList & | queryLights (void) const
| Gets a list of lights, ordered relative to how close they are to this movable object. More...
void | removeCustomParameter (size_t index)
| Removes a custom value which is associated with this Renderable at the given index. More...
virtual void | removeListener (Listener *l)
| Remove a listener to this camera. More...
virtual void | removeQueryFlags (uint32 flags)
| As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
virtual void | removeVisibilityFlags (uint32 flags)
| As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object. More...
virtual void | resetFrustumExtents ()
| Reset the frustum extents to be automatically derived from other params. More...
virtual void | 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)
| Rotate the camera around an arbitrary axis using a Quaternion. More...
virtual 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...
virtual void | setCustomProjectionMatrix (bool enable, const Matrix4 &projectionMatrix=Matrix4::IDENTITY)
| Set whether to use a custom projection matrix on this frustum. More...
virtual void | setCustomViewMatrix (bool enable, const Matrix4 &viewMatrix=Matrix4::IDENTITY)
| Set whether to use a custom view matrix on this frustum. More...
virtual void | setDebugDisplayEnabled (bool enabled)
| Sets whether or not the debug display of this object is enabled. More...
void | setDirection (Real x, Real y, Real z)
| Sets the camera's direction vector. More...
void | setDirection (const Vector3 &vec)
| Sets the camera's direction vector. More...
virtual 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...
virtual void | setFocalLength (Real focalLength=1.0)
| Sets frustum focal length (used in stereo rendering). More...
virtual void | setFOVy (const Radian &fovy)
| Sets the Y-dimension Field Of View (FOV) of the frustum. More...
virtual void | setFrustumExtents (Real left, Real right, Real top, Real bottom)
| Manually set the extents of the frustum. More...
virtual void | setFrustumOffset (const Vector2 &offset)
| Sets frustum offsets, used in stereo rendering. More...
virtual void | setFrustumOffset (Real horizontal=0.0, Real vertical=0.0)
| Sets frustum offsets, used in stereo rendering. More...
virtual void | setLightMask (uint32 lightMask)
| Set a bitwise mask which will filter the lights affecting this object. More...
virtual void | setListener (Listener *listener)
| Sets a listener for this object. More...
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...
virtual 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...
virtual void | setOrthoWindow (Real w, Real h)
| Sets the orthographic window settings, for use with orthographic rendering only. More...
virtual void | setOrthoWindowHeight (Real h)
| Sets the orthographic window height, for use with orthographic rendering only. More...
virtual void | setOrthoWindowWidth (Real w)
| Sets the orthographic window width, for use with orthographic rendering only. More...
void | setPolygonMode (PolygonMode sd)
| Sets the level of rendering detail required from this camera. More...
virtual 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)
| Sets the camera's position. More...
virtual void | setProjectionType (ProjectionType pt)
| Sets the type of projection to use (orthographic or perspective). More...
virtual void | setQueryFlags (uint32 flags)
| Sets the query flags for this object. More...
virtual void | setRenderingDistance (Real dist)
| Sets the distance at which the object is no longer rendered. More...
virtual void | setRenderingMinPixelSize (Real pixelSize)
| Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...
virtual void | setRenderQueueGroup (uint8 queueID)
| Sets the render queue group this entity will be rendered through. More...
virtual void | setRenderQueueGroupAndPriority (uint8 queueID, ushort priority)
| Sets the render queue group and group priority this entity will be rendered through. More...
virtual void | setRenderSystemData (RenderSystemData *val) const
| Sets RenderSystem private data. More...
void | setUseIdentityProjection (bool useIdentityProjection)
| Sets whether or not to use an 'identity' projection. More...
void | setUseIdentityView (bool useIdentityView)
| Sets whether or not to use an 'identity' view. More...
void | setUseMinPixelSize (bool enable)
| Sets whether to use min display size calculations. More...
virtual OGRE_DEPRECATED void | setUserAny (const Any &anything)
virtual OGRE_DEPRECATED 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...
virtual void | setVisibilityFlags (uint32 flags)
| Sets the visibility flags for this object. More...
virtual void | setVisible (bool visible)
| Tells this object whether to be visible or not, if it has a renderable component. More...
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 | 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 | extrudeVertices (const HardwareVertexBufferSharedPtr &vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist)
| Utility method for extruding vertices based on a light. More...
static uint32 | getDefaultQueryFlags ()
| Get the default query flags for all future MovableObject instances. More...
static uint32 | getDefaultVisibilityFlags ()
| Get the default visibility flags for all future MovableObject instances. More...
static void | setDefaultQueryFlags (uint32 flags)
| Set the default query flags for all future MovableObject instances. More...
static void | setDefaultVisibilityFlags (uint32 flags)
| Set the default visibility flags for all future MovableObject instances. More...

## Static Public Attributes

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

## Protected Types

typedef map< String, StringVector >::type | AnimableDictionaryMap
typedef map< size_t, Vector4 >::type | CustomParameterMap
typedef vector< Listener * >::type | ListenerList

## Protected Member Functions

StringVector & | _getAnimableValueNames (void)
| Get an updateable reference to animable value list. More...
virtual void | calcProjectionParameters (Real &left, Real &right, Real &bottom, Real &top) const
void | createAnimableDictionary (void) const
| Internal method for creating a dictionary of animable value names for the class, if it does not already exist. More...
virtual void | extrudeBounds (AxisAlignedBox &box, const Vector4 &lightPos, Real extrudeDist) const
| Utility method for extruding a bounding box. More...
virtual void | generateShadowVolume (EdgeData *edgeData, const HardwareIndexBufferSharedPtr &indexBuffer, size_t &indexBufferUsedSize, const Light *light, ShadowRenderableList &shadowRenderables, unsigned long flags)
| Generates the indexes required to render a shadow volume into the index buffer which is passed in, and updates shadow renderables to use it. More...
virtual const String & | getAnimableDictionaryName (void) const
| Get the name of the animable dictionary for this class. More...
Real | getExtrusionDistance (const Vector3 &objectPos, const Light *light) const
| Helper method for calculating extrusion distance. More...
virtual vector< Vector4 >::type | getRayForwardIntersect (const Vector3 &anchor, const Vector3 *dir, Real planeOffset) const
| Helper function for forwardIntersect that intersects rays with canonical plane. More...
virtual void | initialiseAnimableDictionary (StringVector &) const
| Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters. More...
void | invalidateFrustum (void) const
| Signal to update frustum information. More...
void | invalidateView (void) const
| Signal to update view information. More...
virtual bool | isFrustumOutOfDate (void) const
bool | isViewOutOfDate (void) const
virtual void | setWindowImpl (void) const
| Do actual window setting, using parameters set in SetWindow call. More...
virtual void | updateEdgeListLightFacing (EdgeData *edgeData, const Vector4 &lightPos)
| Tells the caster to perform the tasks necessary to update the edge data's light listing. More...
virtual void | updateFrustum (void) const
| Update frustum if out of date. More...
virtual void | updateFrustumImpl (void) const
| Implementation of updateFrustum (called if out of date) More...
virtual void | updateFrustumPlanes (void) const
virtual void | updateFrustumPlanesImpl (void) const
| Implementation of updateFrustumPlanes (called if out of date) More...
virtual void | updateVertexData (void) const
virtual void | updateView (void) const
| Update view if out of date. More...
virtual void | updateViewImpl (void) const
| Implementation of updateView (called if out of date) More...
virtual void | updateWorldSpaceCorners (void) const
virtual void | updateWorldSpaceCornersImpl (void) const
| Implementation of updateWorldSpaceCorners (called if out of date) More...

## Protected Attributes

Real | mAspect
| x/y viewport ratio - default 1.3333 More...
bool | mAutoAspectRatio
| Whether aspect ratio will automatically be recalculated when a viewport changes its size. More...
Vector3 | mAutoTrackOffset
| Tracking offset for fine tuning. More...
SceneNode * | mAutoTrackTarget
| SceneNode which this Camera will automatically track. More...
bool | mBeyondFarDistance
| Hidden because of distance? More...
Real | mBottom
AxisAlignedBox | mBoundingBox
bool | mCastShadows
| Does this object cast shadows? More...
MovableObjectFactory * | mCreator
| Creator of this object (if created by a factory) More...
Frustum * | mCullFrustum
| Custom culling frustum. More...
CustomParameterMap | mCustomParameters
bool | mCustomProjMatrix
| Are we using a custom projection matrix? More...
bool | mCustomViewMatrix
| Are we using a custom view matrix? More...
bool | mDebugDisplay
| Is debug display enabled? More...
Quaternion | mDerivedOrientation
| Derived orientation/position of the camera, including reflection. More...
Vector3 | mDerivedPosition
Real | mFarDist
| Far clip distance - default 10000. More...
Real | mFocalLength
| Focal length of frustum (for stereo rendering, defaults to 1.0) More...
Radian | mFOVy
| y-direction field-of-view (default 45) More...
bool | mFrustumExtentsManuallySet
| Have the frustum extents been manually set? More...
Vector2 | mFrustumOffset
| Off-axis frustum center offset - default (0.0, 0.0) More...
Plane | mFrustumPlanes [6]
| The 6 main clipping planes. More...
Plane | mLastLinkedObliqueProjPlane
| Record of the last world-space oblique depth projection plane info used. More...
Plane | mLastLinkedReflectionPlane
| Record of the last world-space reflection plane info used. More...
Quaternion | mLastParentOrientation
| Stored versions of parent orientation / position. More...
Vector3 | mLastParentPosition
Viewport * | mLastViewport
| The last viewport to be added using this camera. More...
Real | mLeft
| Frustum extents. More...
LightList | mLightList
| List of lights for this object. More...
ulong | mLightListUpdated
| The last frame that this light list was updated in. More...
uint32 | mLightMask
| the light mask defined for this movable. This will be taken into consideration when deciding which light should affect this movable More...
const MovablePlane * | mLinkedObliqueProjPlane
| Pointer to oblique projection plane (automatically updated) More...
const MovablePlane * | mLinkedReflectPlane
| Pointer to a reflection plane (automatically updated) More...
Listener * | mListener
| MovableObject listener - only one allowed (no list) for size & performance reasons. */. More...
ListenerList | mListeners
const Camera * | mLodCamera
| Camera to use for LOD calculation. More...
SceneManager * | mManager
| SceneManager holding this object (if applicable) More...
MaterialPtr | mMaterial
Real | mMinPixelSize
String | mName
| Name of this object. More...
Real | mNearDist
| Near clip distance - default 100. More...
bool | mObliqueDepthProjection
| Is this frustum using an oblique depth projection? More...
Plane | mObliqueProjPlane
| Fixed oblique projection plane. More...
Quaternion | mOrientation
| Camera orientation, quaternion style. More...
OrientationMode | mOrientationMode
| Frustum orientation mode. More...
Real | mOrthoHeight
| Ortho height size (world units) More...
bool | mParentIsTagPoint
Node * | mParentNode
| node to which this object is attached More...
Real | mPixelDisplayRatio
bool | mPolygonModeOverrideable
Vector3 | mPosition
| Camera position - default (0,0,0) More...
Matrix4 | mProjMatrix
| Pre-calced standard projection matrix. More...
Matrix4 | mProjMatrixRS
| Pre-calced projection matrix for the specific render system. More...
Matrix4 | mProjMatrixRSDepth
| Pre-calced standard projection matrix but with render system depth range. More...
ProjectionType | mProjType
| Orthographic or perspective? More...
uint32 | mQueryFlags
| Flags determining whether this object is included / excluded from scene queries. More...
Quaternion | mRealOrientation
| Real world orientation/position of the camera. More...
Vector3 | mRealPosition
bool | mRecalcFrustum
| Something's changed in the frustum shape? More...
bool | mRecalcFrustumPlanes
| Something re the frustum planes has changed. More...
bool | mRecalcVertexData
| Something re the vertex data has changed. More...
bool | mRecalcView
| Something re the view pos has changed. More...
bool | mRecalcWindow
| Was viewing window changed. More...
bool | mRecalcWorldSpaceCorners
| Something re the world space corners has changed. More...
bool | mReflect
| Is this frustum to act as a reflection of itself? More...
Matrix4 | mReflectMatrix
| Derived reflection matrix. More...
Plane | mReflectPlane
| Fixed reflection plane. More...
bool | mRenderingDisabled
| Does rendering this object disabled by listener? More...
uint8 | mRenderQueueID
| The render queue to use when rendering this object. More...
bool | mRenderQueueIDSet
| Flags whether the RenderQueue's default should be used. More...
ushort | mRenderQueuePriority
| The render queue group to use when rendering this object. More...
bool | mRenderQueuePrioritySet
| Flags whether the RenderQueue's default should be used. More...
RenderSystemData * | mRenderSystemData
| User objects binding. More...
Real | mRight
PolygonMode | mSceneDetail
| Rendering type. More...
Real | mSceneLodFactor
| Scene LOD factor used to adjust overall LOD. More...
Real | mSceneLodFactorInv
| Inverted scene LOD factor, can be used by Renderables to adjust their LOD. More...
SceneManager * | mSceneMgr
| Scene manager responsible for the scene. More...
Real | mSquaredUpperDistance
Real | mTop
Real | mUpperDistance
| Upper distance to still render. More...
bool | mUseIdentityProjection
bool | mUseIdentityView
bool | mUseMinPixelSize
| Whether or not the minimum display size of objects should take effect for this camera. More...
bool | mUseRenderingDistance
| Whether or not the rendering distance of objects should take effect for this camera. More...
UserObjectBindings | mUserObjectBindings
| User objects binding. More...
UserObjectBindings | mUserObjectBindings
VertexData | mVertexData
Matrix4 | mViewMatrix
| Pre-calced view matrix. More...
unsigned int | mVisBatchesLastRender
| Stored number of visible batches in the last render. More...
unsigned int | mVisFacesLastRender
| Stored number of visible faces in the last render. More...
uint32 | mVisibilityFlags
| Flags determining whether this object is visible (compared to SceneManager mask) More...
bool | mVisible
| Is this object visible? More...
Real | mWBottom
vector< Plane >::type | mWindowClipPlanes
| Windowed viewport clip planes. More...
bool | mWindowSet
| Is viewing window used. More...
Real | mWLeft
| Viewing window. More...
AxisAlignedBox | mWorldAABB
| Cached world AABB of this object. More...
Sphere | mWorldBoundingSphere
AxisAlignedBox | mWorldDarkCapBounds
| World space AABB of this object's dark cap. More...
Vector3 | mWorldSpaceCorners [8]
Real | mWRight
Real | mWTop
bool | mYawFixed
| Whether to yaw around a fixed axis. More...
Vector3 | mYawFixedAxis
| Fixed axis to yaw around. More...

## Static Protected Attributes

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

## Friends

_OgreExport friend std::ostream & | operator<< (std::ostream &o, const Camera &c)
| Function for outputting to a stream. More...

## Detailed Description

A viewpoint from which the scene will be rendered.

Remarks
  OGRE renders scenes from a camera viewpoint into a buffer of some sort, normally a window or a texture (a subclass of RenderTarget). OGRE cameras support both perspective projection (the default, meaning objects get smaller the further away they are) and orthographic projection (blueprint-style, no decrease in size with distance). Each camera carries with it a style of rendering, e.g. full textured, flat shaded, wireframe), field of view, rendering distances etc, allowing you to use OGRE to create complex multi-window views if required. In addition, more than one camera can point at a single render target if required, each rendering to a subset of the target, allowing split screen and picture-in-picture views.

  Cameras maintain their own aspect ratios, field of view, and frustum, and project co-ordinates into a space measured from -1 to 1 in x and y, and 0 to 1 in z. At render time, the camera will be rendering to a Viewport which will translate these parametric co-ordinates into real screen co-ordinates. Obviously it is advisable that the viewport has the same aspect ratio as the camera to avoid distortion (unless you want it!).

  Note that a Camera can be attached to a SceneNode, using the method SceneNode::attachObject. If this is done the Camera will combine it's own position/orientation settings with it's parent SceneNode. This is useful for implementing more complex Camera / object relationships i.e. having a camera attached to a world object.

Definition at line 86 of file OgreCamera.h.

## Member Typedef Documentation

## AnimableDictionaryMap

typedef map<String, StringVector>::type Ogre::AnimableObject::AnimableDictionaryMap

protected inherited

Definition at line 241 of file OgreAnimable.h.

## CustomParameterMap

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

protected inherited

Definition at line 414 of file OgreRenderable.h.

## ListenerList

typedef vector<Listener*>::type Ogre::Camera::ListenerList

protected

Definition at line 185 of file OgreCamera.h.

## ShadowRenderableList

typedef vector<ShadowRenderable*>::type Ogre::ShadowCaster::ShadowRenderableList

inherited

Definition at line 136 of file OgreShadowCaster.h.

## ShadowRenderableListIterator

typedef VectorIterator<ShadowRenderableList> Ogre::ShadowCaster::ShadowRenderableListIterator

inherited

Definition at line 137 of file OgreShadowCaster.h.

## Constructor & Destructor Documentation

## Camera()

Ogre::Camera::Camera | ( | const String & | name,
|  | SceneManager * | sm
| ) |  |

Standard constructor.

## ~Camera()

virtual Ogre::Camera::~Camera | ( |  | ) |

virtual

Standard destructor.

## Member Function Documentation

## _autoTrack()

void Ogre::Camera::_autoTrack | ( | void |  | ) |

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

## _getAnimableValueNames()

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

protected inherited

Get an updateable reference to animable value list.

Definition at line 267 of file OgreAnimable.h.

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

## _getCreator()

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

virtual inherited

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

Definition at line 186 of file OgreMovableObject.h.

## _getLightList()

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

virtual inherited

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

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

Definition at line 491 of file OgreMovableObject.h.

## _getLodBiasInverse()

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

Internal method for OGRE to use for LOD calculations.

## _getManager()

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

virtual inherited

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

Definition at line 190 of file OgreMovableObject.h.

## _getNumRenderedBatches()

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

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

## _getNumRenderedFaces()

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

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

## _getParentNodeFullTransform()

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

virtual inherited

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

Reimplemented in Ogre::InstancedEntity.

## _notifyAttached()

virtual void Ogre::MovableObject::_notifyAttached | ( | Node * | parent,
|  | bool | isTagPoint = `false`
| ) |  |

virtual inherited

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

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

## _notifyCreator()

virtual void Ogre::MovableObject::_notifyCreator | ( | MovableObjectFactory * | fact | ) |

virtual inherited

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

Definition at line 184 of file OgreMovableObject.h.

## _notifyCurrentCamera()

void Ogre::Frustum::_notifyCurrentCamera | ( | Camera * | cam | ) |

virtual inherited

Overridden from MovableObject.

Reimplemented from Ogre::MovableObject.

## _notifyManager()

virtual void Ogre::MovableObject::_notifyManager | ( | SceneManager * | man | ) |

virtual inherited

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

Definition at line 188 of file OgreMovableObject.h.

## _notifyMoved()

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

virtual inherited

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

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

## _notifyRenderedBatches()

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

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

## _notifyRenderedFaces()

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

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

## _notifyViewport()

void Ogre::Camera::_notifyViewport | ( | Viewport * | viewport | ) |

Notifies this camera that a viewport is using it.

Definition at line 565 of file OgreCamera.h.

## _renderScene()

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

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

Parameters

  vp | The viewport to render to
  includeOverlays | Whether or not any overlay objects should be included

## _updateCustomGpuParameter()

virtual void Ogre::Renderable::_updateCustomGpuParameter | ( | const GpuProgramParameters::AutoConstantEntry & | constantEntry,
|  | GpuProgramParameters * | params
| ) |  | const

virtual inherited

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

  constantEntry | The auto constant entry referring to the parameter being updated
  params | The parameters object which this method should call to set the updated parameters.

Reimplemented in Ogre::SubEntity.

Definition at line 307 of file OgreRenderable.h.

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

## _updateRenderQueue()

void Ogre::Frustum::_updateRenderQueue | ( | RenderQueue * | queue | ) |

virtual inherited

Overridden from MovableObject.

Implements Ogre::MovableObject.

## addListener()

virtual void Ogre::Camera::addListener | ( | Listener * | l | ) |

virtual

Add a listener to this camera.

## addQueryFlags()

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

virtual inherited

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

Definition at line 396 of file OgreMovableObject.h.

## addVisibilityFlags()

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

virtual inherited

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

Definition at line 424 of file OgreMovableObject.h.

## calcProjectionParameters()

virtual void Ogre::Frustum::calcProjectionParameters | ( | Real & | left,
|  | Real & | right,
|  | Real & | bottom,
|  | Real & | top
| ) |  | const

protected virtual inherited

## calcViewMatrixRelative()

virtual void Ogre::Frustum::calcViewMatrixRelative | ( | const Vector3 & | relPos,
|  | Matrix4 & | matToUpdate
| ) |  | const

virtual 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)

## createAnimableDictionary()

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

protected inherited

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

Definition at line 254 of file OgreAnimable.h.

## createAnimableValue()

virtual AnimableValuePtr Ogre::AnimableObject::createAnimableValue | ( | const String & | valueName | ) |

virtual inherited

Create a reference-counted AnimableValuePtr for the named value.

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

Reimplemented in Ogre::Light.

Definition at line 320 of file OgreAnimable.h.

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

## detachFromParent()

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

virtual inherited

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

## disableCustomNearClipPlane()

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

virtual inherited

Disables any custom near clip plane.

## disableReflection()

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

virtual inherited

Disables reflection modification previously turned on with enableReflection.

## enableCustomNearClipPlane() [1/2]

virtual void Ogre::Frustum::enableCustomNearClipPlane | ( | const MovablePlane * | plane | ) |

virtual 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

  plane | The plane to link to to perform the clipping. This plane must continue to exist while the camera is linked to it; do not destroy it before the frustum.

## enableCustomNearClipPlane() [2/2]

virtual void Ogre::Frustum::enableCustomNearClipPlane | ( | const Plane & | plane | ) |

virtual 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

  plane | The plane to link to to perform the clipping. This plane must continue to exist while the camera is linked to it; do not destroy it before the frustum.

## enableReflection() [1/2]

virtual void Ogre::Frustum::enableReflection | ( | const Plane & | p | ) |

virtual 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]

virtual void Ogre::Frustum::enableReflection | ( | const MovablePlane * | p | ) |

virtual 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.

## extrudeBounds()

virtual void Ogre::ShadowCaster::extrudeBounds | ( | AxisAlignedBox & | box,
|  | const Vector4 & | lightPos,
|  | Real | extrudeDist
| ) |  | const

protected virtual inherited

Utility method for extruding a bounding box.

Parameters

  box | Original bounding box, will be updated in-place.
  lightPos | 4D light position in object space, when w=0.0f this represents a directional light.
  extrudeDist | The distance to extrude.

## extrudeVertices()

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

static inherited

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

  vertexBuffer | The vertex buffer containing ONLY xyz position values, which must be originalVertexCount * 2 * 3 floats long.
  originalVertexCount | The count of the original number of vertices, i.e. the number in the mesh, not counting the doubling which has already been done (by VertexData::prepareForShadowVolume) to provide the extruded area of the buffer.
  lightPos | 4D light position in object space, when w=0.0f this represents a directional light.
  extrudeDist | The distance to extrude.

## forwardIntersect()

virtual void Ogre::Camera::forwardIntersect | ( | const Plane & | worldPlane,
|  | vector< Vector4 >::type * | intersect3d
| ) |  | const

virtual

Forward projects frustum rays to find forward intersection with plane.

Remarks
  Forward projection may lead to intersections at infinity.

## generateShadowVolume()

virtual void Ogre::ShadowCaster::generateShadowVolume | ( | EdgeData * | edgeData,
|  | const HardwareIndexBufferSharedPtr & | indexBuffer,
|  | size_t & | indexBufferUsedSize,
|  | const Light * | light,
|  | ShadowRenderableList & | shadowRenderables,
|  | unsigned long | flags
| ) |  |

protected virtual inherited

Generates the indexes required to render a shadow volume into the index buffer which is passed in, and updates shadow renderables to use it.

Parameters

  edgeData | The edge information to use.
  indexBuffer | The buffer into which to write data into; current contents are assumed to be discardable.
  indexBufferUsedSize | If the rest of buffer is enough than it would be locked with HBL_NO_OVERWRITE semantic and indexBufferUsedSize would be increased, otherwise HBL_DISCARD would be used and indexBufferUsedSize would be reset.
  light | The light, mainly for type info as silhouette calculations should already have been done in updateEdgeListLightFacing
  shadowRenderables | A list of shadow renderables which has already been constructed but will need populating with details of the index ranges to be used.
  flags | Additional controller flags, see ShadowRenderableFlags.

## getAnimableDictionaryName()

virtual const String& Ogre::AnimableObject::getAnimableDictionaryName | ( | void |  | ) | const

protected virtual inherited

Get the name of the animable dictionary for this class.

Remarks
  Subclasses must override this if they want to support animation of their values.

Reimplemented in Ogre::Light.

Definition at line 249 of file OgreAnimable.h.

References Ogre::StringUtil::BLANK.

## getAnimableValueNames()

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

inherited

Gets a list of animable value names for this object.

Definition at line 295 of file OgreAnimable.h.

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

## getAspectRatio()

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

virtual inherited

Retrieves the current aspect ratio.

## getAutoAspectRatio()

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

Retrieves if AutoAspectRatio is currently set or not.

## getAutoTrackOffset()

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

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

Definition at line 556 of file OgreCamera.h.

## getAutoTrackTarget()

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

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

Definition at line 554 of file OgreCamera.h.

## getBoundingBox()

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

virtual inherited

Overridden from MovableObject.

Implements Ogre::MovableObject.

## getBoundingRadius()

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

virtual

Overridden from MovableObject.

Implements Ogre::MovableObject.

## getCameraToViewportBoxVolume() [1/2]

PlaneBoundedVolume Ogre::Camera::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.

Remarks
  Can be useful for populating a PlaneBoundedVolumeListSceneQuery, e.g. for a rubber-band selection.

Parameters

  screenLeft,screenTop,screenRight,screenBottom | The bounds of the on-screen rectangle, expressed in normalised screen coordinates [0,1]
  includeFarPlane | If 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`
| ) |  |

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,screenBottom | The bounds of the on-screen rectangle, expressed in normalised screen coordinates [0,1]
  outVolume | The plane list to populate with the result
  includeFarPlane | If true, the volume is truncated by the camera far plane, by default it is left open-ended

## getCameraToViewportRay() [1/2]

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

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

Parameters

  screenx,screeny | The 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

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

Parameters

  screenx,screeny | The x and y position at which the ray should intersect the viewport, in normalised screen coordinates [0,1]
  outRay | Ray instance to populate with result

## getCastShadows()

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

virtual inherited

Returns whether shadow casting is enabled for this object.

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::TerrainQuadTreeNode::Movable.

Definition at line 521 of file OgreMovableObject.h.

## getCastsShadows()

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

virtual inherited

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

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

Reimplemented in Ogre::TerrainQuadTreeNode::Rend, Ogre::SubEntity, Ogre::InstancedGeometry::GeometryBucket, and Ogre::StaticGeometry::GeometryBucket.

Definition at line 224 of file OgreRenderable.h.

## getCullingFrustum()

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

Returns the custom culling frustum in use.

Definition at line 593 of file OgreCamera.h.

## getCustomParameter()

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

inherited

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

Parameters

  index | Index of the parameter to retrieve.

See also
  setCustomParameter for full details.

Definition at line 268 of file OgreRenderable.h.

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

## getDarkCapBounds()

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

virtual inherited

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

## getDefaultQueryFlags()

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

static inherited

Get the default query flags for all future MovableObject instances.

Definition at line 411 of file OgreMovableObject.h.

## getDefaultVisibilityFlags()

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

static inherited

Get the default visibility flags for all future MovableObject instances.

Definition at line 439 of file OgreMovableObject.h.

## getDerivedDirection()

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

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

## getDerivedOrientation()

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

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

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

## getDerivedRight()

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

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

## getDerivedUp()

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

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

## getDirection()

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

Gets the camera's direction.

## getEdgeList()

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

virtual inherited

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::StaticGeometry::Region.

Definition at line 494 of file OgreMovableObject.h.

## getExtrusionDistance()

Real Ogre::ShadowCaster::getExtrusionDistance | ( | const Vector3 & | objectPos,
|  | const Light * | light
| ) |  | const

protected inherited

Helper method for calculating extrusion distance.

## getFarClipDistance()

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

virtual

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

Reimplemented from Ogre::Frustum.

## getFocalLength()

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

virtual inherited

Returns focal length of frustum.

## getFOVy()

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

virtual inherited

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

## getFrustumExtents()

virtual void Ogre::Frustum::getFrustumExtents | ( | Real & | outleft,
|  | Real & | outright,
|  | Real & | outtop,
|  | Real & | outbottom
| ) |  | const

virtual inherited

Get the extents of the frustum in view space.

## getFrustumOffset()

virtual const Vector2& Ogre::Frustum::getFrustumOffset | ( |  | ) | const

virtual inherited

Retrieves the frustum offsets.

## getFrustumPlane()

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

virtual

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

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

Reimplemented from Ogre::Frustum.

## getFrustumPlanes()

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

virtual inherited

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

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

## getLightCapBounds()

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

virtual inherited

Overridden member from ShadowCaster.

Implements Ogre::ShadowCaster.

## getLightMask()

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

virtual inherited

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

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

Definition at line 476 of file OgreMovableObject.h.

## getLights()

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

virtual inherited

Overridden from Renderable.

Implements Ogre::Renderable.

## getListener()

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

virtual inherited

Gets the current listener for this object.

Definition at line 450 of file OgreMovableObject.h.

## getLodBias()

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

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

Remarks
  See Camera::setLodBias for more details.

## getLodCamera()

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

virtual

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'.

## getMaterial()

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

virtual inherited

Overridden from Renderable.

Implements Ogre::Renderable.

## getMovableType()

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

virtual

Overridden from MovableObject.

Implements Ogre::MovableObject.

## getName()

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

virtual inherited

Returns the name of this object.

Definition at line 193 of file OgreMovableObject.h.

## getNearClipDistance()

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

virtual

Sets the position of the near clipping plane.

Reimplemented from Ogre::Frustum.

## getNumWorldTransforms()

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

virtual inherited

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::InstancedGeometry::GeometryBucket, Ogre::BaseInstanceBatchVTF, Ogre::InstanceBatchHW, and Ogre::InstanceBatchShader.

Definition at line 153 of file OgreRenderable.h.

## getOrientation()

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

Returns the camera's current orientation.

## getOrientationForViewUpdate()

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

virtual

Get the derived orientation of this frustum.

Reimplemented from Ogre::Frustum.

## 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.

## getOrthoWindowHeight()

virtual Real Ogre::Frustum::getOrthoWindowHeight | ( |  | ) | const

virtual inherited

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

## getOrthoWindowWidth()

virtual Real Ogre::Frustum::getOrthoWindowWidth | ( |  | ) | const

virtual inherited

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

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

## getParentNode()

virtual Node* Ogre::MovableObject::getParentNode | ( | void |  | ) | const

virtual inherited

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()

virtual SceneNode* Ogre::MovableObject::getParentSceneNode | ( | void |  | ) | const

virtual 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.

## getPixelDisplayRatio()

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

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.

Definition at line 673 of file OgreCamera.h.

## getPlaneBoundedVolume()

PlaneBoundedVolume Ogre::Frustum::getPlaneBoundedVolume | ( |  | ) |

inherited

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

## getPointExtrusionDistance()

Real Ogre::MovableObject::getPointExtrusionDistance | ( | const Light * | l | ) | const

virtual inherited

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

Implements Ogre::ShadowCaster.

## getPolygonMode()

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

Retrieves the level of detail that the camera will render.

## getPolygonModeOverrideable()

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

virtual inherited

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

Reimplemented in Ogre::BorderRenderable.

Definition at line 332 of file OgreRenderable.h.

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

## getPosition()

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

Retrieves the camera's position.

## getPositionForViewUpdate()

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

virtual

Get the derived position of this frustum.

Reimplemented from Ogre::Frustum.

## getProjectionMatrix()

virtual const Matrix4& Ogre::Frustum::getProjectionMatrix | ( | void |  | ) | const

virtual 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.

## getProjectionMatrixRS()

virtual const Matrix4& Ogre::Frustum::getProjectionMatrixRS | ( | void |  | ) | const

virtual 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()

virtual const Matrix4& Ogre::Frustum::getProjectionMatrixWithRSDepth | ( | void |  | ) | const

virtual 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.

## getProjectionType()

virtual ProjectionType Ogre::Frustum::getProjectionType | ( | void |  | ) | const

virtual inherited

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

## getQueryFlags()

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

virtual inherited

Returns the query flags relevant for this object.

Reimplemented in Ogre::TerrainQuadTreeNode::Movable.

Definition at line 403 of file OgreMovableObject.h.

## getRayForwardIntersect()

virtual vector<Vector4>::type Ogre::Camera::getRayForwardIntersect | ( | const Vector3 & | anchor,
|  | const Vector3 * | dir,
|  | Real | planeOffset
| ) |  | const

protected virtual

Helper function for forwardIntersect that intersects rays with canonical plane.

## getRealDirection()

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

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

## getRealOrientation()

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

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

## getRealPosition()

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

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

## getRealRight()

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

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

## getRealUp()

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

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

## 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.

## getReflectionMatrix()

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

virtual inherited

Returns the reflection matrix of the frustum if appropriate.

Definition at line 574 of file OgreFrustum.h.

## getReflectionPlane()

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

virtual inherited

Returns the reflection plane of the frustum if appropriate.

Definition at line 576 of file OgreFrustum.h.

## getRenderingDistance()

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

virtual inherited

Gets the distance at which batches are no longer rendered.

Definition at line 305 of file OgreMovableObject.h.

## getRenderingMinPixelSize()

virtual Real Ogre::MovableObject::getRenderingMinPixelSize | ( |  | ) | const

virtual inherited

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

Definition at line 318 of file OgreMovableObject.h.

## getRenderOperation()

void Ogre::Frustum::getRenderOperation | ( | RenderOperation & | op | ) |

virtual inherited

Overridden from Renderable.

Implements Ogre::Renderable.

## getRenderQueueGroup()

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

virtual inherited

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

## getRenderSystemData()

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

virtual inherited

Gets RenderSystem private data.

Remarks
  This should only be used by a RenderSystem

Definition at line 399 of file OgreRenderable.h.

## getRight()

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

Gets the camera's right vector.

## getSceneManager()

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

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

## getShadowVolumeRenderableIterator()

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

virtual inherited

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::StaticGeometry::Region.

## getSquaredViewDepth()

Real Ogre::Frustum::getSquaredViewDepth | ( | const Camera * | cam | ) | const

virtual inherited

Overridden from Renderable.

Implements Ogre::Renderable.

## getTechnique()

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

virtual inherited

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

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

Reimplemented in Ogre::TerrainQuadTreeNode::Rend, Ogre::InstanceBatch, Ogre::InstancedGeometry::GeometryBucket, Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity.

Definition at line 94 of file OgreRenderable.h.

## getTypeFlags()

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

virtual inherited

Overridden from MovableObject::getTypeFlags.

Reimplemented from Ogre::MovableObject.

## getUp()

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

Gets the camera's up vector.

## getUseIdentityProjection()

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

inherited

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

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

See also
  Renderable::setUseIdentityProjection

Definition at line 178 of file OgreRenderable.h.

## getUseIdentityView()

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

inherited

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

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

See also
  Renderable::setUseIdentityView

Definition at line 203 of file OgreRenderable.h.

## getUseMinPixelSize()

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

Returns whether to use min display size calculations.

See also
  Camera::setUseMinDisplaySize

Definition at line 661 of file OgreCamera.h.

## getUserAny() [1/2]

virtual OGRE_DEPRECATED const Any& Ogre::MovableObject::getUserAny | ( | void |  | ) | const

virtual inherited

Deprecated:
  use UserObjectBindings::getUserAny via getUserObjectBindings() instead.

Retrieves the custom user value associated with this object.

Definition at line 334 of file OgreMovableObject.h.

## getUserAny() [2/2]

virtual OGRE_DEPRECATED const Any& Ogre::Renderable::getUserAny | ( | void |  | ) | const

virtual inherited

Deprecated:
  use UserObjectBindings::getUserAny via getUserObjectBindings() instead.

Retrieves the custom user value associated with this object.

Definition at line 349 of file OgreRenderable.h.

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

## getUseRenderingDistance()

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

virtual

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

Definition at line 638 of file OgreCamera.h.

## getUserObjectBindings() [1/4]

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

inherited

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

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

See also
  UserObjectBindings::setUserAny.

Definition at line 340 of file OgreMovableObject.h.

## getUserObjectBindings() [2/4]

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

inherited

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

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

See also
  UserObjectBindings::setUserAny.

Definition at line 346 of file OgreMovableObject.h.

## getUserObjectBindings() [3/4]

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

inherited

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

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

See also
  UserObjectBindings::setUserAny.

Definition at line 355 of file OgreRenderable.h.

## getUserObjectBindings() [4/4]

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

inherited

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

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

See also
  UserObjectBindings::setUserAny.

Definition at line 361 of file OgreRenderable.h.

## getViewMatrix() [1/2]

const Matrix4& Ogre::Camera::getViewMatrix | ( | void |  | ) | const

virtual

Gets the view matrix for this frustum.

Mainly for use by OGRE internally.

Reimplemented from Ogre::Frustum.

## getViewMatrix() [2/2]

const Matrix4& Ogre::Camera::getViewMatrix | ( | bool | ownFrustumOnly | ) | const

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.

## getViewport()

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

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.

Definition at line 563 of file OgreCamera.h.

## getVisibilityFlags()

virtual uint32 Ogre::MovableObject::getVisibilityFlags | ( | void |  | ) | const

virtual inherited

Returns the visibility flags relevant for this object.

Reimplemented in Ogre::TerrainQuadTreeNode::Movable.

Definition at line 431 of file OgreMovableObject.h.

## getVisible()

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

virtual inherited

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

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

## getWindowPlanes()

const vector<Plane>::type& Ogre::Camera::getWindowPlanes | ( | void |  | ) | const

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

## getWorldBoundingBox()

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

virtual inherited

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::Entity.

## getWorldBoundingSphere()

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

virtual inherited

Retrieves the worldspace bounding sphere for this object.

Reimplemented in Ogre::Entity.

## getWorldSpaceCorners()

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

virtual

Gets the world space corners of the frustum.

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

Reimplemented from Ogre::Frustum.

## getWorldTransforms()

void Ogre::Camera::getWorldTransforms | ( | Matrix4 * | mat | ) | const

virtual

Overridden from Frustum/Renderable.

Implements Ogre::Renderable.

## hasCustomParameter()

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

inherited

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

Parameters

  index | Index of the parameter to check for existence.

See also
  setCustomParameter for full details.

Definition at line 259 of file OgreRenderable.h.

## hasEdgeList()

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

virtual inherited

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

Implements Ogre::ShadowCaster.

Reimplemented in Ogre::StaticGeometry::Region.

Definition at line 496 of file OgreMovableObject.h.

## initialiseAnimableDictionary()

virtual void Ogre::AnimableObject::initialiseAnimableDictionary | ( | StringVector & |  | ) | const

protected virtual inherited

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

Reimplemented in Ogre::Light.

Definition at line 287 of file OgreAnimable.h.

## invalidateFrustum()

void Ogre::Camera::invalidateFrustum | ( | void |  | ) | const

protected virtual

Signal to update frustum information.

Reimplemented from Ogre::Frustum.

## invalidateView()

void Ogre::Camera::invalidateView | ( | void |  | ) | const

protected virtual

Signal to update view information.

Reimplemented from Ogre::Frustum.

## isAttached()

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

virtual inherited

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

## isCustomNearClipPlaneEnabled()

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

virtual inherited

Is a custom near clip plane in use?

Definition at line 651 of file OgreFrustum.h.

## isCustomProjectionMatrixEnabled()

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

virtual inherited

Returns whether a custom projection matrix is in use.

Definition at line 418 of file OgreFrustum.h.

## isCustomViewMatrixEnabled()

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

virtual inherited

Returns whether a custom view matrix is in use.

Definition at line 391 of file OgreFrustum.h.

References Ogre::Matrix4::IDENTITY.

## isDebugDisplayEnabled()

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

virtual inherited

Gets whether debug display of this object is enabled.

Definition at line 565 of file OgreMovableObject.h.

## isFrustumOutOfDate()

virtual bool Ogre::Frustum::isFrustumOutOfDate | ( | void |  | ) | const

protected virtual inherited

## isInScene()

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

virtual inherited

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.

## isParentTagPoint()

virtual bool Ogre::MovableObject::isParentTagPoint | ( |  | ) | const

virtual inherited

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

Definition at line 216 of file OgreMovableObject.h.

## isReflected()

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

virtual inherited

Returns whether this frustum is being reflected.

Definition at line 572 of file OgreFrustum.h.

## isViewOutOfDate()

bool Ogre::Camera::isViewOutOfDate | ( | void |  | ) | const

protected virtual

Reimplemented from Ogre::Frustum.

## isVisible() [1/4]

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

virtual inherited

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

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

Reimplemented in Ogre::InstancedGeometry::BatchInstance, Ogre::StaticGeometry::Region, and Ogre::TerrainQuadTreeNode::Movable.

## isVisible() [2/4]

bool Ogre::Camera::isVisible | ( | const AxisAlignedBox & | bound,
|  | FrustumPlane * | culledBy = `0`
| ) |  | const

virtual

Tests whether the given container is visible in the Frustum.

Parameters

  bound | Bounding box to be checked (world space).
  culledBy | Optional pointer to an int which will be filled by the plane number which culled the box if the result was `false`;

Returns
  If the box was visible, `true` is returned.

  Otherwise, `false` is returned.

Reimplemented from Ogre::Frustum.

## isVisible() [3/4]

bool Ogre::Camera::isVisible | ( | const Sphere & | bound,
|  | FrustumPlane * | culledBy = `0`
| ) |  | const

virtual

Tests whether the given container is visible in the Frustum.

Parameters

  bound | Bounding sphere to be checked (world space).
  culledBy | Optional pointer to an int which will be filled by the plane number which culled the box if the result was `false`;

Returns
  If the sphere was visible, `true` is returned.

  Otherwise, `false` is returned.

Reimplemented from Ogre::Frustum.

## isVisible() [4/4]

bool Ogre::Camera::isVisible | ( | const Vector3 & | vert,
|  | FrustumPlane * | culledBy = `0`
| ) |  | const

virtual

Tests whether the given vertex is visible in the Frustum.

Parameters

  vert | Vertex to be checked (world space).
  culledBy | Optional pointer to an int which will be filled by the plane number which culled the box if the result was `false`;

Returns
  If the sphere was visible, `true` is returned.

  Otherwise, `false` is returned.

Reimplemented from Ogre::Frustum.

## isWindowSet()

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

virtual

Returns if a viewport window is being used.

Definition at line 547 of file OgreCamera.h.

## lookAt() [1/2]

void Ogre::Camera::lookAt | ( | const Vector3 & | targetPoint | ) |

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

  targetPoint | A vector specifying the look at point.

## lookAt() [2/2]

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

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

  x | The `x` co-ordinates of the point to look at.
  y | The `y` co-ordinates of the point to look at.
  z | The `z` co-ordinates of the point to look at.

## move()

void Ogre::Camera::move | ( | const Vector3 & | vec | ) |

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

## moveRelative()

void Ogre::Camera::moveRelative | ( | const Vector3 & | vec | ) |

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

## operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) |

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |
| ) |  |

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

template<class Alloc >

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

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) |

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

## operator new() [1/3]

template<class Alloc >

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

inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

## operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) |

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

template<class Alloc >

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

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

## operator new[]() [1/2]

template<class Alloc >

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

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

## operator new[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## pitch()

void Ogre::Camera::pitch | ( | const Radian & | angle | ) |

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

## postRender()

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

virtual inherited

Called immediately after the Renderable has been rendered.

Definition at line 128 of file OgreRenderable.h.

## preRender()

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

virtual inherited

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.

Definition at line 123 of file OgreRenderable.h.

## projectSphere()

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

virtual

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

Parameters

  sphere | The world-space sphere to project.
  left | Pointers to destination values, these will be completed with the normalised device coordinates (in the range {-1,1}).
  top | Pointers to destination values, these will be completed with the normalised device coordinates (in the range {-1,1}).
  right | Pointers to destination values, these will be completed with the normalised device coordinates (in the range {-1,1}).
  bottom | Pointers to destination values, these will be completed with the normalised device coordinates (in the range {-1,1}).

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.

## queryLights()

virtual const LightList& Ogre::MovableObject::queryLights | ( | void |  | ) | const

virtual 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.

## removeCustomParameter()

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

inherited

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

Parameters

  index | Index of the parameter to remove.

See also
  setCustomParameter for full details.

Definition at line 250 of file OgreRenderable.h.

## removeListener()

virtual void Ogre::Camera::removeListener | ( | Listener * | l | ) |

virtual

Remove a listener to this camera.

## removeQueryFlags()

virtual void Ogre::MovableObject::removeQueryFlags | ( | uint32 | flags | ) |

virtual inherited

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

Definition at line 400 of file OgreMovableObject.h.

## removeVisibilityFlags()

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

virtual inherited

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

Definition at line 428 of file OgreMovableObject.h.

## resetFrustumExtents()

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

virtual inherited

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

## resetWindow()

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

virtual

Cancel view window.

## roll()

void Ogre::Camera::roll | ( | const Radian & | angle | ) |

Rolls the camera anticlockwise, around its local z axis.

## rotate() [1/2]

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

Rotate the camera around an arbitrary axis.

## rotate() [2/2]

void Ogre::Camera::rotate | ( | const Quaternion & | q | ) |

Rotate the camera around an arbitrary axis using a Quaternion.

## setAspectRatio()

virtual void Ogre::Frustum::setAspectRatio | ( | Real | ratio | ) |

virtual 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.

## setAutoAspectRatio()

void Ogre::Camera::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.

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.

## setAutoTracking()

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

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

  enabled | If 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.
  target | Pointer 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.
  offset | If 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.

## setCastShadows()

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

inherited

Sets whether or not this object will cast shadows.

Remarks
  This setting simply allows you to turn on/off shadows for a given object. An object will not cast shadows unless the scene supports it in any case (see SceneManager::setShadowTechnique), and also the material which is in use must also have shadow casting enabled. By default all entities cast shadows. If, however, for some reason you wish to disable this for a single object then you can do so using this method.

Note
  This method normally refers to objects which block the light, but since Light is also a subclass of MovableObject, in that context it means whether the light causes shadows itself.

Definition at line 519 of file OgreMovableObject.h.

## setCullingFrustum()

void Ogre::Camera::setCullingFrustum | ( | Frustum * | frustum | ) |

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

  frustum | Pointer 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.

Definition at line 591 of file OgreCamera.h.

## setCustomParameter()

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

inherited

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

  index | The index with which to associate the value. Note that this does not have to start at 0, and can include gaps. It also has no direct correlation with a GPU program parameter index - the mapping between the two is performed by the ACT_CUSTOM entry, if that is used.
  value | The value to associate.

Definition at line 241 of file OgreRenderable.h.

## setCustomProjectionMatrix()

virtual void Ogre::Frustum::setCustomProjectionMatrix | ( | bool | enable,
|  | const Matrix4 & | projectionMatrix = `Matrix4::IDENTITY`
| ) |  |

virtual 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

  enable | If `true`, the custom projection matrix passed as the second parameter will be used in preference to an auto calculated one. If `false`, the frustum will revert to auto calculating the projection matrix.
  projectionMatrix | The custom view matrix to use.

See also
  Frustum::setCustomViewMatrix

## setCustomViewMatrix()

virtual void Ogre::Frustum::setCustomViewMatrix | ( | bool | enable,
|  | const Matrix4 & | viewMatrix = `Matrix4::IDENTITY`
| ) |  |

virtual 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

  enable | If `true`, the custom view matrix passed as the second parameter will be used in preference to an auto calculated one. If false, the frustum will revert to auto calculating the view matrix.
  viewMatrix | The custom view matrix to use, the matrix must be an affine matrix.

See also
  Frustum::setCustomProjectionMatrix, Matrix4::isAffine

## setDebugDisplayEnabled()

virtual void Ogre::MovableObject::setDebugDisplayEnabled | ( | bool | enabled | ) |

virtual inherited

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

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

Definition at line 563 of file OgreMovableObject.h.

## setDefaultQueryFlags()

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

static inherited

Set the default query flags for all future MovableObject instances.

Definition at line 407 of file OgreMovableObject.h.

## setDefaultVisibilityFlags()

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

static inherited

Set the default visibility flags for all future MovableObject instances.

Definition at line 435 of file OgreMovableObject.h.

## setDirection() [1/2]

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

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).

## setDirection() [2/2]

void Ogre::Camera::setDirection | ( | const Vector3 & | vec | ) |

Sets the camera's direction vector.

## setFarClipDistance()

virtual void Ogre::Frustum::setFarClipDistance | ( | Real | farDist | ) |

virtual 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

  farDist | The distance to the far clipping plane from the frustum in world coordinates.If you specify 0, this means an infinite view distance which is useful especially when projecting shadows; but be careful not to use a near distance too close.

## setFixedYawAxis()

void Ogre::Camera::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.

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

  useFixed | If `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.
  fixedAxis | The axis to use if the first parameter is true.

## setFocalLength()

virtual void Ogre::Frustum::setFocalLength | ( | Real | focalLength = `1.0` | ) |

virtual inherited

Sets frustum focal length (used in stereo rendering).

Parameters

  focalLength | The distance to the focal plane from the frustum in world coordinates.

## setFOVy()

virtual void Ogre::Frustum::setFOVy | ( | const Radian & | fovy | ) |

virtual 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.

## setFrustumExtents()

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

virtual inherited

Manually set the extents of the frustum.

Parameters

  left,right,top,bottom | The position where the side clip planes intersect the near clip plane, in eye space

## setFrustumOffset() [1/2]

virtual void Ogre::Frustum::setFrustumOffset | ( | const Vector2 & | offset | ) |

virtual 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

  offset | The horizontal and vertical plane offsets.

## setFrustumOffset() [2/2]

virtual void Ogre::Frustum::setFrustumOffset | ( | Real | horizontal = `0.0`,
|  | Real | vertical = `0.0`
| ) |  |

virtual 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

  horizontal | The horizontal plane offset.
  vertical | The vertical plane offset.

## setLightMask()

virtual void Ogre::MovableObject::setLightMask | ( | uint32 | lightMask | ) |

virtual 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

## setListener()

virtual void Ogre::MovableObject::setListener | ( | Listener * | listener | ) |

virtual inherited

Sets a listener for this object.

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

Definition at line 446 of file OgreMovableObject.h.

## setLodBias()

void Ogre::Camera::setLodBias | ( | Real | factor = `1.0` | ) |

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

  factor | The 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.

## setLodCamera()

virtual void Ogre::Camera::setLodCamera | ( | const Camera * | lodCam | ) |

virtual

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.

## setNearClipDistance()

virtual void Ogre::Frustum::setNearClipDistance | ( | Real | nearDist | ) |

virtual 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

  nearDist | The distance to the near clipping plane from the frustum in world coordinates.

## setOrientation()

void Ogre::Camera::setOrientation | ( | const Quaternion & | q | ) |

Sets the camera's orientation.

## 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.

## setOrthoWindow()

virtual void Ogre::Frustum::setOrthoWindow | ( | Real | w,
|  | Real | h
| ) |  |

virtual 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

  w | The width of the view window in world units.
  h | The height of the view window in world units.

## setOrthoWindowHeight()

virtual void Ogre::Frustum::setOrthoWindowHeight | ( | Real | h | ) |

virtual 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

  h | The height of the view window in world units.

## setOrthoWindowWidth()

virtual void Ogre::Frustum::setOrthoWindowWidth | ( | Real | w | ) |

virtual 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

  w | The width of the view window in world units.

## setPolygonMode()

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

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.

## setPolygonModeOverrideable()

virtual void Ogre::Renderable::setPolygonModeOverrideable | ( | bool | override | ) |

virtual inherited

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

Parameters

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

Definition at line 324 of file OgreRenderable.h.

## setPosition() [1/2]

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

Sets the camera's position.

## setPosition() [2/2]

void Ogre::Camera::setPosition | ( | const Vector3 & | vec | ) |

Sets the camera's position.

## setProjectionType()

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

virtual inherited

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

Default is perspective.

## setQueryFlags()

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

virtual inherited

Sets the query flags for this object.

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

Definition at line 392 of file OgreMovableObject.h.

## setRenderingDistance()

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

virtual inherited

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

  dist | Distance beyond which the object will not be rendered (the default is 0, which means objects are always rendered).

Definition at line 299 of file OgreMovableObject.h.

## setRenderingMinPixelSize()

virtual void Ogre::MovableObject::setRenderingMinPixelSize | ( | Real | pixelSize | ) |

virtual inherited

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

  pixelSize | Number of minimum pixels (the default is 0, which means objects are always rendered).

Definition at line 312 of file OgreMovableObject.h.

## setRenderQueueGroup()

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

virtual inherited

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

  queueID | Enumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here.

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

## setRenderQueueGroupAndPriority()

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

virtual inherited

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

  queueID | Enumerated value of the queue group to use. See the enum RenderQueueGroupID for what kind of values can be used here.
  priority | The priority within a group to use.

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

## setRenderSystemData()

virtual void Ogre::Renderable::setRenderSystemData | ( | RenderSystemData * | val | ) | const

virtual inherited

Sets RenderSystem private data.

Remarks
  This should only be used by a RenderSystem

Definition at line 407 of file OgreRenderable.h.

## setUseIdentityProjection()

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

inherited

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

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

See also
  Renderable::getUseIdentityProjection

Definition at line 164 of file OgreRenderable.h.

## setUseIdentityView()

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

inherited

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

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

See also
  Renderable::getUseIdentityView

Definition at line 189 of file OgreRenderable.h.

## setUseMinPixelSize()

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

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.

Definition at line 657 of file OgreCamera.h.

## setUserAny() [1/2]

virtual OGRE_DEPRECATED void Ogre::MovableObject::setUserAny | ( | const Any & | anything | ) |

virtual inherited

Deprecated:
  use UserObjectBindings::setUserAny via getUserObjectBindings() instead.

Sets any kind of user value on this object.

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

Definition at line 329 of file OgreMovableObject.h.

## setUserAny() [2/2]

virtual OGRE_DEPRECATED void Ogre::Renderable::setUserAny | ( | const Any & | anything | ) |

virtual inherited

Deprecated:
  use UserObjectBindings::setUserAny via getUserObjectBindings() instead.

Sets any kind of user value on this object.

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

Definition at line 344 of file OgreRenderable.h.

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

## setUseRenderingDistance()

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

virtual

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

  use | True to use the rendering distance, false not to.

Definition at line 634 of file OgreCamera.h.

## setVisibilityFlags()

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

virtual inherited

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.

Definition at line 420 of file OgreMovableObject.h.

## setVisible()

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

virtual inherited

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

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

Reimplemented in Ogre::Light.

Referenced by Ogre::Volume::Chunk::setChunkVisible().

## setWindow()

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

virtual

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

  left | Relative to Viewport - 0 corresponds to left edge, 1 - to right edge (default - 0).
  top | Relative to Viewport - 0 corresponds to top edge, 1 - to bottom edge (default - 0).
  right | Relative to Viewport - 0 corresponds to left edge, 1 - to right edge (default - 1).
  bottom | Relative to Viewport - 0 corresponds to top edge, 1 - to bottom edge (default - 1).

## setWindowImpl()

virtual void Ogre::Camera::setWindowImpl | ( | void |  | ) | const

protected virtual

Do actual window setting, using parameters set in SetWindow call.

Remarks
  The method will called on demand.

## synchroniseBaseSettingsWith()

virtual void Ogre::Camera::synchroniseBaseSettingsWith | ( | const Camera * | cam | ) |

virtual

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.

## updateEdgeListLightFacing()

virtual void Ogre::ShadowCaster::updateEdgeListLightFacing | ( | EdgeData * | edgeData,
|  | const Vector4 & | lightPos
| ) |  |

protected virtual inherited

Tells the caster to perform the tasks necessary to update the edge data's light listing.

Can be overridden if the subclass needs to do additional things.

Parameters

  edgeData | The edge information to update.
  lightPos | 4D vector representing the light, a directional light has w=0.0.

## updateFrustum()

virtual void Ogre::Frustum::updateFrustum | ( | void |  | ) | const

protected virtual inherited

Update frustum if out of date.

## updateFrustumImpl()

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

protected virtual inherited

Implementation of updateFrustum (called if out of date)

## updateFrustumPlanes()

virtual void Ogre::Frustum::updateFrustumPlanes | ( | void |  | ) | const

protected virtual inherited

## updateFrustumPlanesImpl()

virtual void Ogre::Frustum::updateFrustumPlanesImpl | ( | void |  | ) | const

protected virtual inherited

Implementation of updateFrustumPlanes (called if out of date)

## updateVertexData()

virtual void Ogre::Frustum::updateVertexData | ( | void |  | ) | const

protected virtual inherited

## updateView()

virtual void Ogre::Frustum::updateView | ( | void |  | ) | const

protected virtual inherited

Update view if out of date.

## updateViewImpl()

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

protected virtual inherited

Implementation of updateView (called if out of date)

## updateWorldSpaceCorners()

virtual void Ogre::Frustum::updateWorldSpaceCorners | ( | void |  | ) | const

protected virtual inherited

## updateWorldSpaceCornersImpl()

virtual void Ogre::Frustum::updateWorldSpaceCornersImpl | ( | void |  | ) | const

protected virtual inherited

Implementation of updateWorldSpaceCorners (called if out of date)

## visitRenderables()

void Ogre::Frustum::visitRenderables | ( | Renderable::Visitor * | visitor,
|  | bool | debugRenderables = `false`
| ) |  |

virtual inherited

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

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

Implements Ogre::MovableObject.

## yaw()

void Ogre::Camera::yaw | ( | const Radian & | angle | ) |

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

## Friends And Related Function Documentation

## operator<<

_OgreExport friend std::ostream& operator<< | ( | std::ostream & | o,
|  | const Camera & | c
| ) |  |

friend

Function for outputting to a stream.

## Member Data Documentation

## INFINITE_FAR_PLANE_ADJUST

const Real Ogre::Frustum::INFINITE_FAR_PLANE_ADJUST

static inherited

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

Definition at line 659 of file OgreFrustum.h.

## mAspect

Real Ogre::Frustum::mAspect

protected inherited

x/y viewport ratio - default 1.3333

Definition at line 98 of file OgreFrustum.h.

## mAutoAspectRatio

bool Ogre::Camera::mAutoAspectRatio

protected

Whether aspect ratio will automatically be recalculated when a viewport changes its size.

Definition at line 172 of file OgreCamera.h.

## mAutoTrackOffset

Vector3 Ogre::Camera::mAutoTrackOffset

protected

Tracking offset for fine tuning.

Definition at line 148 of file OgreCamera.h.

## mAutoTrackTarget

SceneNode* Ogre::Camera::mAutoTrackTarget

protected

SceneNode which this Camera will automatically track.

Definition at line 146 of file OgreCamera.h.

## mBeyondFarDistance

bool Ogre::MovableObject::mBeyondFarDistance

protected inherited

Hidden because of distance?

Definition at line 128 of file OgreMovableObject.h.

## mBottom

Real Ogre::Frustum::mBottom

mutable protected inherited

Definition at line 138 of file OgreFrustum.h.

## mBoundingBox

AxisAlignedBox Ogre::Frustum::mBoundingBox

mutable protected inherited

Definition at line 169 of file OgreFrustum.h.

## mCastShadows

bool Ogre::MovableObject::mCastShadows

protected inherited

Does this object cast shadows?

Definition at line 150 of file OgreMovableObject.h.

## mCreator

MovableObjectFactory* Ogre::MovableObject::mCreator

protected inherited

Creator of this object (if created by a factory)

Definition at line 112 of file OgreMovableObject.h.

## mCullFrustum

Frustum* Ogre::Camera::mCullFrustum

protected

Custom culling frustum.

Definition at line 174 of file OgreCamera.h.

## mCustomParameters

CustomParameterMap Ogre::Renderable::mCustomParameters

protected inherited

Definition at line 415 of file OgreRenderable.h.

## mCustomProjMatrix

bool Ogre::Frustum::mCustomProjMatrix

protected inherited

Are we using a custom projection matrix?

Definition at line 134 of file OgreFrustum.h.

## mCustomViewMatrix

bool Ogre::Frustum::mCustomViewMatrix

protected inherited

Are we using a custom view matrix?

Definition at line 132 of file OgreFrustum.h.

## mDebugDisplay

bool Ogre::MovableObject::mDebugDisplay

protected inherited

Is debug display enabled?

Definition at line 121 of file OgreMovableObject.h.

## mDerivedOrientation

Quaternion Ogre::Camera::mDerivedOrientation

mutable protected

Derived orientation/position of the camera, including reflection.

Definition at line 121 of file OgreCamera.h.

## mDerivedPosition

Vector3 Ogre::Camera::mDerivedPosition

mutable protected

Definition at line 122 of file OgreCamera.h.

## mFarDist

Real Ogre::Frustum::mFarDist

protected inherited

Far clip distance - default 10000.

Definition at line 94 of file OgreFrustum.h.

## mFocalLength

Real Ogre::Frustum::mFocalLength

protected inherited

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

Definition at line 104 of file OgreFrustum.h.

## mFOVy

Radian Ogre::Frustum::mFOVy

protected inherited

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

Definition at line 92 of file OgreFrustum.h.

## mFrustumExtentsManuallySet

bool Ogre::Frustum::mFrustumExtentsManuallySet

protected inherited

Have the frustum extents been manually set?

Definition at line 136 of file OgreFrustum.h.

## mFrustumOffset

Vector2 Ogre::Frustum::mFrustumOffset

protected inherited

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

Definition at line 102 of file OgreFrustum.h.

## mFrustumPlanes

Plane Ogre::Frustum::mFrustumPlanes[6]

mutable protected inherited

The 6 main clipping planes.

Definition at line 107 of file OgreFrustum.h.

## mLastLinkedObliqueProjPlane

Plane Ogre::Frustum::mLastLinkedObliqueProjPlane

mutable protected inherited

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

Definition at line 193 of file OgreFrustum.h.

## mLastLinkedReflectionPlane

Plane Ogre::Frustum::mLastLinkedReflectionPlane

mutable protected inherited

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

Definition at line 184 of file OgreFrustum.h.

## mLastParentOrientation

Quaternion Ogre::Frustum::mLastParentOrientation

mutable protected inherited

Stored versions of parent orientation / position.

Definition at line 110 of file OgreFrustum.h.

## mLastParentPosition

Vector3 Ogre::Frustum::mLastParentPosition

mutable protected inherited

Definition at line 111 of file OgreFrustum.h.

## mLastViewport

Viewport* Ogre::Camera::mLastViewport

protected

The last viewport to be added using this camera.

Definition at line 168 of file OgreCamera.h.

## mLeft

Real Ogre::Frustum::mLeft

mutable protected inherited

Frustum extents.

Definition at line 138 of file OgreFrustum.h.

## mLightList

LightList Ogre::MovableObject::mLightList

mutable protected inherited

List of lights for this object.

Definition at line 158 of file OgreMovableObject.h.

## mLightListUpdated

ulong Ogre::MovableObject::mLightListUpdated

mutable protected inherited

The last frame that this light list was updated in.

Definition at line 160 of file OgreMovableObject.h.

## mLightMask

uint32 Ogre::MovableObject::mLightMask

protected inherited

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

Definition at line 163 of file OgreMovableObject.h.

## mLinkedObliqueProjPlane

const MovablePlane* Ogre::Frustum::mLinkedObliqueProjPlane

protected inherited

Pointer to oblique projection plane (automatically updated)

Definition at line 191 of file OgreFrustum.h.

## mLinkedReflectPlane

const MovablePlane* Ogre::Frustum::mLinkedReflectPlane

protected inherited

Pointer to a reflection plane (automatically updated)

Definition at line 182 of file OgreFrustum.h.

## mListener

Listener* Ogre::MovableObject::mListener

protected inherited

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

Definition at line 155 of file OgreMovableObject.h.

## mListeners

ListenerList Ogre::Camera::mListeners

protected

Definition at line 186 of file OgreCamera.h.

## mLodCamera

const Camera* Ogre::Camera::mLodCamera

protected

Camera to use for LOD calculation.

Definition at line 178 of file OgreCamera.h.

## mManager

SceneManager* Ogre::MovableObject::mManager

protected inherited

SceneManager holding this object (if applicable)

Definition at line 114 of file OgreMovableObject.h.

## mMaterial

MaterialPtr Ogre::Frustum::mMaterial

protected inherited

Definition at line 172 of file OgreFrustum.h.

## mMinPixelSize

Real Ogre::MovableObject::mMinPixelSize

protected inherited

Definition at line 126 of file OgreMovableObject.h.

## mName

String Ogre::MovableObject::mName

protected inherited

Name of this object.

Definition at line 110 of file OgreMovableObject.h.

## mNearDist

Real Ogre::Frustum::mNearDist

protected inherited

Near clip distance - default 100.

Definition at line 96 of file OgreFrustum.h.

## mObliqueDepthProjection

bool Ogre::Frustum::mObliqueDepthProjection

protected inherited

Is this frustum using an oblique depth projection?

Definition at line 187 of file OgreFrustum.h.

## mObliqueProjPlane

Plane Ogre::Frustum::mObliqueProjPlane

mutable protected inherited

Fixed oblique projection plane.

Definition at line 189 of file OgreFrustum.h.

## mOrientation

Quaternion Ogre::Camera::mOrientation

protected

Camera orientation, quaternion style.

Definition at line 115 of file OgreCamera.h.

## mOrientationMode

OrientationMode Ogre::Frustum::mOrientationMode

mutable protected inherited

Frustum orientation mode.

Definition at line 140 of file OgreFrustum.h.

## mOrthoHeight

Real Ogre::Frustum::mOrthoHeight

protected inherited

Ortho height size (world units)

Definition at line 100 of file OgreFrustum.h.

## mParentIsTagPoint

bool Ogre::MovableObject::mParentIsTagPoint

protected inherited

Definition at line 117 of file OgreMovableObject.h.

## mParentNode

Node* Ogre::MovableObject::mParentNode

protected inherited

node to which this object is attached

Definition at line 116 of file OgreMovableObject.h.

## mPixelDisplayRatio

Real Ogre::Camera::mPixelDisplayRatio

protected

See also
  Camera::getPixelDisplayRatio

Definition at line 183 of file OgreCamera.h.

## mPolygonModeOverrideable

bool Ogre::Renderable::mPolygonModeOverrideable

protected inherited

Definition at line 416 of file OgreRenderable.h.

## mPosition

Vector3 Ogre::Camera::mPosition

protected

Camera position - default (0,0,0)

Definition at line 118 of file OgreCamera.h.

## mProjMatrix

Matrix4 Ogre::Frustum::mProjMatrix

mutable protected inherited

Pre-calced standard projection matrix.

Definition at line 118 of file OgreFrustum.h.

## mProjMatrixRS

Matrix4 Ogre::Frustum::mProjMatrixRS

mutable protected inherited

Pre-calced projection matrix for the specific render system.

Definition at line 114 of file OgreFrustum.h.

## mProjMatrixRSDepth

Matrix4 Ogre::Frustum::mProjMatrixRSDepth

mutable protected inherited

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

Definition at line 116 of file OgreFrustum.h.

## mProjType

ProjectionType Ogre::Frustum::mProjType

protected inherited

Orthographic or perspective?

Definition at line 89 of file OgreFrustum.h.

## mQueryFlags

uint32 Ogre::MovableObject::mQueryFlags

protected inherited

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

Definition at line 140 of file OgreMovableObject.h.

## mRealOrientation

Quaternion Ogre::Camera::mRealOrientation

mutable protected

Real world orientation/position of the camera.

Definition at line 125 of file OgreCamera.h.

## mRealPosition

Vector3 Ogre::Camera::mRealPosition

mutable protected

Definition at line 126 of file OgreCamera.h.

## mRecalcFrustum

bool Ogre::Frustum::mRecalcFrustum

mutable protected inherited

Something's changed in the frustum shape?

Definition at line 122 of file OgreFrustum.h.

## mRecalcFrustumPlanes

bool Ogre::Frustum::mRecalcFrustumPlanes

mutable protected inherited

Something re the frustum planes has changed.

Definition at line 126 of file OgreFrustum.h.

## mRecalcVertexData

bool Ogre::Frustum::mRecalcVertexData

mutable protected inherited

Something re the vertex data has changed.

Definition at line 130 of file OgreFrustum.h.

## mRecalcView

bool Ogre::Frustum::mRecalcView

mutable protected inherited

Something re the view pos has changed.

Definition at line 124 of file OgreFrustum.h.

## mRecalcWindow

bool Ogre::Camera::mRecalcWindow

mutable protected

Was viewing window changed.

Definition at line 166 of file OgreCamera.h.

## mRecalcWorldSpaceCorners

bool Ogre::Frustum::mRecalcWorldSpaceCorners

mutable protected inherited

Something re the world space corners has changed.

Definition at line 128 of file OgreFrustum.h.

## mReflect

bool Ogre::Frustum::mReflect

protected inherited

Is this frustum to act as a reflection of itself?

Definition at line 176 of file OgreFrustum.h.

## mReflectMatrix

Matrix4 Ogre::Frustum::mReflectMatrix

mutable protected inherited

Derived reflection matrix.

Definition at line 178 of file OgreFrustum.h.

## mReflectPlane

Plane Ogre::Frustum::mReflectPlane

mutable protected inherited

Fixed reflection plane.

Definition at line 180 of file OgreFrustum.h.

## mRenderingDisabled

bool Ogre::MovableObject::mRenderingDisabled

protected inherited

Does rendering this object disabled by listener?

Definition at line 153 of file OgreMovableObject.h.

## mRenderQueueID

uint8 Ogre::MovableObject::mRenderQueueID

protected inherited

The render queue to use when rendering this object.

Definition at line 132 of file OgreMovableObject.h.

## mRenderQueueIDSet

bool Ogre::MovableObject::mRenderQueueIDSet

protected inherited

Flags whether the RenderQueue's default should be used.

Definition at line 134 of file OgreMovableObject.h.

## mRenderQueuePriority

ushort Ogre::MovableObject::mRenderQueuePriority

protected inherited

The render queue group to use when rendering this object.

Definition at line 136 of file OgreMovableObject.h.

## mRenderQueuePrioritySet

bool Ogre::MovableObject::mRenderQueuePrioritySet

protected inherited

Flags whether the RenderQueue's default should be used.

Definition at line 138 of file OgreMovableObject.h.

## mRenderSystemData

RenderSystemData* Ogre::Renderable::mRenderSystemData

mutable protected inherited

User objects binding.

Definition at line 420 of file OgreRenderable.h.

## mRight

Real Ogre::Frustum::mRight

mutable protected inherited

Definition at line 138 of file OgreFrustum.h.

## msAnimableDictionary

AnimableDictionaryMap Ogre::AnimableObject::msAnimableDictionary

static protected inherited

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

Definition at line 243 of file OgreAnimable.h.

## mSceneDetail

PolygonMode Ogre::Camera::mSceneDetail

protected

Rendering type.

Definition at line 134 of file OgreCamera.h.

## mSceneLodFactor

Real Ogre::Camera::mSceneLodFactor

protected

Scene LOD factor used to adjust overall LOD.

Definition at line 151 of file OgreCamera.h.

## mSceneLodFactorInv

Real Ogre::Camera::mSceneLodFactorInv

protected

Inverted scene LOD factor, can be used by Renderables to adjust their LOD.

Definition at line 153 of file OgreCamera.h.

## mSceneMgr

SceneManager* Ogre::Camera::mSceneMgr

protected

Scene manager responsible for the scene.

Definition at line 112 of file OgreCamera.h.

## msDefaultQueryFlags

uint32 Ogre::MovableObject::msDefaultQueryFlags

static protected inherited

Default query flags.

Definition at line 167 of file OgreMovableObject.h.

## msDefaultVisibilityFlags

uint32 Ogre::MovableObject::msDefaultVisibilityFlags

static protected inherited

Default visibility flags.

Definition at line 169 of file OgreMovableObject.h.

## msMovableType

String Ogre::Camera::msMovableType

static protected

Shared class-level name for Movable type.

Definition at line 143 of file OgreCamera.h.

## mSquaredUpperDistance

Real Ogre::MovableObject::mSquaredUpperDistance

protected inherited

Definition at line 124 of file OgreMovableObject.h.

## mTop

Real Ogre::Frustum::mTop

mutable protected inherited

Definition at line 138 of file OgreFrustum.h.

## mUpperDistance

Real Ogre::MovableObject::mUpperDistance

protected inherited

Upper distance to still render.

Definition at line 123 of file OgreMovableObject.h.

## mUseIdentityProjection

bool Ogre::Renderable::mUseIdentityProjection

protected inherited

Definition at line 417 of file OgreRenderable.h.

## mUseIdentityView

bool Ogre::Renderable::mUseIdentityView

protected inherited

Definition at line 418 of file OgreRenderable.h.

## mUseMinPixelSize

bool Ogre::Camera::mUseMinPixelSize

protected

Whether or not the minimum display size of objects should take effect for this camera.

Definition at line 181 of file OgreCamera.h.

## mUseRenderingDistance

bool Ogre::Camera::mUseRenderingDistance

protected

Whether or not the rendering distance of objects should take effect for this camera.

Definition at line 176 of file OgreCamera.h.

## mUserObjectBindings [1/2]

UserObjectBindings Ogre::MovableObject::mUserObjectBindings

protected inherited

User objects binding.

Definition at line 130 of file OgreMovableObject.h.

## mUserObjectBindings [2/2]

UserObjectBindings Ogre::Renderable::mUserObjectBindings

protected inherited

Definition at line 419 of file OgreRenderable.h.

## mVertexData

VertexData Ogre::Frustum::mVertexData

mutable protected inherited

Definition at line 170 of file OgreFrustum.h.

## mViewMatrix

Matrix4 Ogre::Frustum::mViewMatrix

mutable protected inherited

Pre-calced view matrix.

Definition at line 120 of file OgreFrustum.h.

## mVisBatchesLastRender

unsigned int Ogre::Camera::mVisBatchesLastRender

protected

Stored number of visible batches in the last render.

Definition at line 140 of file OgreCamera.h.

## mVisFacesLastRender

unsigned int Ogre::Camera::mVisFacesLastRender

protected

Stored number of visible faces in the last render.

Definition at line 137 of file OgreCamera.h.

## mVisibilityFlags

uint32 Ogre::MovableObject::mVisibilityFlags

protected inherited

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

Definition at line 142 of file OgreMovableObject.h.

## mVisible

bool Ogre::MovableObject::mVisible

protected inherited

Is this object visible?

Definition at line 119 of file OgreMovableObject.h.

## mWBottom

Real Ogre::Camera::mWBottom

protected

Definition at line 160 of file OgreCamera.h.

## mWindowClipPlanes

vector<Plane>::type Ogre::Camera::mWindowClipPlanes

mutable protected

Windowed viewport clip planes.

Definition at line 164 of file OgreCamera.h.

## mWindowSet

bool Ogre::Camera::mWindowSet

protected

Is viewing window used.

Definition at line 162 of file OgreCamera.h.

## mWLeft

Real Ogre::Camera::mWLeft

protected

Viewing window.

Remarks
  Generalize camera class for the case, when viewing frustum doesn't cover all viewport.

Definition at line 160 of file OgreCamera.h.

## mWorldAABB

AxisAlignedBox Ogre::MovableObject::mWorldAABB

mutable protected inherited

Cached world AABB of this object.

Definition at line 144 of file OgreMovableObject.h.

## mWorldBoundingSphere

Sphere Ogre::MovableObject::mWorldBoundingSphere

mutable protected inherited

Definition at line 146 of file OgreMovableObject.h.

## mWorldDarkCapBounds

AxisAlignedBox Ogre::MovableObject::mWorldDarkCapBounds

mutable protected inherited

World space AABB of this object's dark cap.

Definition at line 148 of file OgreMovableObject.h.

## mWorldSpaceCorners

Vector3 Ogre::Frustum::mWorldSpaceCorners[8]

mutable protected inherited

Definition at line 173 of file OgreFrustum.h.

## mWRight

Real Ogre::Camera::mWRight

protected

Definition at line 160 of file OgreCamera.h.

## mWTop

Real Ogre::Camera::mWTop

protected

Definition at line 160 of file OgreCamera.h.

## mYawFixed

bool Ogre::Camera::mYawFixed

protected

Whether to yaw around a fixed axis.

Definition at line 129 of file OgreCamera.h.

## mYawFixedAxis

Vector3 Ogre::Camera::mYawFixedAxis

protected

Fixed axis to yaw around.

Definition at line 131 of file OgreCamera.h.

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

- OgreCamera.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.