OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::OctreeCamera Class Reference

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

#include <OgreOctreeCamera.h>

+ Inheritance diagram for Ogre::OctreeCamera:
+ Collaboration diagram for Ogre::OctreeCamera:

Public Types

typedef FastArray
< MovableObject * > 
MovableObjectArray
 SceneManager::cullFrustum More...
 
enum  Visibility { NONE, PARTIAL, FULL }
 Visibility types. More...
 

Public Member Functions

 OctreeCamera (const String &name, SceneManager *sm)
 
 ~OctreeCamera ()
 
void _autoTrack (void)
 Internal method used by OGRE to update auto-tracking cameras. More...
 
void _cullScenePhase01 (const Camera *lodCamera, Viewport *vp, uint8 firstRq, uint8 lastRq)
 Tells the Camera to contact the SceneManager to render from it's viewpoint. More...
 
const Vector3_getCachedDerivedPosition (void) const
 Same as getDerivedPosition, but doesn't check if dirty. More...
 
const Plane_getCachedFrustumPlanes (void) const
 Returns the frustum planes, doesn't check if dirty. More...
 
LightList_getLightList ()
 Returns a pointer to the current list of lights for this object. More...
 
Real _getLodBiasInverse (void) const
 Internal method for OGRE to use for LOD calculations. More...
 
SceneManager_getManager (void) const
 Get the manager of this object, if any (internal use only) More...
 
unsigned int _getNumRenderedBatches (void) const
 Internal method to retrieve the number of visible batches in the last render. More...
 
unsigned int _getNumRenderedFaces (void) const
 Internal method to retrieve the number of visible faces in the last render. More...
 
ObjectData_getObjectData ()
 Returns a direct access to the ObjectData state. More...
 
const Matrix4_getParentNodeFullTransform (void) const
 Returns the full transformation of the parent sceneNode or the attachingPoint node. More...
 
virtual void _notifyAttached (Node *parent)
 Internal method called to notify the object that it has been attached to a node. More...
 
void _notifyCurrentCamera (Camera *cam)
 Overridden from MovableObject. More...
 
void _notifyManager (SceneManager *man)
 Notify the object of it's manager (internal use only) More...
 
virtual void _notifyParentNodeMemoryChanged (void)
 Node::_callMemoryChangeListeners 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...
 
virtual void _notifyStaticDirty (void) const
 Called by SceneManager when it is telling we're a static MovableObject being dirty Don't call this directly. More...
 
void _notifyViewport (Viewport *viewport)
 Notifies this camera that a viewport is using it. More...
 
void _renderScenePhase02 (const Camera *lodCamera, Viewport *vp, uint8 firstRq, uint8 lastRq, bool includeOverlays)
 
void _resetRenderedRqs (size_t numRqs)
 Called at the beginning of each frame to know which RenderQueue IDs have been rendered. More...
 
void _setCachedAabbOutOfDate (void)
 
void _setRenderedRqs (size_t rqStart, size_t rqEnd)
 Tells the camera that render queues in the range [rqStart; rqEnd) were rendered. 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, Camera *camera, const Camera *lodCamera)
 Overridden from MovableObject. More...
 
virtual void addListener (Listener *l)
 Add a listener to this camera. 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...
 
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...
 
