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

#include <OgreCamera.h>

Inheritance diagram for Ogre::Camera:

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

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

Real	_getLodBiasInverse (void) const
	Internal method for OGRE to use for LOD calculations. 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...

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)
	Tells the Camera to contact the SceneManager to render from it's viewpoint. More...

void	_renderScene (Viewport *vp, bool unused)

virtual void	addListener (Listener *l)
	Add a listener to this camera. More...

virtual void	forwardIntersect (const Plane &worldPlane, std::vector< Vector4 > *intersect3d) const
	Forward projects frustum rays to find forward intersection with plane. 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...

Real	getBoundingRadius (void) const override
	Retrieves the radius of the origin-centered bounding sphere for this object. 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)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. 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...

Frustum *	getCullingFrustum (void) const
	Returns the custom culling frustum in use. 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...

Real	getFarClipDistance (void) const
	Retrieves the distance from the frustum to the far clipping plane. More...

const Plane &	getFrustumPlane (unsigned short plane) const
	Retrieves a specified plane of the frustum (world space). 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 String &	getMovableType (void) const override
	Returns the type name of this object. More...

Real	getNearClipDistance (void) const
	Retrieves the distance from the frustum to the near clipping plane. 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...

Real	getPixelDisplayRatio () const
	Returns an estimated ratio between a pixel and the display area it represents. More...

PolygonMode	getPolygonMode (void) const
	Retrieves the level of detail that the camera will render. 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...

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

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

SortMode	getSortMode () const
	get the currently used SortMode More...

Vector3	getUp (void) const
	Gets the camera's up vector. More...

bool	getUseMinPixelSize () const
	Returns whether to use min display size calculations. More...

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

const Affine3 &	getViewMatrix (bool ownFrustumOnly) const
	Specialised version of getViewMatrix allowing caller to differentiate whether the custom culling frustum should be allowed or not. More...

const Affine3 &	getViewMatrix (void) const
	Gets the view matrix for this frustum. More...

Viewport *	getViewport (void) const
	Get the last viewport which was attached to this camera. More...

const std::vector< Plane > &	getWindowPlanes (void) const
	Gets the window clip planes, only applicable if isWindowSet == true. More...

const Corners &	getWorldSpaceCorners (void) const
	Gets the world space corners of the frustum. More...

void	getWorldTransforms (Matrix4 *mat) const override
	Gets the world transform matrix / matrices for this renderable object. 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)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

void	move (const Vector3 &vec)
	Moves the camera's position by the vector offset provided along world axes. More...

void	moveRelative (const Vector3 &vec)
	Moves the camera's position by the vector offset provided along it's own axes (relative to orientation). More...

void	pitch (const Radian &angle)
	Pitches the camera up/down anticlockwise around it's local z axis. More...

bool	projectSphere (const Sphere &sphere, Real left, Real top, Real right, Real bottom) const
	Project a sphere onto the near plane and get the bounding rectangle. More...

virtual void	removeListener (Listener *l)
	Remove a listener to this camera. 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 Quaternion &q)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

void	rotate (const Vector3 &axis, const Radian &angle)
	Rotate the camera around an arbitrary axis. 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	setCullingFrustum (Frustum *frustum)
	Tells the camera to use a separate Frustum instance to perform culling. More...

void	setDirection (const Vector3 &vec)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

void	setDirection (Real x, Real y, Real z)
	Sets the camera's direction vector. More...

void	setFixedYawAxis (bool useFixed, const Vector3 &fixedAxis=Vector3::UNIT_Y)
	Tells the camera whether to yaw around it's own local Y axis or a fixed axis of choice. More...

void	setLodBias (Real factor=1.0)
	Sets the level-of-detail factor for this Camera. More...

virtual void	setLodCamera (const Camera *lodCam)
	Set a pointer to the camera which should be used to determine LOD settings. More...

void	setOrientation (const Quaternion &q)
	Sets the camera's orientation. More...

void	setPolygonMode (PolygonMode sd)
	Sets the level of rendering detail required from this camera. More...

void	setPosition (const Vector3 &vec)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

void	setPosition (Real x, Real y, Real z)
	Sets the camera's position. More...

void	setSortMode (SortMode sm)
	Set the function used to compute the camera-distance for sorting Renderables. More...

