Ogre::OctreeCamera Class Reference

Specialized viewpoint from which an Octree can be rendered. More...

#include <OgreOctreeCamera.h>

Inheritance diagram for Ogre::OctreeCamera:

Public Types
enum	Visibility { NONE , PARTIAL , FULL }
	Visibility types. More...
Public Types inherited from Ogre::Frustum
typedef Vector3	Corners[8]
Public Types inherited from Ogre::ShadowCaster
typedef Ogre::ShadowRenderableList	ShadowRenderableList
typedef VectorIterator< ShadowRenderableList >	ShadowRenderableListIterator

Public Member Functions
	OctreeCamera (const String &name, SceneManager *sm)
	~OctreeCamera ()
OctreeCamera::Visibility	getVisibility (const AxisAlignedBox &bound)
	Returns the visibility of the box.
Public Member Functions inherited from Ogre::Camera
	Camera (const String &name, SceneManager *sm)
	Standard constructor.
virtual	~Camera ()
	Standard destructor.
void	_autoTrack (void)
	Internal method used by OGRE to update auto-tracking cameras.
Real	_getLodBiasInverse (void) const
	Internal method for OGRE to use for LOD calculations.
unsigned int	_getNumRenderedBatches (void) const
	Internal method to retrieve the number of visible batches in the last render.
unsigned int	_getNumRenderedFaces (void) const
	Internal method to retrieve the number of visible faces in the last render.
void	_notifyRenderedBatches (unsigned int numbatches)
	Internal method to notify camera of the visible batches in the last render.
void	_notifyRenderedFaces (unsigned int numfaces)
	Internal method to notify camera of the visible faces in the last render.
void	_notifyViewport (Viewport *viewport)
	Notifies this camera that a viewport is using it.
void	_renderScene (Viewport *vp)
	Tells the Camera to contact the SceneManager to render from it's viewpoint.
void	_renderScene (Viewport *vp, bool unused)
virtual void	addListener (Listener *l)
	Add a listener to this camera.
virtual void	forwardIntersect (const Plane &worldPlane, std::vector< Vector4 > *intersect3d) const
	Forward projects frustum rays to find forward intersection with plane.
bool	getAutoAspectRatio (void) const
	Retrieves if AutoAspectRatio is currently set or not.
const Vector3 &	getAutoTrackOffset (void) const
	Get the auto tracking offset for this camera, if it is auto tracking.
SceneNode *	getAutoTrackTarget (void) const
	Get the auto tracking target for this camera, if any.
Real	getBoundingRadius (void) const override
	Retrieves the radius of the origin-centered bounding sphere for this object.
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.
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.
Ray	getCameraToViewportRay (Real screenx, Real screeny) const
	Gets a world space ray as cast from the camera through a viewport position.
void	getCameraToViewportRay (Real screenx, Real screeny, Ray *outRay) const
	Gets a world space ray as cast from the camera through a viewport position.
Frustum *	getCullingFrustum (void) const
	Returns the custom culling frustum in use.
Vector3	getDerivedDirection (void) const
	Gets the derived direction vector of the camera, including any rotation inherited from a node attachment and reflection matrix.
const Quaternion &	getDerivedOrientation (void) const
	Gets the derived orientation of the camera, including any rotation inherited from a node attachment and reflection matrix.
const Vector3 &	getDerivedPosition (void) const
	Gets the derived position of the camera, including any translation inherited from a node attachment and reflection matrix.
Vector3	getDerivedRight (void) const
	Gets the derived right vector of the camera, including any rotation inherited from a node attachment and reflection matrix.
Vector3	getDerivedUp (void) const
	Gets the derived up vector of the camera, including any rotation inherited from a node attachment and reflection matrix.
Vector3	getDirection (void) const
	Gets the camera's direction.
float	getFarClipDistance (void) const override
	Retrieves the distance from the frustum to the far clipping plane.
const Plane &	getFrustumPlane (unsigned short plane) const override
	Retrieves a specified plane of the frustum (world space).
Real	getLodBias (void) const
	Returns the level-of-detail bias factor currently applied to this camera.
virtual const Camera *	getLodCamera () const
	Get a pointer to the camera which should be used to determine LOD settings.
const String &	getMovableType (void) const override
	Returns the type name of this object.
float	getNearClipDistance (void) const override
	Retrieves the distance from the frustum to the near clipping plane.
const Quaternion &	getOrientation (void) const
	Returns the camera's current orientation.