void detachFromParent (void)
 Detaches an object from a parent SceneNode 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 StringVectorgetAnimableValueNames (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 Vector3getAutoTrackOffset (void) const
 Get the auto tracking offset for this camera, if it is auto tracking. More...
 
SceneNodegetAutoTrackTarget (void) const
 Get the auto tracking target for this camera, if any. More...
 
const AxisAlignedBoxgetBoundingBox (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...
 
FrustumgetCullingFrustum (void) const
 Returns the custom culling frustum in use. More...
 
const FastArray< unsigned char > & getCurrentMaterialLod (void) const
 
const Vector4getCustomParameter (size_t index) const
 Gets the custom value associated with this Renderable at the given index. More...
 
void getCustomWorldSpaceCorners (ArrayVector3 outCorners[(8+ARRAY_PACKED_REALS-1)/ARRAY_PACKED_REALS], Real customFarPlane) const
 
Vector3 getDerivedDirection (void) const
 Gets the derived direction vector of the camera, including any rotation inherited from a node attachment and reflection matrix. More...
 
const QuaterniongetDerivedOrientation (void) const
 Gets the derived orientation of the camera, including any rotation inherited from a node attachment and reflection matrix. More...
 
const Vector3getDerivedPosition (void) const
 Gets the derived position of the camera, including any translation inherited from a node attachment and reflection matrix. More...
 
Vector3 getDerivedRight (void) const
 Gets the derived right vector of the camera, including any rotation inherited from a node attachment and reflection matrix. More...
 
Vector3 getDerivedUp (void) const
 Gets the derived up vector of the camera, including any rotation inherited from a node attachment and reflection matrix. More...
 
Vector3 getDirection (void) const
 Gets the camera's direction. More...
 
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 RadiangetFOVy (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 Vector2getFrustumOffset () const
 Retrieves the frustum offsets. More...
 
const PlanegetFrustumPlane (unsigned short plane) const
 Retrieves a specified plane of the frustum (world space). More...
 
virtual const PlanegetFrustumPlanes (void) const
 Retrieves the clipping planes of the frustum (world space). More...
 
uint32 getHlmsCasterHash (void) const
 
uint32 getHlmsHash (void) const
 
IdType getId () const
 Get the unique id of this object. More...
 
ViewportgetLastViewport (void) const
 Get the last viewport which was attached to this camera. More...
 
uint32 getLightMask () const
 Get a bitwise mask which will filter the lights affecting this object. More...
 
const LightListgetLights (void) const
 Overridden from Renderable. More...
 
ListenergetListener (void) const
 Gets the current listener for this object. More...
 
Aabb getLocalAabb (void) const
 Retrieves the local axis-aligned bounding box for this object. More...
 
Real getLodBias (void) const
 Returns the level-of-detail bias factor currently applied to this camera. More...
 
virtual const CameragetLodCamera () const
 Get a pointer to the camera which should be used to determine LOD settings. More...
 
const MaterialPtrgetMaterial (void) const
 Overridden from Renderable. More...
 
const StringgetMovableType (void) const
 Overridden from MovableObject. More...
 
const StringgetName (void) const
 Returns the name of this object. More...
 
Real getNearClipDistance (void) const
 Sets the position of the near clipping plane. More...
 
virtual unsigned short getNumWorldTransforms (void) const
 Returns the number of world transform matrices this renderable requires. More...
 
const QuaterniongetOrientation (void) const
 Returns the camera's current orientation. More...
 
const QuaterniongetOrientationForViewUpdate (void) const
 Get the derived orientation of this frustum. More...
 
OrientationMode getOrientationMode () const
 Get the orientation mode of the frustum. More...
 
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...
 
NodegetParentNode (void) const
 Returns the node to which this object is attached. More...
 
SceneNodegetParentSceneNode (void) const
 
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...
 
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 Vector3getPosition (void) const
 Retrieves the camera's position. More...
 
const Vector3getPositionForViewUpdate (void) const
 Get the derived position of this frustum. More...
 
virtual const Matrix4getProjectionMatrix (void) const
 Gets the normal projection matrix for this frustum, ie the projection matrix which conforms to standard right-handed rules and uses depth range [-1,+1]. More...
 
virtual const Matrix4getProjectionMatrixRS (void) const
 Gets the projection matrix for this frustum adjusted for the current rendersystem specifics (may be right or left-handed, depth range may vary). More...
 
virtual const Matrix4getProjectionMatrixWithRSDepth (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...
 
uint32 getQueryFlags (void) const
 Returns the query flags relevant for this object. More...
 
Vector3 getRealDirection (void) const
 Gets the real world direction vector of the camera, including any rotation inherited from a node attachment. More...
 
const QuaterniongetRealOrientation (void) const
 Gets the real world orientation of the camera, including any rotation inherited from a node attachment. More...
 
const Vector3getRealPosition (void) const
 Gets the real world position of the camera, including any translation inherited from a node attachment. More...
 
Vector3 getRealRight (void) const
 Gets the real world right vector of the camera, including any rotation inherited from a node attachment. More...
 
Vector3 getRealUp (void) const
 Gets the real world up vector of the camera, including any rotation inherited from a node attachment. More...
 
bool getReceivesShadows ()
 Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows. More...
 
virtual const Matrix4getReflectionMatrix (void) const
 Returns the reflection matrix of the frustum if appropriate. More...
 
virtual const PlanegetReflectionPlane (void) const
 Returns the reflection plane of the frustum if appropriate. More...
 
Real getRenderingDistance (void) const
 Gets the distance at which batches are no longer rendered. More...
 
Real getRenderingMinPixelSize () const
 Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered. More...
 
void getRenderOperation (RenderOperation &op)
 Overridden from Renderable. More...
 
uint8 getRenderQueueGroup (void) const
 Gets the queue group for this entity, see setRenderQueueGroup for full details. More...
 
virtual RenderSystemDatagetRenderSystemData () const
 Gets RenderSystem private data. More...
 
Vector3 getRight (void) const
 Gets the camera's right vector. More...
 
SceneManagergetSceneManager (void) const
 Returns a pointer to the SceneManager this camera is rendering through. More...
 
Real getSquaredViewDepth (const Camera *cam) const
 Overridden from Renderable. More...
 
virtual TechniquegetTechnique (void) const
 Retrieves a pointer to the Material Technique this renderable object uses. More...
 
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 AnygetUserAny (void) const
 
virtual bool getUseRenderingDistance (void) const
 Get whether this camera should use the 'rendering distance' on objects to exclude distant objects from the final image. More...
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
UserObjectBindingsgetUserObjectBindings ()
 Return an instance of user objects binding associated with this class. More...
 
const UserObjectBindingsgetUserObjectBindings () const
 Return an instance of user objects binding associated with this class. More...
 
const Matrix4getViewMatrix (void) const
 Gets the view matrix for this frustum. More...
 
const Matrix4getViewMatrix (bool ownFrustumOnly) const
 Specialised version of getViewMatrix allowing caller to differentiate whether the custom culling frustum should be allowed or not. More...
 
OctreeCamera::Visibility getVisibility (const AxisAlignedBox &bound)
 Returns the visibility of the box. More...
 
uint32 getVisibilityFlags (void) const
 Returns the visibility flags relevant for this object. More...
 
bool getVisible (void) const
 Gets this object whether to be visible or not, if it has a renderable component. More...
 
const vector< Plane >::type & getWindowPlanes (void) const
 Gets the window clip planes, only applicable if isWindowSet == true. More...
 
Aabb getWorldAabb () const
 Gets the axis aligned box in world space. More...
 
Aabb getWorldAabbUpdated ()
 Gets the axis aligned box in world space. More...
 
float getWorldRadius () const
 Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ). More...
 
float getWorldRadiusUpdated ()
 Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ). More...
 
const Vector3getWorldSpaceCorners (void) const
 Gets the world space corners of the frustum. More...
 
void getWorldTransforms (Matrix4 *mat) const
 Overridden from Frustum/Renderable. More...
 
bool hasCustomParameter (size_t index) const
 Checks whether a custom value is associated with this Renderable at the given index. More...
 
virtual void instanceBatchCullFrustumThreaded (const Frustum *frustum, const Camera *lodCamera, uint32 combinedVisibilityFlags)
 InstancingTheadedCullingMethod, More...
 
bool isAttached (void) const
 Returns true if this object is attached to a Node. More...
 
bool isCachedAabbOutOfDate () const
 
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 isReflected (void) const
 Returns whether this frustum is being reflected. More...
 
bool isRenderedRq (size_t rqId) const
 Returns true if the asked render queue has been rendered. False otherwise. More...
 
bool isStatic () const
 Checks whether this MovableObject is static. setStatic. More...
 
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)
 
bool operator() (const IdObject *left, const IdObject *right)
 
bool operator() (const IdObject &left, const IdObject &right)
 
void pitch (const Radian &angle)
 Pitches the camera up/down anticlockwise around it's local z axis. More...
 
virtual void postRender (SceneManager *sm, RenderSystem *rsys)
 Called immediately after the Renderable has been rendered. More...
 
virtual bool preRender (SceneManager *sm, RenderSystem *rsys)
 Called just prior to the Renderable being rendered. More...
 
bool projectSphere (const Sphere &sphere, Real *left, Real *top, Real *right, Real *bottom) const
 Project a sphere onto the near plane and get the bounding rectangle. More...
 
const LightListqueryLights (void) const
 Gets a list of lights, ordered relative to how close they are to this movable object. More...
 
void removeCustomParameter (size_t index)
 Removes a custom value which is associated with this Renderable at the given index. More...
 
virtual void removeListener (Listener *l)
 Remove a listener to this camera. More...
 
void 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...
 
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...
 
void setHlms (Hlms *hlms, const HlmsParamVec &params)
 
void setLightMask (uint32 lightMask)
 Set a bitwise mask which will filter the lights affecting this object. More...
 
void setListener (Listener *listener)
 Sets a listener for this object. More...
 
void setLocalAabb (const Aabb box)
 Sets the local axis-aligned bounding box for this object. More...
 
void 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 setName (const String &name)
 Sets a custom name for this node. 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...
 
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...
 
virtual void setRenderSystemData (RenderSystemData *val) const
 Sets RenderSystem private data. More...
 
bool setStatic (bool bStatic)
 Turns this Node into static or dynamic. 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 void setUseRenderingDistance (bool use)
 Set whether this camera should use the 'rendering distance' on objects to exclude distant objects from the final image. More...
 
void setVisibilityFlags (uint32 flags)
 Sets the visibility flags for this object. More...
 
void setVisible (bool visible)
 Tells this object whether to be visible or not, if it has a renderable component. More...
 
virtual void setWindow (Real left, Real top, Real right, Real bottom)
 Sets the viewing window inside of viewport. More...
 
virtual void synchroniseBaseSettingsWith (const Camera *cam)
 Synchronise core camera settings with another. More...
 
void 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 buildLightList (const size_t numNodes, ObjectData t, const LightListInfo &globalLightList)
 SceneManager::buildLightList More...
 
static void calculateCastersBox (const size_t numNodes, ObjectData t, uint32 sceneVisibilityFlags, AxisAlignedBox *outBox)
 
static void cullFrustum (const size_t numNodes, ObjectData t, const Frustum *frustum, uint32 sceneVisibilityFlags, MovableObjectArray &outCulledObjects, const Camera *lodCamera)
 
static void cullLights (const size_t numNodes, ObjectData t, LightListInfo &outGlobalLightList, const FrustumVec &frustums, const FrustumVec &cubemapFrustums)
 SceneManager::cullLights & 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 void updateAllBounds (const size_t numNodes, ObjectData t)
 SceneManager::updateAllBounds More...
 

Public Attributes

const FastArray< Realc_DefaultLodMesh
 
size_t mGlobalIndex
 Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks). More...
 
size_t mParentIndex
 Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks). 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...
 