void	setUseMinPixelSize (bool enable)
	Sets whether to use min display size calculations. More...

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	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	yaw (const Radian &angle)
	Rotates the camera anticlockwise around it's local y axis. More...

Public Member Functions inherited from Ogre::Frustum
	Frustum (const String &name=BLANKSTRING)
	Named constructor. More...

virtual	~Frustum ()

void	_notifyCurrentCamera (Camera *cam) override
	Internal method to notify the object of the camera to be used for the next rendering operation. More...

void	_updateRenderQueue (RenderQueue *queue) override
	Internal method by which the movable object must add Renderable subclass instances to the rendering queue. More...

void	calcViewMatrixRelative (const Vector3 &relPos, Matrix4 &matToUpdate) const
	Calculate a view matrix for this frustum, relative to a potentially dynamic point. More...

void	disableCustomNearClipPlane (void)
	Disables any custom near clip plane. More...

void	disableReflection (void)
	Disables reflection modification previously turned on with enableReflection. More...

void	enableCustomNearClipPlane (const MovablePlane *plane)
	Links the frustum to a custom near clip plane, which can be used to clip geometry in a custom manner without using user clip planes. More...

void	enableCustomNearClipPlane (const Plane &plane)
	Links the frustum to a custom near clip plane, which can be used to clip geometry in a custom manner without using user clip planes. More...

void	enableReflection (const MovablePlane *p)
	Modifies this frustum so it always renders from the reflection of itself through the plane specified. More...

void	enableReflection (const Plane &p)
	Modifies this frustum so it always renders from the reflection of itself through the plane specified. More...

Real	getAspectRatio (void) const
	Retrieves the current aspect ratio. More...

const AxisAlignedBox &	getBoundingBox (void) const override
	Retrieves the local axis-aligned bounding box for this object. More...

Real	getBoundingRadius (void) const override
	Retrieves the radius of the origin-centered bounding sphere for this object. More...

const ColourValue &	getDebugColour () const

Real	getFarClipDistance (void) const
	Retrieves the distance from the frustum to the far clipping plane. More...

Real	getFocalLength () const
	Returns focal length of frustum. More...

const Radian &	getFOVy (void) const
	Retrieves the frustums Y-dimension Field Of View (FOV). More...

RealRect	getFrustumExtents () const
	Get the extents of the frustum in view space. More...

void	getFrustumExtents (Real &outleft, Real &outright, Real &outtop, Real &outbottom) const

const Vector2 &	getFrustumOffset () const
	Retrieves the frustum offsets. More...

virtual const Plane *	getFrustumPlanes (void) const
	Retrieves the clipping planes of the frustum (world space). More...

const LightList &	getLights (void) const override
	Gets a list of lights, ordered relative to how close they are to this renderable. More...

const MaterialPtr &	getMaterial (void) const override
	Retrieves a weak reference to the material this renderable object uses. More...

const String &	getMovableType (void) const override
	Returns the type name of this object. More...

Real	getNearClipDistance (void) const
	Retrieves the distance from the frustum to the near clipping plane. More...

OrientationMode	getOrientationMode () const
	Get the orientation mode of the frustum. More...

Real	getOrthoWindowHeight () const
	Gets the orthographic window height, for use with orthographic rendering only. More...

Real	getOrthoWindowWidth () const
	Gets the orthographic window width, for use with orthographic rendering only. More...

PlaneBoundedVolume	getPlaneBoundedVolume ()
	Gets a world-space list of planes enclosing the frustum. More...

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

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

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

ProjectionType	getProjectionType (void) const
	Retrieves info on the type of projection used (orthographic or perspective). More...

const Affine3 &	getReflectionMatrix (void) const
	Returns the reflection matrix of the frustum if appropriate. More...

const Plane &	getReflectionPlane (void) const
	Returns the reflection plane of the frustum if appropriate. More...

void	getRenderOperation (RenderOperation &op) override
	Gets the render operation required to send this object to the frame buffer. More...

Real	getSquaredViewDepth (const Camera *cam) const override
	Returns the squared distance between the camera and this renderable. More...

uint32	getTypeFlags (void) const override
	Get the 'type flags' for this MovableObject. More...

const Affine3 &	getViewMatrix (void) const
	Gets the view matrix for this frustum. More...