const Quaternion &	getOrientationForViewUpdate (void) const override
	Get the derived orientation of this frustum.
Real	getPixelDisplayRatio () const
	Returns an estimated ratio between a pixel and the display area it represents.
PolygonMode	getPolygonMode (void) const
	Retrieves the level of detail that the camera will render.
const Vector3 &	getPosition (void) const
	Retrieves the camera's position.
const Vector3 &	getPositionForViewUpdate (void) const override
	Get the derived position of this frustum.
Vector3	getRealDirection (void) const
	Gets the real world direction vector of the camera, including any rotation inherited from a node attachment.
const Quaternion &	getRealOrientation (void) const
	Gets the real world orientation of the camera, including any rotation inherited from a node attachment.
const Vector3 &	getRealPosition (void) const
	Gets the real world position of the camera, including any translation inherited from a node attachment.
Vector3	getRealRight (void) const
	Gets the real world right vector of the camera, including any rotation inherited from a node attachment.
Vector3	getRealUp (void) const
	Gets the real world up vector of the camera, including any rotation inherited from a node attachment.
Vector3	getRight (void) const
	Gets the camera's right vector.
SceneManager *	getSceneManager (void) const
	Returns a pointer to the SceneManager this camera is rendering through.
SortMode	getSortMode () const
	get the currently used SortMode
Vector3	getUp (void) const
	Gets the camera's up vector.
bool	getUseMinPixelSize () const
	Returns whether to use min display size calculations.
virtual bool	getUseRenderingDistance (void) const
	Get whether this camera should use the 'rendering distance' on objects to exclude distant objects from the final image.
const Affine3 &	getViewMatrix (bool ownFrustumOnly) const
	Specialised version of getViewMatrix allowing caller to differentiate whether the custom culling frustum should be allowed or not.
const Affine3 &	getViewMatrix (void) const override
	Gets the view matrix for this frustum.
Viewport *	getViewport (void) const
	Get the last viewport which was attached to this camera.
const std::vector< Plane > &	getWindowPlanes (void) const
	Gets the window clip planes, only applicable if isWindowSet == true.
const Corners &	getWorldSpaceCorners (void) const override
	Gets the world space corners of the frustum.
bool	isVisible (const AxisAlignedBox &bound, FrustumPlane *culledBy=0) const override
	Tests whether the given container is visible in the Frustum.
bool	isVisible (const Sphere &bound, FrustumPlane *culledBy=0) const override
	Tests whether the given container is visible in the Frustum.
bool	isVisible (const Vector3 &vert, FrustumPlane *culledBy=0) const override
	Tests whether the given vertex is visible in the Frustum.
virtual bool	isWindowSet (void) const
	Returns if a viewport window is being used.
void	lookAt (const Vector3 &targetPoint)
	Points the camera at a location in worldspace.
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.
void	move (const Vector3 &vec)
	Moves the camera's position by the vector offset provided along world axes.
void	moveRelative (const Vector3 &vec)
	Moves the camera's position by the vector offset provided along it's own axes (relative to orientation).
void	pitch (const Radian &angle)
	Pitches the camera up/down anticlockwise around it's local z axis.
bool	projectSphere (const Sphere &sphere, Real *left, Real *top, Real *right, Real *bottom) const override
	Project a sphere onto the near plane and get the bounding rectangle.
virtual void	removeListener (Listener *l)
	Remove a listener to this camera.
virtual void	resetWindow (void)
	Cancel view window.
void	roll (const Radian &angle)
	Rolls the camera anticlockwise, around its local z axis.
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.
void	rotate (const Vector3 &axis, const Radian &angle)
	Rotate the camera around an arbitrary axis.
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.
void	setAutoTracking (bool enabled, SceneNode *const target=0, const Vector3 &offset=Vector3::ZERO)
	Enables / disables automatic tracking of a SceneNode.
void	setCullingFrustum (Frustum *frustum)
	Tells the camera to use a separate Frustum instance to perform culling.
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.
void	setDirection (Real x, Real y, Real z)
	Sets the camera's direction vector.
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.
void	setLodBias (Real factor=1.0)
	Sets the level-of-detail factor for this Camera.
virtual void	setLodCamera (const Camera *lodCam)
	Set a pointer to the camera which should be used to determine LOD settings.
void	setOrientation (const Quaternion &q)
	Sets the camera's orientation.
void	setPolygonMode (PolygonMode sd)
	Sets the level of rendering detail required from this camera.
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.
void	setPosition (Real x, Real y, Real z)
	Sets the camera's position.