void _setId (IdType newId)
 In the rare case our derived class wants to override our Id (normally we don't want that, that's why it's private). 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 const StringgetAnimableDictionaryName (void) const
 Get the name of the animable dictionary for this class. 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 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...
 
Aabb updateSingleWorldAabb ()
 
float updateSingleWorldRadius ()
 
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...
 
SceneNodemAutoTrackTarget
 SceneNode which this Camera will automatically track. More...
 
Real mBottom
 
AxisAlignedBox mBoundingBox
 
bool mCachedAabbOutOfDate
 
FrustummCullFrustum
 Custom culling frustum. More...
 
FastArray< unsigned char > mCurrentMaterialLod
 
unsigned char mCurrentMeshLod
 
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...
 
uint32 mHlmsCasterHash
 
uint32 mHlmsHash
 
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
 
ViewportmLastViewport
 The last viewport to be added using this camera. More...
 
Real mLeft
 Frustum extents. More...
 
LightList mLightList
 List of lights for this object. More...
 
const MovablePlanemLinkedObliqueProjPlane
 Pointer to oblique projection plane (automatically updated) More...
 
const MovablePlanemLinkedReflectPlane
 Pointer to a reflection plane (automatically updated) More...
 
ListenermListener
 MovableObject listener - only one allowed (no list) for size & performance reasons. More...
 
ListenerList mListeners
 
const CameramLodCamera
 Camera to use for LOD calculation. More...
 
FastArray< FastArray< Real >
const * > 
mLodMaterial
 
FastArray< Real > const * mLodMesh
 
SceneManagermManager
 SceneManager holding this object (if applicable) More...
 
MaterialPtr mMaterial
 
Real mMinPixelSize
 Minimum pixel size to still render. More...
 
String mName
 Friendly name of this object, can be empty. More...
 
Real mNearDist
 Near clip distance - default 100. More...
 
ObjectData mObjectData
 All the object data needed in SoA form. More...
 
ObjectMemoryManagermObjectMemoryManager
 The memory manager used to allocate the ObjectData. 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...
 
NodemParentNode
 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...
 
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...
 
vector< bool >::type mRenderedRqs
 Each frame it is set to all false. After rendering each RQ, it is set to true. More...
 
uint8 mRenderQueueID
 The render queue to use when rendering this object. More...
 
ushort mRenderQueuePriority
 The render queue group to use when rendering this object. More...
 
RenderSystemDatamRenderSystemData
 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...
 
SceneManagermSceneMgr
 Scene manager responsible for the scene. More...
 
Real mTop
 
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...
 
Real mWBottom
 
vector< Plane >::type mWindowClipPlanes
 Windowed viewport clip planes. More...
 
bool mWindowSet
 Is viewing window used. More...
 
Real mWLeft
 Viewing window. 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...
 

Detailed Description

Specialized viewpoint from which an Octree can be rendered.

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

Definition at line 58 of file OgreOctreeCamera.h.

Member Typedef Documentation

Definition at line 237 of file OgreAnimable.h.

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

Definition at line 422 of file OgreRenderable.h.

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

Definition at line 183 of file OgreCamera.h.

SceneManager::cullFrustum

Remarks
We don't pass by reference on purpose (avoid implicit aliasing) We perform frustum culling AND test visibility mask at the same time
Parameters
frustumFrustum to clip against
sceneVisibilityFlagsCombined scene's visibility flags (i.e. viewport | scene). Set LAYER_SHADOW_CASTER bit if you want to exclude non-shadow casters.
outCulledObjectsOut. List of objects that are (fully or partially) inside the frustum and should be rendered
lodCameraCamera in which lod levels calculations are based (i.e. during shadow pass renders) Note however, we only use this camera to calulate if should be visible according to mUpperDistance

Definition at line 244 of file OgreMovableObject.h.

Member Enumeration Documentation

Visibility types.

Enumerator
NONE 
PARTIAL 
FULL 

Definition at line 63 of file OgreOctreeCamera.h.

Constructor & Destructor Documentation

Ogre::OctreeCamera::OctreeCamera ( const String name,
SceneManager sm 
)
Ogre::OctreeCamera::~OctreeCamera ( )

Member Function Documentation

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

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

void Ogre::Camera::_cullScenePhase01 ( const Camera lodCamera,
Viewport vp,
uint8  firstRq,
uint8  lastRq 
)
inherited

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

Parameters
vpThe viewport to render to
includeOverlaysWhether or not any overlay objects should be included
firstRqFirst RenderQueue ID to render (inclusive)
lastRqLast RenderQueue ID to render (exclusive)
StringVector& Ogre::AnimableObject::_getAnimableValueNames ( void  )
inlineprotectedinherited

Get an updateable reference to animable value list.

Definition at line 263 of file OgreAnimable.h.

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

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

Same as getDerivedPosition, but doesn't check if dirty.

Definition at line 401 of file OgreCamera.h.

const Plane* Ogre::Frustum::_getCachedFrustumPlanes ( void  ) const
inlineinherited

Returns the frustum planes, doesn't check if dirty.

Definition at line 427 of file OgreFrustum.h.

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

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

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

Definition at line 534 of file OgreMovableObject.h.

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

Internal method for OGRE to use for LOD calculations.

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

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

Definition at line 160 of file OgreMovableObject.h.

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

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

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

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

ObjectData& Ogre::MovableObject::_getObjectData ( )
inlineinherited

Returns a direct access to the ObjectData state.

Definition at line 387 of file OgreMovableObject.h.

const Matrix4& Ogre::MovableObject::_getParentNodeFullTransform ( void  ) const
inherited

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

virtual void Ogre::MovableObject::_notifyAttached ( Node parent)
virtualinherited

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

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

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

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

Overridden from MovableObject.

void Ogre::MovableObject::_notifyManager ( SceneManager man)
inlineinherited

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

Definition at line 158 of file OgreMovableObject.h.

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

Node::_callMemoryChangeListeners

Reimplemented in Ogre::InstancedEntity.

Definition at line 187 of file OgreMovableObject.h.

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

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

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

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

virtual void Ogre::MovableObject::_notifyStaticDirty ( void  ) const
inlinevirtualinherited

Called by SceneManager when it is telling we're a static MovableObject being dirty Don't call this directly.

See also
SceneManager::notifyStaticDirty

Reimplemented in Ogre::InstancedEntity.

Definition at line 212 of file OgreMovableObject.h.

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

Notifies this camera that a viewport is using it.

Definition at line 571 of file OgreCamera.h.

void Ogre::Camera::_renderScenePhase02 ( const Camera lodCamera,
Viewport vp,
uint8  firstRq,
uint8  lastRq,
bool  includeOverlays 
)
inherited
void Ogre::Camera::_resetRenderedRqs ( size_t  numRqs)
inherited

Called at the beginning of each frame to know which RenderQueue IDs have been rendered.

Parameters
numRqsMax number of total possible render queues in this frame
void Ogre::MovableObject::_setCachedAabbOutOfDate ( void  )
inlineinherited

Definition at line 586 of file OgreMovableObject.h.

void Ogre::IdObject::_setId ( IdType  newId)
inlineprotectedinherited

In the rare case our derived class wants to override our Id (normally we don't want that, that's why it's private).

Definition at line 63 of file OgreId.h.

void Ogre::Camera::_setRenderedRqs ( size_t  rqStart,
size_t  rqEnd 
)
inherited

Tells the camera that render queues in the range [rqStart; rqEnd) were rendered.

Remarks
This function may be called before having been actually rendered (i.e. during the culling phase 01)
Parameters
rqStartThe first render queue in the range to be rendered. Inclusive.
rqEndNext to last render queue id to be rendered. Must be below or equal than the value passed to
See also
_resetRenderedRqs
virtual void Ogre::Renderable::_updateCustomGpuParameter ( const GpuProgramParameters::AutoConstantEntry constantEntry,
GpuProgramParameters params 
) const
inlinevirtualinherited

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

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

Reimplemented in Ogre::SubEntity.

Definition at line 308 of file OgreRenderable.h.

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

void Ogre::Frustum::_updateRenderQueue ( RenderQueue queue,
Camera camera,
const Camera lodCamera 
)
virtualinherited

Overridden from MovableObject.

Implements Ogre::MovableObject.

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

Add a listener to this camera.

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

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

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

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

static void Ogre::MovableObject::buildLightList ( const size_t  numNodes,
ObjectData  t,
const LightListInfo globalLightList 
)
staticinherited

SceneManager::buildLightList

Remarks
We don't pass by reference on purpose (avoid implicit aliasing)
Parameters
globalLightListList of lights already culled against all possible frustums and reorganized contiguously for SoA
virtual void Ogre::Frustum::calcProjectionParameters ( Real left,
Real right,
Real bottom,
Real top 
) const
protectedvirtualinherited
static void Ogre::MovableObject::calculateCastersBox ( const size_t  numNodes,
ObjectData  t,
uint32  sceneVisibilityFlags,
AxisAlignedBox outBox 
)
staticinherited
virtual void Ogre::Frustum::calcViewMatrixRelative ( const Vector3 relPos,
Matrix4 matToUpdate 
) const
virtualinherited

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)

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

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

Definition at line 250 of file OgreAnimable.h.

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

Create a reference-counted AnimableValuePtr for the named value.

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

Reimplemented in Ogre::Light.

Definition at line 316 of file OgreAnimable.h.

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

static void Ogre::MovableObject::cullFrustum ( const size_t  numNodes,
ObjectData  t,
const Frustum frustum,
uint32  sceneVisibilityFlags,
MovableObjectArray outCulledObjects,
const Camera lodCamera 
)
staticinherited
static void Ogre::MovableObject::cullLights ( const size_t  numNodes,
ObjectData  t,
LightListInfo outGlobalLightList,
const FrustumVec frustums,
const FrustumVec cubemapFrustums 
)
staticinherited

SceneManager::cullLights &

See also
MovableObject::cullFrustum Produces the global list of visible lights that is needed in buildLightList
Remarks
We don't pass ObjectData by reference on purpose (avoid implicit aliasing) It's declared here because all affected elements are from MovableObject IMPORTANT: It is assumed that all objects in ObjectData are Lights.
Parameters
outGlobalLightListOutput, a list of lights, contiguously placed
frustumsAn array of all frustums we need to check against
cubemapFrustumsAn array of all frustums that are used at least once as cubemaps ( SceneManager::createCamera)
void Ogre::MovableObject::detachFromParent ( void  )
inherited

Detaches an object from a parent SceneNode if attached.

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

Disables any custom near clip plane.

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

Disables reflection modification previously turned on with enableReflection.

virtual void Ogre::Frustum::enableCustomNearClipPlane ( const MovablePlane plane)
virtualinherited

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

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

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

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

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.
virtual void Ogre::Frustum::enableReflection ( const MovablePlane p)
virtualinherited

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.
virtual void Ogre::Camera::forwardIntersect ( const Plane worldPlane,
vector< Vector4 >::type *  intersect3d 
) const
virtualinherited

Forward projects frustum rays to find forward intersection with plane.

Remarks
Forward projection may lead to intersections at infinity.
virtual const String& Ogre::AnimableObject::getAnimableDictionaryName ( void  ) const
inlineprotectedvirtualinherited

Get the name of the animable dictionary for this class.

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

Definition at line 245 of file OgreAnimable.h.

References Ogre::BLANKSTRING.

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

Gets a list of animable value names for this object.

Definition at line 291 of file OgreAnimable.h.

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

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

Retrieves the current aspect ratio.

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

Retrieves if AutoAspectRatio is currently set or not.

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

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

Definition at line 562 of file OgreCamera.h.

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

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

Definition at line 560 of file OgreCamera.h.

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

Overridden from MovableObject.

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

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

Remarks
Can be useful for populating a PlaneBoundedVolumeListSceneQuery, e.g. for a rubber-band selection.
Parameters
screenLeft,screenTop,screenRight,screenBottomThe bounds of the on-screen rectangle, expressed in normalised screen coordinates [0,1]
includeFarPlaneIf true, the volume is truncated by the camera far plane, by default it is left open-ended
void Ogre::Camera::getCameraToViewportBoxVolume ( Real  screenLeft,
Real  screenTop,
Real  screenRight,
Real  screenBottom,
PlaneBoundedVolume outVolume,
bool  includeFarPlane = false 
)
inherited

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

Remarks
Can be useful for populating a PlaneBoundedVolumeListSceneQuery, e.g. for a rubber-band selection.
Parameters
screenLeft,screenTop,screenRight,screenBottomThe bounds of the on-screen rectangle, expressed in normalised screen coordinates [0,1]
outVolumeThe plane list to populate with the result
includeFarPlaneIf true, the volume is truncated by the camera far plane, by default it is left open-ended
Ray Ogre::Camera::getCameraToViewportRay ( Real  screenx,
Real  screeny 
) const
inherited

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

Parameters
screenx,screenyThe x and y position at which the ray should intersect the viewport, in normalised screen coordinates [0,1]
void Ogre::Camera::getCameraToViewportRay ( Real  screenx,
Real  screeny,
Ray outRay 
) const
inherited

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

Parameters
screenx,screenyThe x and y position at which the ray should intersect the viewport, in normalised screen coordinates [0,1]
outRayRay instance to populate with result
bool Ogre::MovableObject::getCastShadows ( void  ) const
inlineinherited

Returns whether shadow casting is enabled for this object.

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

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

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

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

Definition at line 225 of file OgreRenderable.h.

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

Returns the custom culling frustum in use.

Definition at line 599 of file OgreCamera.h.

const FastArray<unsigned char>& Ogre::MovableObject::getCurrentMaterialLod ( void  ) const
inlineinherited

Definition at line 536 of file OgreMovableObject.h.

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

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

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

Definition at line 269 of file OgreRenderable.h.

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

void Ogre::Frustum::getCustomWorldSpaceCorners ( ArrayVector3  outCorners[(8+ARRAY_PACKED_REALS-1)/ARRAY_PACKED_REALS],
Real  customFarPlane 
) const
inherited
static uint32 Ogre::MovableObject::getDefaultQueryFlags ( )
inlinestaticinherited

Get the default query flags for all future MovableObject instances.

Definition at line 464 of file OgreMovableObject.h.

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

Get the default visibility flags for all future MovableObject instances.

Definition at line 495 of file OgreMovableObject.h.

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

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

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

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

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

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

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

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

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

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

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

Gets the camera's direction.

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

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

Reimplemented from Ogre::Frustum.

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

Returns focal length of frustum.

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

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

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

Get the extents of the frustum in view space.

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

Retrieves the frustum offsets.

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

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

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

Reimplemented from Ogre::Frustum.

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

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

Remarks
The clipping planes are ordered as declared in enumerate constants FrustumPlane.
uint32 Ogre::Renderable::getHlmsCasterHash ( void  ) const
inlineinherited

Definition at line 414 of file OgreRenderable.h.

uint32 Ogre::Renderable::getHlmsHash ( void  ) const
inlineinherited

Definition at line 413 of file OgreRenderable.h.

IdType Ogre::IdObject::getId ( ) const
inlineinherited

Get the unique id of this object.

Definition at line 74 of file OgreId.h.

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

Get the last viewport which was attached to this camera.

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

Definition at line 569 of file OgreCamera.h.

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

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

Remarks
By default, this mask is fully set meaning all lights will affect this object
const LightList& Ogre::Frustum::getLights ( void  ) const
virtualinherited

Overridden from Renderable.

Implements Ogre::Renderable.

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

Gets the current listener for this object.

Definition at line 506 of file OgreMovableObject.h.

Aabb Ogre::MovableObject::getLocalAabb ( void  ) const
inherited

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

Remarks
This bounding box is in local coordinates.
Real Ogre::Camera::getLodBias ( void  ) const
inherited

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

Remarks
See Camera::setLodBias for more details.
virtual const Camera* Ogre::Camera::getLodCamera ( ) const
virtualinherited

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

Remarks
If setLodCamera hasn't been called with a different camera, this method will return 'this'.
const MaterialPtr& Ogre::Frustum::getMaterial ( void  ) const
virtualinherited

Overridden from Renderable.

Implements Ogre::Renderable.

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

Overridden from MovableObject.

Implements Ogre::MovableObject.

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

Returns the name of this object.

Definition at line 166 of file OgreMovableObject.h.

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

Sets the position of the near clipping plane.

Reimplemented from Ogre::Frustum.

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

Returns the number of world transform matrices this renderable requires.

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

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

Definition at line 154 of file OgreRenderable.h.

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

Returns the camera's current orientation.

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

Get the derived orientation of this frustum.

Reimplemented from Ogre::Frustum.

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.
virtual Real Ogre::Frustum::getOrthoWindowHeight ( ) const
virtualinherited

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

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

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

Note
This is calculated from the orthographic height and the aspect ratio
Node* Ogre::MovableObject::getParentNode ( void  ) const
inlineinherited

Returns the node to which this object is attached.

Definition at line 172 of file OgreMovableObject.h.

SceneNode* Ogre::MovableObject::getParentSceneNode ( void  ) const
inlineinherited
Real Ogre::Camera::getPixelDisplayRatio ( ) const
inlineinherited

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

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

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

Definition at line 679 of file OgreCamera.h.

PlaneBoundedVolume Ogre::Frustum::getPlaneBoundedVolume ( )
inherited

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

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

Retrieves the level of detail that the camera will render.

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

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

Reimplemented in Ogre::BorderRenderable.

Definition at line 333 of file OgreRenderable.h.

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

Retrieves the camera's position.

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

Get the derived position of this frustum.

Reimplemented from Ogre::Frustum.

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

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.
virtual const Matrix4& Ogre::Frustum::getProjectionMatrixRS ( void  ) const
virtualinherited

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.
virtual const Matrix4& Ogre::Frustum::getProjectionMatrixWithRSDepth ( void  ) const
virtualinherited

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.
virtual ProjectionType Ogre::Frustum::getProjectionType ( void  ) const
virtualinherited

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

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

Returns the query flags relevant for this object.

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

Helper function for forwardIntersect that intersects rays with canonical plane.

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

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

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

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

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

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

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

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

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

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

bool Ogre::MovableObject::getReceivesShadows ( )
inherited

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

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

Returns the reflection matrix of the frustum if appropriate.

Definition at line 574 of file OgreFrustum.h.

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

Returns the reflection plane of the frustum if appropriate.

Definition at line 576 of file OgreFrustum.h.

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

Gets the distance at which batches are no longer rendered.

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

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

Definition at line 338 of file OgreMovableObject.h.

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

Overridden from Renderable.

Implements Ogre::Renderable.

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

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

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

Gets RenderSystem private data.

Remarks
This should only be used by a RenderSystem

Definition at line 400 of file OgreRenderable.h.

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

Gets the camera's right vector.

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

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

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

Overridden from Renderable.

Implements Ogre::Renderable.

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

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

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

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

Definition at line 95 of file OgreRenderable.h.

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

Gets the camera's up vector.

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

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

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

Definition at line 179 of file OgreRenderable.h.

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

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

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

Definition at line 204 of file OgreRenderable.h.

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

Returns whether to use min display size calculations.

See also
Camera::setUseMinDisplaySize

Definition at line 667 of file OgreCamera.h.

virtual OGRE_DEPRECATED const Any& Ogre::Renderable::getUserAny ( void  ) const
inlinevirtualinherited
Deprecated:
use UserObjectBindings::getUserAny via getUserObjectBindings() instead. Retrieves the custom user value associated with this object.

Definition at line 350 of file OgreRenderable.h.

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

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

Definition at line 644 of file OgreCamera.h.

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

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

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

See also
UserObjectBindings::setUserAny.

Definition at line 344 of file OgreMovableObject.h.

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

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

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

See also
UserObjectBindings::setUserAny.

Definition at line 350 of file OgreMovableObject.h.

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

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

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

See also
UserObjectBindings::setUserAny.

Definition at line 356 of file OgreRenderable.h.

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

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

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

See also
UserObjectBindings::setUserAny.

Definition at line 362 of file OgreRenderable.h.

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

Gets the view matrix for this frustum.

Mainly for use by OGRE internally.

Reimplemented from Ogre::Frustum.

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

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

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

Returns the visibility of the box.

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

Returns the visibility flags relevant for this object.

Reserved visibility flags are not returned.

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

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

Remarks
Returns the value set by MovableObject::setVisible only.
const vector<Plane>::type& Ogre::Camera::getWindowPlanes ( void  ) const
inherited

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

Aabb Ogre::MovableObject::getWorldAabb ( ) const
inherited

Gets the axis aligned box in world space.

Remarks
Assumes the caches are already updated. Will trigger an assert otherwise. getWorldAabbUpdated if you need the update process to be guaranteed
Aabb Ogre::MovableObject::getWorldAabbUpdated ( )
inherited

Gets the axis aligned box in world space.

Remarks
Unlike getWorldAabb, this function guarantees the cache stays up to date. It is STRONGLY advised against calling this function for a large number of MovableObject. Refactor your queries so that they happen after SceneManager::updateAllBounds() has been called
float Ogre::MovableObject::getWorldRadius ( ) const
inherited

Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ).