void	getWorldTransforms (Matrix4 *xform) const override
	Gets the world transform matrix / matrices for this renderable object. More...

bool	isCustomNearClipPlaneEnabled (void) const
	Is a custom near clip plane in use? More...

bool	isCustomProjectionMatrixEnabled (void) const
	Returns whether a custom projection matrix is in use. More...

bool	isCustomViewMatrixEnabled (void) const
	Returns whether a custom view matrix is in use. More...

bool	isReflected (void) const
	Returns whether this frustum is being reflected. More...

void	resetFrustumExtents ()
	Reset the frustum extents to be automatically derived from other params. More...

void	setAspectRatio (Real ratio)
	Sets the aspect ratio for the frustum viewport. More...

void	setCustomProjectionMatrix (bool enable, const Matrix4 &projectionMatrix=Matrix4::IDENTITY)
	Set whether to use a custom projection matrix on this frustum. More...

void	setCustomViewMatrix (bool enable, const Affine3 &viewMatrix=Affine3::IDENTITY)
	Set whether to use a custom view matrix on this frustum. More...

void	setDebugColour (const ColourValue &col)

void	setFarClipDistance (Real farDist)
	Sets the distance to the far clipping plane. More...

void	setFocalLength (Real focalLength=1.0)
	Sets frustum focal length (used in stereo rendering). More...

void	setFOVy (const Radian &fovy)
	Sets the Y-dimension Field Of View (FOV) of the frustum. More...

void	setFrustumExtents (Real left, Real right, Real top, Real bottom)
	Manually set the extents of the frustum. More...

void	setFrustumOffset (const Vector2 &offset)
	Sets frustum offsets, used in stereo rendering. More...

void	setFrustumOffset (Real horizontal=0.0, Real vertical=0.0)
	Sets frustum offsets, used in stereo rendering. More...

void	setMaterial (const MaterialPtr &mat)

void	setNearClipDistance (Real nearDist)
	Sets the position of the near clipping plane. More...

void	setOrientationMode (OrientationMode orientationMode)
	Set the orientation mode of the frustum. More...

void	setOrthoWindow (Real w, Real h)
	Sets the orthographic window settings, for use with orthographic rendering only. More...

void	setOrthoWindowHeight (Real h)
	Sets the orthographic window height, for use with orthographic rendering only. More...

void	setOrthoWindowWidth (Real w)
	Sets the orthographic window width, for use with orthographic rendering only. More...

virtual void	setProjectionType (ProjectionType pt)
	Sets the type of projection to use (orthographic or perspective). 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...

Public Member Functions inherited from Ogre::MovableObject
	MovableObject ()
	Constructor. More...

	MovableObject (const String &name)
	Named constructor. More...

virtual	~MovableObject ()
	Virtual destructor - read Scott Meyers if you don't know why this is needed. More...

MovableObjectFactory *	_getCreator (void) const
	Get the creator of this object, if any (internal use only) More...

LightList *	_getLightList ()
	Returns a pointer to the current list of lights for this object. More...

SceneManager *	_getManager (void) const
	Get the manager of this object, if any (internal use only) More...

virtual const Affine3 &	_getParentNodeFullTransform (void) const
	Return the full transformation of the parent sceneNode or the attachingPoint node. More...

virtual void	_notifyAttached (Node *parent, bool isTagPoint=false)
	Internal method called to notify the object that it has been attached to a node. More...

virtual void	_notifyCreator (MovableObjectFactory *fact)
	Notify the object of it's creator (internal use only) More...

virtual void	_notifyManager (SceneManager *man)
	Notify the object of it's manager (internal use only) More...

virtual void	_notifyMoved (void)
	Internal method called to notify the object that it has been moved. More...

virtual void	_releaseManualHardwareResources ()
	Notifies the movable object that hardware resources were lost. More...

virtual void	_restoreManualHardwareResources ()
	Notifies the movable object that hardware resources should be restored. More...

void	addQueryFlags (uint32 flags)
	As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. More...

void	addVisibilityFlags (uint32 flags)
	As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. More...

void	detachFromParent (void)
	Detaches an object from a parent SceneNode or TagPoint, if attached. More...

Real	getBoundingRadiusScaled () const
	as getBoundingRadius, but with scaling applied More...