void	setSortMode (SortMode sm)
	Set the function used to compute the camera-distance for sorting Renderables.
void	setUseMinPixelSize (bool enable)
	Sets whether to use min display size calculations.
virtual void	setUseRenderingDistance (bool use)
	Set whether this camera should use the 'rendering distance' on objects to exclude distant objects from the final image.
virtual void	setWindow (Real left, Real top, Real right, Real bottom)
	Sets the viewing window inside of viewport.
virtual void	synchroniseBaseSettingsWith (const Camera *cam)
	Synchronise core camera settings with another.
void	yaw (const Radian &angle)
	Rotates the camera anticlockwise around it's local y axis.
Public Member Functions inherited from Ogre::Frustum
	Frustum (const String &name=BLANKSTRING)
	Named constructor.
virtual	~Frustum ()
void	_notifyCurrentCamera (Camera *cam) override
	Internal method to notify the object of the camera to be used for the next rendering operation.
void	_updateRenderQueue (RenderQueue *queue) override
	Internal method by which the movable object must add Renderable subclass instances to the rendering queue.
void	calcViewMatrixRelative (const Vector3 &relPos, Matrix4 &matToUpdate) const
	Calculate a view matrix for this frustum, relative to a potentially dynamic point.
void	disableCustomNearClipPlane (void)
	Disables any custom near clip plane.
void	disableReflection (void)
	Disables reflection modification previously turned on with enableReflection.
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.
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.
void	enableReflection (const MovablePlane *p)
	Modifies this frustum so it always renders from the reflection of itself through the plane specified.
void	enableReflection (const Plane &p)
	Modifies this frustum so it always renders from the reflection of itself through the plane specified.
Real	getAspectRatio (void) const
	Retrieves the current aspect ratio.
const AxisAlignedBox &	getBoundingBox (void) const override
	Retrieves the local axis-aligned bounding box for this object.
Real	getBoundingRadius (void) const override
	Retrieves the radius of the origin-centered bounding sphere for this object.
const ColourValue &	getDebugColour () const
Real	getFocalLength () const
	Returns focal length of frustum.
const Radian &	getFOVy (void) const
	Retrieves the frustums Y-dimension Field Of View (FOV).
RealRect	getFrustumExtents () const
	Get the extents of the frustum in view space.
const Vector2 &	getFrustumOffset () const
	Retrieves the frustum offsets.
virtual const Plane *	getFrustumPlanes (void) const
	Retrieves the clipping planes of the frustum (world space).
const String &	getMovableType (void) const override
	Returns the type name of this object.
Real	getOrthoWindowHeight () const
	Gets the orthographic window height, for use with orthographic rendering only.
Real	getOrthoWindowWidth () const
	Gets the orthographic window width, for use with orthographic rendering only.
PlaneBoundedVolume	getPlaneBoundedVolume ()
	Gets a world-space list of planes enclosing the frustum.
const Matrix4 &	getProjectionMatrix (void) const
	Gets the normal projection matrix for this frustum.
const Matrix4 &	getProjectionMatrixWithRSDepth (void) const
	Gets the depth-adjusted projection matrix for the current rendersystem.
ProjectionType	getProjectionType (void) const
	Retrieves info on the type of projection used (orthographic or perspective).
const Affine3 &	getReflectionMatrix (void) const
	Returns the reflection matrix of the frustum if appropriate.
const Plane &	getReflectionPlane (void) const
	Returns the reflection plane of the frustum if appropriate.
uint32	getTypeFlags (void) const override
	Get the 'type flags' for this MovableObject.
bool	isCustomNearClipPlaneEnabled (void) const
	Is a custom near clip plane in use?
bool	isCustomProjectionMatrixEnabled (void) const
	Returns whether a custom projection matrix is in use.
bool	isCustomViewMatrixEnabled (void) const
	Returns whether a custom view matrix is in use.
bool	isReflected (void) const
	Returns whether this frustum is being reflected.
void	resetFrustumExtents ()
	Reset the frustum extents to be automatically derived from other params.
void	setAspectRatio (Real ratio)
	Sets the aspect ratio for the frustum viewport.
void	setCustomProjectionMatrix (bool enable, const Matrix4 &projectionMatrix=Matrix4::IDENTITY)
	Set whether to use a custom projection matrix on this frustum.
void	setCustomViewMatrix (bool enable, const Affine3 &viewMatrix=Affine3::IDENTITY)
	Set whether to use a custom view matrix on this frustum.