Remarks
Assumes the caches are already updated. Will trigger an assert otherwise. getWorldRadiusUpdated if you need the update process to be guaranteed
float Ogre::MovableObject::getWorldRadiusUpdated ( )
inherited

Gets the bounding Radius scaled by max( scale.x, scale.y, scale.z ).

Remarks
Unlike getWorldRadius, this function guarantees the cache stays up to date. It is STRONGLY advised against calling this function for a large number of MovableObject. Refactor your queries so that they happen after SceneManager::updateAllBounds() has been called
const Vector3* Ogre::Camera::getWorldSpaceCorners ( void  ) const
virtualinherited

Gets the world space corners of the frustum.

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

Reimplemented from Ogre::Frustum.

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

Overridden from Frustum/Renderable.

Implements Ogre::Renderable.

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

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

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

Definition at line 260 of file OgreRenderable.h.

virtual void Ogre::AnimableObject::initialiseAnimableDictionary ( StringVector ) const
inlineprotectedvirtualinherited

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

Definition at line 283 of file OgreAnimable.h.

virtual void Ogre::MovableObject::instanceBatchCullFrustumThreaded ( const Frustum frustum,
const Camera lodCamera,
uint32  combinedVisibilityFlags 
)
inlinevirtualinherited

InstancingTheadedCullingMethod,