bool	getCastShadows (void) const
	Returns whether shadow casting is enabled for this object. More...

const AxisAlignedBox &	getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const override
	Gets the world space bounding box of the dark cap, as extruded using the light provided. More...

EdgeData *	getEdgeList (void)
	Returns details of the edges which might be used to determine a silhouette. More...

const AxisAlignedBox &	getLightCapBounds (void) const override
	Gets the world space bounding box of the light cap. More...

uint32	getLightMask () const
	Get a bitwise mask which will filter the lights affecting this object. More...

Listener *	getListener (void) const
	Gets the current listener for this object. More...

const String &	getName (void) const
	Returns the name of this object. More...

Node *	getParentNode (void) const
	Returns the node to which this object is attached. More...

SceneNode *	getParentSceneNode (void) const
	Returns the scene node to which this object is attached. More...

Real	getPointExtrusionDistance (const Light *l) const
	Get the distance to extrude for a point/spot light. More...

virtual uint32	getQueryFlags (void) const
	Returns the query flags relevant for this object. More...

bool	getReceivesShadows ()
	Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows. More...

Real	getRenderingDistance (void) const
	Gets the distance at which batches are no longer rendered. More...

Real	getRenderingMinPixelSize () const
	Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...

uint8	getRenderQueueGroup (void) const
	Gets the queue group for this entity. More...

const ShadowRenderableList &	getShadowVolumeRenderableList (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...

const Any &	getUserAny (void) const

UserObjectBindings &	getUserObjectBindings ()
	Return an instance of user objects binding associated with this class. More...

const UserObjectBindings &	getUserObjectBindings () const
	Return an instance of user objects binding associated with this class. More...

virtual uint32	getVisibilityFlags (void) const
	Returns the visibility flags relevant for this object. More...

bool	getVisible (void) const
	Gets this object whether to be visible or not, if it has a renderable component. More...

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

bool	isAttached (void) const
	Returns true if this object is attached to a SceneNode or TagPoint. More...

bool	isDebugDisplayEnabled (void) const
	Gets whether debug display of this object is enabled. More...

virtual bool	isInScene (void) const
	Returns true if this object is attached to a SceneNode or TagPoint, and this SceneNode / TagPoint is currently in an active part of the scene graph. More...

bool	isParentTagPoint () const
	Gets whether the parent node is a TagPoint (or a SceneNode) More...

virtual bool	isVisible (void) const
	Returns whether or not this object is supposed to be visible or not. More...

const LightList &	queryLights (void) const
	Gets a list of lights, ordered relative to how close they are to this movable object. More...

void	removeQueryFlags (uint32 flags)
	As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. More...

void	removeVisibilityFlags (uint32 flags)
	As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object. More...

void	setCastShadows (bool enabled)
	Sets whether or not this object will cast shadows. More...

void	setDebugDisplayEnabled (bool enabled)
	Sets whether or not the debug display of this object is enabled. More...

void	setLightMask (uint32 lightMask)
	Set a bitwise mask which will filter the lights affecting this object. More...

void	setListener (Listener *listener)
	Sets a listener for this object. More...

void	setQueryFlags (uint32 flags)
	Sets the query flags for this object. More...

void	setRenderingDistance (Real dist)
	Sets the distance at which the object is no longer rendered. More...

void	setRenderingMinPixelSize (Real pixelSize)
	Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...

virtual void	setRenderQueueGroup (uint8 queueID)
	Sets the render queue group this entity will be rendered through. More...

virtual void	setRenderQueueGroupAndPriority (uint8 queueID, ushort priority)
	Sets the render queue group and group priority this entity will be rendered through. More...

void	setUserAny (const Any &anything)

void	setVisibilityFlags (uint32 flags)
	Sets the visibility flags for this object. More...

void	setVisible (bool visible)
	Tells this object whether to be visible or not, if it has a renderable component. More...

Public Member Functions inherited from Ogre::ShadowCaster
virtual	~ShadowCaster ()

virtual ShadowRenderableListIterator	getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light light, HardwareIndexBufferSharedPtr indexBuffer, size_t *indexBufferUsedSize, bool extrudeVertices, Real extrusionDistance, unsigned long flags=0)

bool	hasEdgeList ()
	Returns whether the object has a valid edge list. More...