void	setDebugColour (const ColourValue &col)
void	setFarClipDistance (float farDist)
	Sets the distance to the far clipping plane.
void	setFocalLength (Real focalLength=1.0)
	Sets frustum focal length (used in stereo rendering).
void	setFOVy (const Radian &fovy)
	Sets the Y-dimension Field Of View (FOV) of the frustum.
void	setFrustumExtents (Real left, Real right, Real top, Real bottom)
	Manually set the extents of the frustum.
void	setFrustumOffset (const Vector2 &offset)
	Sets frustum offsets, used in stereo rendering.
void	setFrustumOffset (Real horizontal=0.0, Real vertical=0.0)
	Sets frustum offsets, used in stereo rendering.
void	setNearClipDistance (float nearDist)
	Sets the position of the near clipping plane.
void	setOrthoWindow (Real w, Real h)
	Sets the orthographic window settings, for use with orthographic rendering only.
void	setOrthoWindowHeight (Real h)
	Sets the orthographic window height, for use with orthographic rendering only.
void	setOrthoWindowWidth (Real w)
	Sets the orthographic window width, for use with orthographic rendering only.
virtual void	setProjectionType (ProjectionType pt)
	Sets the type of projection to use (orthographic or perspective).
void	visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false) override
	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.
Public Member Functions inherited from Ogre::MovableObject
	MovableObject ()
	Constructor.
	MovableObject (const String &name)
	Named constructor.
virtual	~MovableObject ()
	Virtual destructor - read Scott Meyers if you don't know why this is needed.
MovableObjectFactory *	_getCreator (void) const
	Get the creator of this object, if any (internal use only)
LightList *	_getLightList ()
	Returns a pointer to the current list of lights for this object.
SceneManager *	_getManager (void) const
	Get the manager of this object, if any (internal use only)
virtual const Affine3 &	_getParentNodeFullTransform (void) const
	Return the full transformation of the parent sceneNode or the attachingPoint node.
virtual void	_notifyAttached (Node *parent, bool isTagPoint=false)
	Internal method called to notify the object that it has been attached to a node.
virtual void	_notifyCreator (MovableObjectFactory *fact)
	Notify the object of it's creator (internal use only)
virtual void	_notifyManager (SceneManager *man)
	Notify the object of it's manager (internal use only)
virtual void	_notifyMoved (void)
	Internal method called to notify the object that it has been moved.
virtual void	_releaseManualHardwareResources ()
	Notifies the movable object that hardware resources were lost.
virtual void	_restoreManualHardwareResources ()
	Notifies the movable object that hardware resources should be restored.
void	addQueryFlags (uint32 flags)
	As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.
void	addVisibilityFlags (uint32 flags)
	As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object.
void	detachFromParent (void)
	Detaches an object from a parent SceneNode or TagPoint, if attached.
Real	getBoundingRadiusScaled () const
	as getBoundingRadius, but with scaling applied
bool	getCastShadows (void) const override
	Returns whether shadow casting is enabled for this object.
uint32	getLightMask () const
	Get a bitwise mask which will filter the lights affecting this object.
Listener *	getListener (void) const
	Gets the current listener for this object.
const String &	getName (void) const
	Returns the name of this object.
Node *	getParentNode (void) const
	Returns the node to which this object is attached.
SceneNode *	getParentSceneNode (void) const
	Returns the scene node to which this object is attached.
Real	getPointExtrusionDistance (const Light *l) const override
	Get the distance to extrude for a point/spot light.
virtual uint32	getQueryFlags (void) const
	Returns the query flags relevant for this object.
bool	getReceivesShadows ()
	Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows.
Real	getRenderingDistance (void) const
	Gets the distance at which batches are no longer rendered.
Real	getRenderingMinPixelSize () const
	Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered.
uint8	getRenderQueueGroup (void) const
	Gets the queue group for this entity.
const Any &	getUserAny (void) const
UserObjectBindings &	getUserObjectBindings ()
	Class that provides convenient interface to establish a linkage between custom user application objects and Ogre core classes.
const UserObjectBindings &	getUserObjectBindings () const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
virtual uint32	getVisibilityFlags (void) const
	Returns the visibility flags relevant for this object.
bool	getVisible (void) const
	Gets this object whether to be visible or not, if it has a renderable component.
const AxisAlignedBox &	getWorldBoundingBox (bool derive=false) const override
	Retrieves the axis-aligned bounding box for this object in world coordinates.