See also
InstanceBatch::instanceBatchCullFrustumThreaded

Reimplemented in Ogre::InstanceBatchHW_VTF, and Ogre::InstanceBatchHW.

Definition at line 250 of file OgreMovableObject.h.

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

Signal to update frustum information.

Reimplemented from Ogre::Frustum.

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

Signal to update view information.

Reimplemented from Ogre::Frustum.

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

Returns true if this object is attached to a Node.

Definition at line 181 of file OgreMovableObject.h.

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

Definition at line 587 of file OgreMovableObject.h.

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

Is a custom near clip plane in use?

Definition at line 651 of file OgreFrustum.h.

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

Returns whether a custom projection matrix is in use.

Definition at line 417 of file OgreFrustum.h.

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

Returns whether a custom view matrix is in use.

Definition at line 390 of file OgreFrustum.h.

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

Gets whether debug display of this object is enabled.

Definition at line 582 of file OgreMovableObject.h.

virtual bool Ogre::Frustum::isFrustumOutOfDate ( void  ) const
protectedvirtualinherited
virtual bool Ogre::Frustum::isReflected ( void  ) const
inlinevirtualinherited

Returns whether this frustum is being reflected.

Definition at line 572 of file OgreFrustum.h.

bool Ogre::Camera::isRenderedRq ( size_t  rqId) const
inlineinherited

Returns true if the asked render queue has been rendered. False otherwise.

Definition at line 700 of file OgreCamera.h.

bool Ogre::MovableObject::isStatic ( ) const
inherited

Checks whether this MovableObject is static. setStatic.

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

Reimplemented from Ogre::Frustum.

bool Ogre::MovableObject::isVisible ( void  ) const
inherited

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

Remarks
Takes into account visibility flags and the setVisible, but not rendering distance.
bool Ogre::Camera::isVisible ( const AxisAlignedBox bound,
FrustumPlane culledBy = 0 
) const
virtualinherited

Tests whether the given container is visible in the Frustum.

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

Reimplemented from Ogre::Frustum.

Reimplemented in Ogre::PCZCamera.

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

Tests whether the given container is visible in the Frustum.

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

Reimplemented from Ogre::Frustum.

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

Tests whether the given vertex is visible in the Frustum.

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

Reimplemented from Ogre::Frustum.

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

Returns if a viewport window is being used.

Definition at line 555 of file OgreCamera.h.

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

Points the camera at a location in worldspace.

Remarks
This is a helper method to automatically generate the direction vector for the camera, based on it's current position and the supplied look-at point.
Parameters
targetPointA vector specifying the look at point.
void Ogre::Camera::lookAt ( Real  x,
Real  y,
Real  z 
)
inherited

Points the camera at a location in worldspace.

Remarks
This is a helper method to automatically generate the direction vector for the camera, based on it's current position and the supplied look-at point.
Parameters
xThe x co-ordinates of the point to look at.
yThe y co-ordinates of the point to look at.
zThe z co-ordinates of the point to look at.
void Ogre::Camera::move ( const Vector3 vec)
inherited

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

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

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

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

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

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

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

Definition at line 119 of file OgreMemoryAllocatedObject.h.

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

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

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

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

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

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

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

Definition at line 91 of file OgreMemoryAllocatedObject.h.

bool Ogre::IdObject::operator() ( const IdObject left,
const IdObject right 
)
inlineinherited

Definition at line 76 of file OgreId.h.

References Ogre::IdObject::mId.

bool Ogre::IdObject::operator() ( const IdObject left,
const IdObject right 
)
inlineinherited

Definition at line 81 of file OgreId.h.

References Ogre::IdObject::mId.

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

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

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

Called immediately after the Renderable has been rendered.

Definition at line 129 of file OgreRenderable.h.

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

Called just prior to the Renderable being rendered.

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

Reimplemented in Ogre::BillboardChain.

Definition at line 124 of file OgreRenderable.h.

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

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

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

Reimplemented from Ogre::Frustum.

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

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

Remarks
The lights are filled in
See also
buildLightList
Returns
The list of lights use to lighting this object.

Definition at line 513 of file OgreMovableObject.h.

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

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

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

Definition at line 251 of file OgreRenderable.h.

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

Remove a listener to this camera.

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

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

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

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

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

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

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

Cancel view window.

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

Rolls the camera anticlockwise, around its local z axis.

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

Rotate the camera around an arbitrary axis.

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