Public Member Functions inherited from Ogre::AnimableObject
	AnimableObject ()

virtual	~AnimableObject ()

virtual AnimableValuePtr	createAnimableValue (const String &valueName)
	Create a reference-counted AnimableValuePtr for the named value. More...

const StringVector &	getAnimableValueNames (void) const
	Gets a list of animable value names for this object. More...

Public Member Functions inherited from Ogre::Renderable
	Renderable ()

virtual	~Renderable ()
	Virtual destructor needed as class has virtual methods. 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...

const Vector4 &	getCustomParameter (size_t index) const
	Gets the custom value associated with this Renderable at the given index. More...

virtual unsigned short	getNumWorldTransforms (void) const
	Returns the number of world transform matrices this renderable requires. More...

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

const RenderSystemDataPtr &	getRenderSystemData () const

virtual Technique *	getTechnique (void) const
	Retrieves a pointer to the Material Technique this renderable object uses. 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...

const Any &	getUserAny (void) const

UserObjectBindings &	getUserObjectBindings ()
	Return an instance of user objects binding associated with this class. More...

const UserObjectBindings &	getUserObjectBindings () const
	Return an instance of user objects binding associated with this class. More...

bool	hasCustomParameter (size_t index) const
	Checks whether a custom value is associated with this Renderable at the given index. 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...

void	removeCustomParameter (size_t index)
	Removes a custom value which is associated with this Renderable at the given index. More...

void	setCustomParameter (size_t index, const Vector4 &value)
	Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters. More...

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

void	setRenderSystemData (RenderSystemDataPtr val) const

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	setUserAny (const Any &anything)

Additional Inherited Members
Public Types inherited from Ogre::Frustum
typedef Vector3	Corners[8]

Public Types inherited from Ogre::ShadowCaster
typedef std::vector< ShadowRenderable * >	ShadowRenderableList

typedef VectorIterator< ShadowRenderableList >	ShadowRenderableListIterator

Public Types inherited from Ogre::Renderable
enum	{ DEFAULT_PRIORITY = 100 }

typedef SharedPtr< RenderSystemData >	RenderSystemDataPtr

Static Public Member Functions inherited from Ogre::MovableObject
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 Member Functions inherited from Ogre::ShadowCaster
static void	clearShadowRenderableList (ShadowRenderableList &shadowRenderables)
	Common implementation of releasing shadow renderables. More...

static void	extrudeVertices (const HardwareVertexBufferSharedPtr &vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist)
	Utility method for extruding vertices based on a light. More...

Static Public Attributes inherited from Ogre::Frustum
static const Real	INFINITE_FAR_PLANE_ADJUST
	Small constant used to reduce far plane projection to avoid inaccuracies. More...

Detailed Description

A viewpoint from which the scene will be rendered.

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.

At render time, all Scene Objects will be transformed in the camera space, which is defined as:

\(+x\) is right
\(+y\) is up
\(-z\) is away

Cameras maintain their own aspect ratios, field of view, and frustum, and project co-ordinates into normalised device coordinates measured from -1 to 1 in x and y, and 0 to 1 in z, where

\(+x\) is right
\(+y\) is up
\(+z\) is away

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

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

◆ addListener()

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

virtual

Add a listener to this camera.

◆ removeListener()

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

virtual

Remove a listener to this camera.

◆ getSceneManager()

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

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

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

◆ getPolygonMode()

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

Retrieves the level of detail that the camera will render.

◆ setPosition() [1/2]

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

Sets the camera's position.

Deprecated:: attach to SceneNode and use SceneNode::setPosition

◆ setPosition() [2/2]

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

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

Deprecated:: attach to SceneNode and use SceneNode::setPosition

◆ getPosition()

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

Retrieves the camera's position.

Deprecated:: attach to SceneNode and use SceneNode::getPosition

◆ move()

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

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

Deprecated:: attach to SceneNode and use SceneNode::translate

◆ moveRelative()

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

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

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

◆ setDirection() [1/2]

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

Sets the camera's direction vector.

Remarks: Note that the 'up' vector for the camera will automatically be recalculated based on the current 'up' vector (i.e. the roll will remain the same).

Deprecated:: attach to SceneNode and use SceneNode::setDirection

◆ setDirection() [2/2]

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

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