virtual const Sphere &	getWorldBoundingSphere (bool derive=false) const
	Retrieves the worldspace bounding sphere for this object.
bool	isAttached (void) const
	Returns true if this object is attached to a SceneNode or TagPoint.
bool	isDebugDisplayEnabled (void) const
	Gets whether debug display of this object is enabled.
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.
bool	isParentTagPoint () const
	Gets whether the parent node is a TagPoint (or a SceneNode)
virtual bool	isVisible (void) const
	Returns whether or not this object is supposed to be visible or not.
const LightList &	queryLights (void) const
	Gets a list of lights, ordered relative to how close they are to this movable object.
void	removeQueryFlags (uint32 flags)
	As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.
void	removeVisibilityFlags (uint32 flags)
	As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object.
void	setCastShadows (bool enabled)
	Sets whether or not this object will cast shadows.
void	setDebugDisplayEnabled (bool enabled)
	Sets whether or not the debug display of this object is enabled.
void	setLightMask (uint32 lightMask)
	Set a bitwise mask which will filter the lights affecting this object.
void	setListener (Listener *listener)
	Sets a listener for this object.
void	setQueryFlags (uint32 flags)
	Sets the query flags for this object.
void	setRenderingDistance (Real dist)
	Sets the distance at which the object is no longer rendered.
void	setRenderingMinPixelSize (Real pixelSize)
	Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered.
virtual void	setRenderQueueGroup (uint8 queueID)
	Sets the render queue group this entity will be rendered through.
virtual void	setRenderQueueGroupAndPriority (uint8 queueID, ushort priority)
	Sets the render queue group and group priority this entity will be rendered through.
void	setUserAny (const Any &anything)
void	setVisibilityFlags (uint32 flags)
	Sets the visibility flags for this object.
void	setVisible (bool visible)
	Tells this object whether to be visible or not, if it has a renderable component.
Public Member Functions inherited from Ogre::ShadowCaster
virtual	~ShadowCaster ()
const AxisAlignedBox &	getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const
	Gets the world space bounding box of the dark cap, as extruded using the light provided.
virtual EdgeData *	getEdgeList (void)
	Returns details of the edges which might be used to determine a silhouette.
const AxisAlignedBox &	getLightCapBounds (void) const
	Gets the world space bounding box of the light cap.
virtual const ShadowRenderableList &	getShadowVolumeRenderableList (const Light *light, const HardwareIndexBufferPtr &indexBuffer, size_t &indexBufferUsedSize, float extrusionDistance, int flags=0)
	Gets an list of the renderables required to render the shadow volume.
bool	hasEdgeList ()
	Returns whether the object has a valid edge list.
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.
virtual const StringVector &	getAnimableValueNames (void) const
	Gets a list of animable value names for this object.

Additional Inherited Members
Static Public Member Functions inherited from Ogre::MovableObject
static uint32	getDefaultQueryFlags ()
	Get the default query flags for all future MovableObject instances.
static uint32	getDefaultVisibilityFlags ()
	Get the default visibility flags for all future MovableObject instances.
static void	setDefaultQueryFlags (uint32 flags)
	Set the default query flags for all future MovableObject instances.
static void	setDefaultVisibilityFlags (uint32 flags)
	Set the default visibility flags for all future MovableObject instances.
Static Public Member Functions inherited from Ogre::ShadowCaster
static void	clearShadowRenderableList (ShadowRenderableList &shadowRenderables)
	Common implementation of releasing shadow renderables.
static void	extrudeVertices (const HardwareVertexBufferSharedPtr &vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist)
	Utility method for extruding vertices based on a light.
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.

Detailed Description

Specialized viewpoint from which an Octree can be rendered.

This class contains several specializations of the Ogre::Camera class. It implements the getRenderOperation method in order to return displayable geometry for debugging purposes. It also implements a visibility function that is more granular than the default.

Member Enumeration Documentation

Visibility

enum Ogre::OctreeCamera::Visibility

Visibility types.

Enumerator
NONE
PARTIAL
FULL

Constructor & Destructor Documentation

OctreeCamera()

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

~OctreeCamera()

Ogre::OctreeCamera::~OctreeCamera

(

)

Member Function Documentation

getVisibility()

OctreeCamera::Visibility Ogre::OctreeCamera::getVisibility

(

const AxisAlignedBox &

bound

)

Returns the visibility of the box.

---

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

• OgreOctreeCamera.h