Rotate the camera around an arbitrary axis using a Quaternion.

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

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.
void Ogre::Camera::setAutoAspectRatio ( bool  autoratio)
inherited

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

Remarks
You should set this to true only if the frustum / camera is used by one viewport at the same time. Otherwise the aspect ratio for other viewports may be wrong.
void Ogre::Camera::setAutoTracking ( bool  enabled,
SceneNode *const  target = 0,
const Vector3 offset = Vector3::ZERO 
)
inherited

Enables / disables automatic tracking of a SceneNode.

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

Sets whether or not this object will cast shadows.

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

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

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

Definition at line 597 of file OgreCamera.h.

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

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

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

Definition at line 242 of file OgreRenderable.h.

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

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

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

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

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

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 580 of file OgreMovableObject.h.

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

Set the default query flags for all future MovableObject instances.

Definition at line 460 of file OgreMovableObject.h.

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

Set the default visibility flags for all future MovableObject instances.

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

Sets the camera's direction vector.

Remarks
Note that the 'up' vector for the camera will automatically be recalculated based on the current 'up' vector (i.e. the roll will remain the same).
void Ogre::Camera::setDirection ( const Vector3 vec)
inherited

Sets the camera's direction vector.

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

Sets the distance to the far clipping plane.

Remarks
The view frustum is a pyramid created from the frustum position and the edges of the viewport. This method sets the distance for the far end of that pyramid. Different applications need different values: e.g. a flight sim needs a much further far clipping plane than a first-person shooter. An important point here is that the larger the ratio between near and far clipping planes, the lower the accuracy of the Z-buffer used to depth-cue pixels. This is because the Z-range is limited to the size of the Z buffer (16 or 32-bit) and the max values must be spread over the gap between near and far clip planes. As it happens, you can affect the accuracy far more by altering the near distance rather than the far distance, but keep this in mind.
Parameters
farDistThe distance to the far clipping plane from the frustum in world coordinates.If you specify 0, this means an infinite view distance which is useful especially when projecting shadows; but be careful not to use a near distance too close.
void Ogre::Camera::setFixedYawAxis ( bool  useFixed,
const Vector3 fixedAxis = Vector3::UNIT_Y 
)
inherited

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

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

Sets frustum focal length (used in stereo rendering).

Parameters
focalLengthThe distance to the focal plane from the frustum in world coordinates.
virtual void Ogre::Frustum::setFOVy ( const Radian fovy)
virtualinherited

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.
virtual void Ogre::Frustum::setFrustumExtents ( Real  left,
Real  right,
Real  top,
Real  bottom 
)
virtualinherited

Manually set the extents of the frustum.

Parameters
left,right,top,bottomThe position where the side clip planes intersect the near clip plane, in eye space
virtual void Ogre::Frustum::setFrustumOffset ( const Vector2 offset)
virtualinherited

Sets frustum offsets, used in stereo rendering.

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

Sets frustum offsets, used in stereo rendering.

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

Definition at line 416 of file OgreRenderable.h.

References Ogre::Hlms::calculateHashFor().

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

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
void Ogre::MovableObject::setListener ( Listener listener)
inlineinherited

Sets a listener for this object.

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

Definition at line 502 of file OgreMovableObject.h.

void Ogre::MovableObject::setLocalAabb ( const Aabb  box)
inherited

Sets the local axis-aligned bounding box for this object.

Remarks
This bounding box is in local coordinates.
void Ogre::Camera::setLodBias ( Real  factor = 1.0)
inherited

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

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

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

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

Sets a custom name for this node.

Doesn't have to be unique

Definition at line 163 of file OgreMovableObject.h.

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

Sets the position of the near clipping plane.

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

Sets the camera's orientation.

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.
virtual void Ogre::Frustum::setOrthoWindow ( Real  w,
Real  h 
)
virtualinherited

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

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

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

Note
The width of the window will be calculated from the aspect ratio.
Parameters
hThe height of the view window in world units.
virtual void Ogre::Frustum::setOrthoWindowWidth ( Real  w)
virtualinherited

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

Note
The height of the window will be calculated from the aspect ratio.
Parameters
wThe width of the view window in world units.
void Ogre::Camera::setPolygonMode ( PolygonMode  sd)
inherited

Sets the level of rendering detail required from this camera.

Remarks
Each camera is set to render at full detail by default, that is with full texturing, lighting etc. This method lets you change that behaviour, allowing you to make the camera just render a wireframe view, for example.
virtual void Ogre::Renderable::setPolygonModeOverrideable ( bool  override)
inlinevirtualinherited

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

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

Definition at line 325 of file OgreRenderable.h.

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

Sets the camera's position.

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

Sets the camera's position.

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

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

Default is perspective.

Reimplemented in Ogre::PCZCamera.

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

Sets the query flags for this object.

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

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

Parameters
distDistance beyond which the object will not be rendered (the default is FLT_MAX, which means objects are always rendered). Values equal or below zero will be ignored, and cause an assertion in debug mode.
void Ogre::MovableObject::setRenderingMinPixelSize ( Real  pixelSize)
inlineinherited

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

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

Definition at line 331 of file OgreMovableObject.h.

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

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

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

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

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

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

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

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

virtual void Ogre::Renderable::setRenderSystemData ( RenderSystemData val) const
inlinevirtualinherited

Sets RenderSystem private data.

Remarks
This should only be used by a RenderSystem

Definition at line 408 of file OgreRenderable.h.

bool Ogre::MovableObject::setStatic ( bool  bStatic)
inherited

Turns this Node into static or dynamic.

Remarks
Switching between dynamic and static has some overhead and forces to update all static scene when converted to static. So don't do it frequently. Static objects are not updated every frame, only when requested explicitly. Use this feature if you plan to have this object unaltered for a very long times
Note all MovableObjects support switching between static & dynamic after they have been created (eg. InstancedEntity)
Changing this attribute will cause to switch the attribute to our parent node, and as a result, all of its other attached entities. Node::setStatic
Returns
True if setStatic made an actual change. False otherwise. Can fail because the object was already static/dynamic, or because switching is not supported
void Ogre::Renderable::setUseIdentityProjection ( bool  useIdentityProjection)
inlineinherited

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

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

Definition at line 165 of file OgreRenderable.h.

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

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

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

Definition at line 190 of file OgreRenderable.h.

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

Sets whether to use min display size calculations.

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

Definition at line 663 of file OgreCamera.h.

virtual OGRE_DEPRECATED void Ogre::Renderable::setUserAny ( const Any anything)
inlinevirtualinherited
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 345 of file OgreRenderable.h.

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

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

The default behaviour is to use it.

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

Definition at line 640 of file OgreCamera.h.

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

Sets the visibility flags for this object.

Remarks
As well as a simple true/false value for visibility (as seen in setVisible), you can also set visibility flags that is applied a binary 'and' with the SceneManager's mask and a compositor node pass. To exclude particular objects from rendering. Changes to reserved visibility flags are ignored (won't take effect).
void Ogre::MovableObject::setVisible ( bool  visible)
inlineinherited

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

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

Sets the viewing window inside of viewport.

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

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

Remarks
The method will called on demand.
virtual void Ogre::Camera::synchroniseBaseSettingsWith ( const Camera cam)
virtualinherited

Synchronise core camera settings with another.

Remarks
Copies the position, orientation, clip distances, projection type, FOV, focal length and aspect ratio from another camera. Other settings like query flags, reflection etc are preserved.
static void Ogre::MovableObject::updateAllBounds ( const size_t  numNodes,
ObjectData  t 
)
staticinherited

SceneManager::updateAllBounds

Remarks
We don't pass by reference on purpose (avoid implicit aliasing)
virtual void Ogre::Frustum::updateFrustum ( void  ) const
protectedvirtualinherited

Update frustum if out of date.

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

Implementation of updateFrustum (called if out of date)

virtual void Ogre::Frustum::updateFrustumPlanes ( void  ) const
protectedvirtualinherited
virtual void Ogre::Frustum::updateFrustumPlanesImpl ( void  ) const
protectedvirtualinherited

Implementation of updateFrustumPlanes (called if out of date)

Aabb Ogre::MovableObject::updateSingleWorldAabb ( )
protectedinherited
float Ogre::MovableObject::updateSingleWorldRadius ( )
protectedinherited
virtual void Ogre::Frustum::updateVertexData ( void  ) const
protectedvirtualinherited
virtual void Ogre::Frustum::updateView ( void  ) const
protectedvirtualinherited