Deprecated:: attach to SceneNode and use SceneNode::setDirection

◆ getDirection()

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

Gets the camera's direction.

Deprecated:: attach to SceneNode and use SceneNode::getOrientation().zAxis() * -1

◆ getUp()

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

Gets the camera's up vector.

Deprecated:: attach to SceneNode and use SceneNode::getOrientation().yAxis()

◆ getRight()

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

Gets the camera's right vector.

Deprecated:: attach to SceneNode and use SceneNode::getOrientation().xAxis()

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

Deprecated:: attach to SceneNode and use SceneNode::lookAt

◆ lookAt() [2/2]

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

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

Deprecated:: attach to SceneNode and use SceneNode::lookAt

◆ roll()

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

Rolls the camera anticlockwise, around its local z axis.

Deprecated:: attach to SceneNode and use SceneNode::roll

◆ yaw()

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

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

Deprecated:: attach to SceneNode and use SceneNode::yaw

◆ pitch()

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

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

Deprecated:: attach to SceneNode and use SceneNode::pitch

◆ rotate() [1/2]

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

Rotate the camera around an arbitrary axis.

Deprecated:: attach to SceneNode and use SceneNode::rotate

◆ rotate() [2/2]

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

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

Deprecated:: attach to SceneNode and use SceneNode::rotate

◆ setFixedYawAxis()

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

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.

Deprecated:: attach to SceneNode and use SceneNode::yaw(angle, Node::TS_PARENT)

◆ getOrientation()

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

Returns the camera's current orientation.

Deprecated:: attach to SceneNode and use SceneNode::getOrientation

◆ setOrientation()

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

Sets the camera's orientation.

Deprecated:: attach to SceneNode and use SceneNode::setOrientation

◆ _autoTrack()

void Ogre::Camera::_autoTrack ( void )

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

◆ getAutoTrackTarget()

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

inline

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

◆ getAutoTrackOffset()

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

inline

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

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

Deprecated:: attach to SceneNode and use SceneNode::setAutoTracking

◆ getPositionForViewUpdate()

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

virtual

Get the derived position of this frustum.

Reimplemented from Ogre::Frustum.

◆ getOrientationForViewUpdate()

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

virtual

Get the derived orientation of this frustum.

Reimplemented from Ogre::Frustum.

◆ _renderScene() [1/2]

void Ogre::Camera::_renderScene ( Viewport * vp )

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

Parameters

vp	The viewport to render to

◆ _renderScene() [2/2]

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

inline

Deprecated:: do not use

References _renderScene().

Referenced by _renderScene().

◆ _notifyRenderedFaces()

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

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

◆ _notifyRenderedBatches()

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

Internal method to notify camera of the 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.

◆ _getNumRenderedBatches()

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

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

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

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

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

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

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

◆ getRealDirection()

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

Gets the real world direction 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.

◆ getRealRight()

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

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

◆ getWorldTransforms()

void Ogre::Camera::getWorldTransforms ( Matrix4 * xform ) const

overridevirtual

Gets the world transform matrix / matrices for this renderable object.

Remarks: If the object has any derived transforms, these are expected to be up to date as long as all the SceneNode structures have been updated before this is called.

: This method will populate transform with 1 matrix if it does not use vertex blending. If it does use vertex blending it will fill the passed in pointer with an array of matrices, the length being the value returned from getNumWorldTransforms.

Note: Internal Ogre never supports non-affine matrix for world transform matrix/matrices, the behavior is undefined if returns non-affine matrix here.

Implements Ogre::Renderable.

◆ getMovableType()

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

overridevirtual

Returns the type name of this object.

Implements Ogre::MovableObject.

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

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

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

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

◆ 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

◆ 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`
	)

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

◆ _getLodBiasInverse()

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

Internal method for OGRE to use for LOD calculations.

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

◆ resetWindow()

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

virtual

Cancel view window.

◆ isWindowSet()

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

inlinevirtual

Returns if a viewport window is being used.

◆ getWindowPlanes()

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

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

◆ getBoundingRadius()

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

overridevirtual

Retrieves the radius of the origin-centered bounding sphere for this object.

Implements Ogre::MovableObject.

◆ getViewport()

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

inline

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.

Referenced by Ogre::SceneManager::_queueSkiesForRendering().

◆ _notifyViewport()

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

inline

Notifies this camera that a viewport is using it.

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

◆ getAutoAspectRatio()

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

Retrieves if AutoAspectRatio is currently set or not.

◆ setCullingFrustum()

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

inline

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.

◆ getCullingFrustum()

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

inline

Returns the custom culling frustum in use.

◆ forwardIntersect()

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

virtual

Forward projects frustum rays to find forward intersection with plane.

Remarks: Forward projection may lead to intersections at infinity.

◆ isVisible() [1/3]

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.

Reimplemented in Ogre::PCZCamera.

◆ isVisible() [2/3]

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() [3/3]

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.

◆ getWorldSpaceCorners()

const Corners& 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.

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

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

◆ getNearClipDistance()

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

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

◆ getFarClipDistance()

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

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

◆ getViewMatrix() [1/2]

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

Gets the view matrix for this frustum.

Mainly for use by OGRE internally.

◆ getViewMatrix() [2/2]

const Affine3& 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.

◆ setUseRenderingDistance()

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

inlinevirtual

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.

◆ getUseRenderingDistance()

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

inlinevirtual

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

◆ synchroniseBaseSettingsWith()

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

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.

◆ setUseMinPixelSize()

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

inline

Sets whether to use min display size calculations.

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

◆ getUseMinPixelSize()

bool Ogre::Camera::getUseMinPixelSize ( ) const

inline

Returns whether to use min display size calculations.

See also: Camera::setUseMinDisplaySize

◆ getPixelDisplayRatio()

Real Ogre::Camera::getPixelDisplayRatio ( ) const

inline

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.

◆ setSortMode()

void Ogre::Camera::setSortMode ( SortMode sm )

inline

Set the function used to compute the camera-distance for sorting Renderables.

◆ getSortMode()

SortMode Ogre::Camera::getSortMode ( ) const

inline

get the currently used SortMode

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

OgreCamera.h

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Camera()

◆ ~Camera()

Member Function Documentation

◆ addListener()

◆ removeListener()

◆ getSceneManager()

◆ setPolygonMode()

◆ getPolygonMode()

◆ setPosition() [1/2]

◆ setPosition() [2/2]

◆ getPosition()

◆ move()

◆ moveRelative()

◆ setDirection() [1/2]

◆ setDirection() [2/2]

◆ getDirection()

◆ getUp()

◆ getRight()

◆ lookAt() [1/2]

◆ lookAt() [2/2]

◆ roll()

◆ yaw()

◆ pitch()

◆ rotate() [1/2]

◆ rotate() [2/2]

◆ setFixedYawAxis()

◆ getOrientation()

◆ setOrientation()

◆ _autoTrack()

◆ getAutoTrackTarget()

◆ getAutoTrackOffset()

◆ setAutoTracking()

◆ getPositionForViewUpdate()

◆ getOrientationForViewUpdate()

◆ _renderScene() [1/2]

◆ _renderScene() [2/2]

◆ _notifyRenderedFaces()

◆ _notifyRenderedBatches()

◆ _getNumRenderedFaces()

◆ _getNumRenderedBatches()

◆ getDerivedOrientation()

◆ getDerivedPosition()

◆ getDerivedDirection()

◆ getDerivedUp()

◆ getDerivedRight()

◆ getRealOrientation()

◆ getRealPosition()

◆ getRealDirection()

◆ getRealUp()

◆ getRealRight()

◆ getWorldTransforms()

◆ getMovableType()

◆ setLodBias()

◆ getLodBias()

◆ setLodCamera()

◆ getLodCamera()

◆ getCameraToViewportRay() [1/2]

◆ getCameraToViewportRay() [2/2]

◆ getCameraToViewportBoxVolume() [1/2]

◆ getCameraToViewportBoxVolume() [2/2]

◆ _getLodBiasInverse()

◆ setWindow()

◆ resetWindow()

◆ isWindowSet()

◆ getWindowPlanes()

◆ getBoundingRadius()

◆ getViewport()

◆ _notifyViewport()

◆ setAutoAspectRatio()

◆ getAutoAspectRatio()

◆ setCullingFrustum()

◆ getCullingFrustum()

◆ forwardIntersect()

◆ isVisible() [1/3]

◆ isVisible() [2/3]