Update view if out of date.

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

Implementation of updateView (called if out of date)

virtual void Ogre::Frustum::updateWorldSpaceCorners ( void  ) const
protectedvirtualinherited
virtual void Ogre::Frustum::updateWorldSpaceCornersImpl ( void  ) const
protectedvirtualinherited

Implementation of updateWorldSpaceCorners (called if out of date)

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

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

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

Implements Ogre::MovableObject.

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

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

Member Data Documentation

const FastArray<Real> Ogre::MovableObject::c_DefaultLodMesh
inherited

Definition at line 65 of file OgreMovableObject.h.

const Real Ogre::Frustum::INFINITE_FAR_PLANE_ADJUST
staticinherited

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

Definition at line 659 of file OgreFrustum.h.

Real Ogre::Frustum::mAspect
protectedinherited

x/y viewport ratio - default 1.3333

Definition at line 97 of file OgreFrustum.h.

bool Ogre::Camera::mAutoAspectRatio
protectedinherited

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

Definition at line 167 of file OgreCamera.h.

Vector3 Ogre::Camera::mAutoTrackOffset
protectedinherited

Tracking offset for fine tuning.

Definition at line 144 of file OgreCamera.h.

SceneNode* Ogre::Camera::mAutoTrackTarget
protectedinherited

SceneNode which this Camera will automatically track.

Definition at line 142 of file OgreCamera.h.

Real Ogre::Frustum::mBottom
mutableprotectedinherited

Definition at line 137 of file OgreFrustum.h.

AxisAlignedBox Ogre::Frustum::mBoundingBox
mutableprotectedinherited

Definition at line 168 of file OgreFrustum.h.

bool Ogre::MovableObject::mCachedAabbOutOfDate
mutableprotectedinherited

Definition at line 117 of file OgreMovableObject.h.

Frustum* Ogre::Camera::mCullFrustum
protectedinherited

Custom culling frustum.

Definition at line 169 of file OgreCamera.h.

FastArray<unsigned char> Ogre::MovableObject::mCurrentMaterialLod
protectedinherited

Definition at line 97 of file OgreMovableObject.h.

unsigned char Ogre::MovableObject::mCurrentMeshLod
protectedinherited

Definition at line 96 of file OgreMovableObject.h.

CustomParameterMap Ogre::Renderable::mCustomParameters
protectedinherited

Definition at line 423 of file OgreRenderable.h.

bool Ogre::Frustum::mCustomProjMatrix
protectedinherited

Are we using a custom projection matrix?

Definition at line 133 of file OgreFrustum.h.

bool Ogre::Frustum::mCustomViewMatrix
protectedinherited

Are we using a custom view matrix?

Definition at line 131 of file OgreFrustum.h.

bool Ogre::MovableObject::mDebugDisplay
protectedinherited

Is debug display enabled?

Definition at line 111 of file OgreMovableObject.h.

Quaternion Ogre::Camera::mDerivedOrientation
mutableprotectedinherited

Derived orientation/position of the camera, including reflection.

Definition at line 117 of file OgreCamera.h.

Vector3 Ogre::Camera::mDerivedPosition
mutableprotectedinherited

Definition at line 118 of file OgreCamera.h.

Real Ogre::Frustum::mFarDist
protectedinherited

Far clip distance - default 10000.

Definition at line 93 of file OgreFrustum.h.

Real Ogre::Frustum::mFocalLength
protectedinherited

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

Definition at line 103 of file OgreFrustum.h.

Radian Ogre::Frustum::mFOVy
protectedinherited

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

Definition at line 91 of file OgreFrustum.h.

bool Ogre::Frustum::mFrustumExtentsManuallySet
protectedinherited

Have the frustum extents been manually set?

Definition at line 135 of file OgreFrustum.h.

Vector2 Ogre::Frustum::mFrustumOffset
protectedinherited

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

Definition at line 101 of file OgreFrustum.h.

Plane Ogre::Frustum::mFrustumPlanes[6]
mutableprotectedinherited

The 6 main clipping planes.

Definition at line 106 of file OgreFrustum.h.

size_t Ogre::MovableObject::mGlobalIndex
inherited

Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks).

Used for O(1) removals.

Remarks
It is the parent (or our creator) the one that sets this value, not ourselves. Do NOT modify it manually.

Definition at line 140 of file OgreMovableObject.h.

uint32 Ogre::Renderable::mHlmsCasterHash
protectedinherited

Definition at line 425 of file OgreRenderable.h.

uint32 Ogre::Renderable::mHlmsHash
protectedinherited

Definition at line 424 of file OgreRenderable.h.

Plane Ogre::Frustum::mLastLinkedObliqueProjPlane
mutableprotectedinherited

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

Definition at line 192 of file OgreFrustum.h.

Plane Ogre::Frustum::mLastLinkedReflectionPlane
mutableprotectedinherited

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

Definition at line 183 of file OgreFrustum.h.

Quaternion Ogre::Frustum::mLastParentOrientation
mutableprotectedinherited

Stored versions of parent orientation / position.

Definition at line 109 of file OgreFrustum.h.

Vector3 Ogre::Frustum::mLastParentPosition
mutableprotectedinherited

Definition at line 110 of file OgreFrustum.h.

Viewport* Ogre::Camera::mLastViewport
protectedinherited

The last viewport to be added using this camera.

Definition at line 163 of file OgreCamera.h.

Real Ogre::Frustum::mLeft
mutableprotectedinherited

Frustum extents.

Definition at line 137 of file OgreFrustum.h.

LightList Ogre::MovableObject::mLightList
protectedinherited

List of lights for this object.

Definition at line 108 of file OgreMovableObject.h.

const MovablePlane* Ogre::Frustum::mLinkedObliqueProjPlane
protectedinherited

Pointer to oblique projection plane (automatically updated)

Definition at line 190 of file OgreFrustum.h.

const MovablePlane* Ogre::Frustum::mLinkedReflectPlane
protectedinherited

Pointer to a reflection plane (automatically updated)

Definition at line 181 of file OgreFrustum.h.

Listener* Ogre::MovableObject::mListener
protectedinherited

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

Definition at line 105 of file OgreMovableObject.h.

ListenerList Ogre::Camera::mListeners
protectedinherited

Definition at line 184 of file OgreCamera.h.

const Camera* Ogre::Camera::mLodCamera
protectedinherited

Camera to use for LOD calculation.

Definition at line 173 of file OgreCamera.h.

FastArray< FastArray<Real> const * > Ogre::MovableObject::mLodMaterial
protectedinherited

Definition at line 95 of file OgreMovableObject.h.

FastArray<Real> const* Ogre::MovableObject::mLodMesh
protectedinherited

Definition at line 94 of file OgreMovableObject.h.

SceneManager* Ogre::MovableObject::mManager
protectedinherited

SceneManager holding this object (if applicable)

Definition at line 91 of file OgreMovableObject.h.

MaterialPtr Ogre::Frustum::mMaterial
protectedinherited

Definition at line 171 of file OgreFrustum.h.

Real Ogre::MovableObject::mMinPixelSize
protectedinherited

Minimum pixel size to still render.

Definition at line 100 of file OgreMovableObject.h.

String Ogre::MovableObject::mName
protectedinherited

Friendly name of this object, can be empty.

Definition at line 121 of file OgreMovableObject.h.

Real Ogre::Frustum::mNearDist
protectedinherited

Near clip distance - default 100.

Definition at line 95 of file OgreFrustum.h.

ObjectData Ogre::MovableObject::mObjectData
protectedinherited

All the object data needed in SoA form.

Definition at line 89 of file OgreMovableObject.h.

ObjectMemoryManager* Ogre::MovableObject::mObjectMemoryManager
protectedinherited

The memory manager used to allocate the ObjectData.

Definition at line 114 of file OgreMovableObject.h.

bool Ogre::Frustum::mObliqueDepthProjection
protectedinherited

Is this frustum using an oblique depth projection?

Definition at line 186 of file OgreFrustum.h.

Plane Ogre::Frustum::mObliqueProjPlane
mutableprotectedinherited

Fixed oblique projection plane.

Definition at line 188 of file OgreFrustum.h.

Quaternion Ogre::Camera::mOrientation
protectedinherited

Camera orientation, quaternion style.

Definition at line 111 of file OgreCamera.h.

OrientationMode Ogre::Frustum::mOrientationMode
mutableprotectedinherited

Frustum orientation mode.

Definition at line 139 of file OgreFrustum.h.

Real Ogre::Frustum::mOrthoHeight
protectedinherited

Ortho height size (world units)

Definition at line 99 of file OgreFrustum.h.

size_t Ogre::MovableObject::mParentIndex
inherited

Index in the vector holding this MO reference (could be our parent node, or a global array tracking all movable objecst to avoid memory leaks).

Used for O(1) removals.

Remarks
It is the parent (or our creator) the one that sets this value, not ourselves. Do NOT modify it manually.

Definition at line 142 of file OgreMovableObject.h.

Node* Ogre::MovableObject::mParentNode
protectedinherited

Node to which this object is attached.

Definition at line 83 of file OgreMovableObject.h.

Real Ogre::Camera::mPixelDisplayRatio
protectedinherited
See also
Camera::getPixelDisplayRatio

Definition at line 178 of file OgreCamera.h.

bool Ogre::Renderable::mPolygonModeOverrideable
protectedinherited

Definition at line 426 of file OgreRenderable.h.

Vector3 Ogre::Camera::mPosition
protectedinherited

Camera position - default (0,0,0)

Definition at line 114 of file OgreCamera.h.

Matrix4 Ogre::Frustum::mProjMatrix
mutableprotectedinherited

Pre-calced standard projection matrix.

Definition at line 117 of file OgreFrustum.h.

Matrix4 Ogre::Frustum::mProjMatrixRS
mutableprotectedinherited

Pre-calced projection matrix for the specific render system.

Definition at line 113 of file OgreFrustum.h.

Matrix4 Ogre::Frustum::mProjMatrixRSDepth
mutableprotectedinherited

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

Definition at line 115 of file OgreFrustum.h.

ProjectionType Ogre::Frustum::mProjType
protectedinherited

Orthographic or perspective?

Definition at line 88 of file OgreFrustum.h.

Quaternion Ogre::Camera::mRealOrientation
mutableprotectedinherited

Real world orientation/position of the camera.

Definition at line 121 of file OgreCamera.h.

Vector3 Ogre::Camera::mRealPosition
mutableprotectedinherited

Definition at line 122 of file OgreCamera.h.

bool Ogre::Frustum::mRecalcFrustum
mutableprotectedinherited

Something's changed in the frustum shape?

Definition at line 121 of file OgreFrustum.h.

bool Ogre::Frustum::mRecalcFrustumPlanes
mutableprotectedinherited

Something re the frustum planes has changed.

Definition at line 125 of file OgreFrustum.h.

bool Ogre::Frustum::mRecalcVertexData
mutableprotectedinherited

Something re the vertex data has changed.

Definition at line 129 of file OgreFrustum.h.

bool Ogre::Frustum::mRecalcView
mutableprotectedinherited

Something re the view pos has changed.

Definition at line 123 of file OgreFrustum.h.

bool Ogre::Camera::mRecalcWindow
mutableprotectedinherited

Was viewing window changed.

Definition at line 161 of file OgreCamera.h.

bool Ogre::Frustum::mRecalcWorldSpaceCorners
mutableprotectedinherited

Something re the world space corners has changed.

Definition at line 127 of file OgreFrustum.h.

bool Ogre::Frustum::mReflect
protectedinherited

Is this frustum to act as a reflection of itself?

Definition at line 175 of file OgreFrustum.h.

Matrix4 Ogre::Frustum::mReflectMatrix
mutableprotectedinherited

Derived reflection matrix.

Definition at line 177 of file OgreFrustum.h.

Plane Ogre::Frustum::mReflectPlane
mutableprotectedinherited

Fixed reflection plane.

Definition at line 179 of file OgreFrustum.h.

vector<bool>::type Ogre::Camera::mRenderedRqs
protectedinherited

Each frame it is set to all false. After rendering each RQ, it is set to true.

Definition at line 181 of file OgreCamera.h.

uint8 Ogre::MovableObject::mRenderQueueID
protectedinherited

The render queue to use when rendering this object.

Definition at line 85 of file OgreMovableObject.h.

ushort Ogre::MovableObject::mRenderQueuePriority
protectedinherited

The render queue group to use when rendering this object.

Definition at line 87 of file OgreMovableObject.h.

RenderSystemData* Ogre::Renderable::mRenderSystemData
mutableprotectedinherited

User objects binding.

Definition at line 430 of file OgreRenderable.h.

Real Ogre::Frustum::mRight
mutableprotectedinherited

Definition at line 137 of file OgreFrustum.h.

AnimableDictionaryMap Ogre::AnimableObject::msAnimableDictionary
staticprotectedinherited

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

Definition at line 239 of file OgreAnimable.h.

PolygonMode Ogre::Camera::mSceneDetail
protectedinherited

Rendering type.

Definition at line 130 of file OgreCamera.h.

Real Ogre::Camera::mSceneLodFactor
protectedinherited

Scene LOD factor used to adjust overall LOD.

Definition at line 147 of file OgreCamera.h.

Real Ogre::Camera::mSceneLodFactorInv
protectedinherited

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

Definition at line 149 of file OgreCamera.h.

SceneManager* Ogre::Camera::mSceneMgr
protectedinherited

Scene manager responsible for the scene.

Definition at line 108 of file OgreCamera.h.

uint32 Ogre::MovableObject::msDefaultQueryFlags
staticprotectedinherited

Default query flags.

Definition at line 125 of file OgreMovableObject.h.

uint32 Ogre::MovableObject::msDefaultVisibilityFlags
staticprotectedinherited

Default visibility flags.

Definition at line 127 of file OgreMovableObject.h.

String Ogre::Camera::msMovableType
staticprotectedinherited

Shared class-level name for Movable type.

Definition at line 139 of file OgreCamera.h.

Real Ogre::Frustum::mTop
mutableprotectedinherited

Definition at line 137 of file OgreFrustum.h.

bool Ogre::Renderable::mUseIdentityProjection
protectedinherited

Definition at line 427 of file OgreRenderable.h.

bool Ogre::Renderable::mUseIdentityView
protectedinherited

Definition at line 428 of file OgreRenderable.h.

bool Ogre::Camera::mUseMinPixelSize
protectedinherited

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

Definition at line 176 of file OgreCamera.h.

bool Ogre::Camera::mUseRenderingDistance
protectedinherited

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

Definition at line 171 of file OgreCamera.h.

UserObjectBindings Ogre::MovableObject::mUserObjectBindings
protectedinherited

User objects binding.

Definition at line 102 of file OgreMovableObject.h.

UserObjectBindings Ogre::Renderable::mUserObjectBindings
protectedinherited

Definition at line 429 of file OgreRenderable.h.

VertexData Ogre::Frustum::mVertexData
mutableprotectedinherited

Definition at line 169 of file OgreFrustum.h.

Matrix4 Ogre::Frustum::mViewMatrix
mutableprotectedinherited

Pre-calced view matrix.

Definition at line 119 of file OgreFrustum.h.

unsigned int Ogre::Camera::mVisBatchesLastRender
protectedinherited

Stored number of visible batches in the last render.

Definition at line 136 of file OgreCamera.h.

unsigned int Ogre::Camera::mVisFacesLastRender
protectedinherited

Stored number of visible faces in the last render.

Definition at line 133 of file OgreCamera.h.

Real Ogre::Camera::mWBottom
protectedinherited

Definition at line 155 of file OgreCamera.h.

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

Windowed viewport clip planes.

Definition at line 159 of file OgreCamera.h.

bool Ogre::Camera::mWindowSet
protectedinherited

Is viewing window used.

Definition at line 157 of file OgreCamera.h.

Real Ogre::Camera::mWLeft
protectedinherited

Viewing window.

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

Definition at line 155 of file OgreCamera.h.

Vector3 Ogre::Frustum::mWorldSpaceCorners[8]
mutableprotectedinherited

Definition at line 172 of file OgreFrustum.h.

Real Ogre::Camera::mWRight
protectedinherited

Definition at line 155 of file OgreCamera.h.

Real Ogre::Camera::mWTop
protectedinherited

Definition at line 155 of file OgreCamera.h.

bool Ogre::Camera::mYawFixed
protectedinherited

Whether to yaw around a fixed axis.

Definition at line 125 of file OgreCamera.h.

Vector3 Ogre::Camera::mYawFixedAxis
protectedinherited

Fixed axis to yaw around.

Definition at line 127 of file OgreCamera.h.


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