#include <OgreCamera.h>
Inheritance diagram for Ogre::Camera:
Public Types | ||||||||||
typedef std::vector< ShadowRenderable * > | ShadowRenderableList | |||||||||
typedef VectorIterator< ShadowRenderableList > | ShadowRenderableListIterator | |||||||||
Public Member Functions | ||||||||||
Camera (const String &name, SceneManager *sm) | ||||||||||
Standard constructor. | ||||||||||
virtual | ~Camera () | |||||||||
Standard destructor. | ||||||||||
SceneManager * | getSceneManager (void) const | |||||||||
Returns a pointer to the SceneManager this camera is rendering through. | ||||||||||
virtual const String & | getName (void) const | |||||||||
Gets the camera's name. | ||||||||||
void | setPolygonMode (PolygonMode sd) | |||||||||
Sets the level of rendering detail required from this camera. | ||||||||||
PolygonMode | getPolygonMode (void) const | |||||||||
Retrieves the level of detail that the camera will render. | ||||||||||
void | setPosition (Real x, Real y, Real z) | |||||||||
Sets the camera's position. | ||||||||||
void | setPosition (const Vector3 &vec) | |||||||||
Sets the camera's position. | ||||||||||
const Vector3 & | getPosition (void) const | |||||||||
Retrieves the camera's position. | ||||||||||
void | move (const Vector3 &vec) | |||||||||
Moves the camera's position by the vector offset provided along world axes. | ||||||||||
void | moveRelative (const Vector3 &vec) | |||||||||
Moves the camera's position by the vector offset provided along it's own axes (relative to orientation). | ||||||||||
void | setDirection (Real x, Real y, Real z) | |||||||||
Sets the camera's direction vector. | ||||||||||
void | setDirection (const Vector3 &vec) | |||||||||
Sets the camera's direction vector. | ||||||||||
Vector3 | getDirection (void) const | |||||||||
Vector3 | getUp (void) const | |||||||||
Gets the camera's up vector. | ||||||||||
Vector3 | getRight (void) const | |||||||||
Gets the camera's right vector. | ||||||||||
void | lookAt (const Vector3 &targetPoint) | |||||||||
Points the camera at a location in worldspace. | ||||||||||
void | lookAt (Real x, Real y, Real z) | |||||||||
Points the camera at a location in worldspace. | ||||||||||
void | roll (const Radian &angle) | |||||||||
Rolls the camera anticlockwise, around its local z axis. | ||||||||||
void | yaw (const Radian &angle) | |||||||||
Rotates the camera anticlockwise around it's local y axis. | ||||||||||
void | pitch (const Radian &angle) | |||||||||
Pitches the camera up/down anticlockwise around it's local z axis. | ||||||||||
void | rotate (const Vector3 &axis, const Radian &angle) | |||||||||
Rotate the camera around an arbitrary axis. | ||||||||||
void | rotate (const Quaternion &q) | |||||||||
Rotate the camera around an arbitrary axis using a Quaternion. | ||||||||||
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. | ||||||||||
const Quaternion & | getOrientation (void) const | |||||||||
Returns the camera's current orientation. | ||||||||||
void | setOrientation (const Quaternion &q) | |||||||||
Sets the camera's orientation. | ||||||||||
void | _renderScene (Viewport *vp, bool includeOverlays) | |||||||||
Tells the Camera to contact the SceneManager to render from it's viewpoint. | ||||||||||
void | _notifyRenderedFaces (unsigned int numfaces) | |||||||||
Internal method to notify camera of the visible faces in the last render. | ||||||||||
void | _notifyRenderedBatches (unsigned int numbatches) | |||||||||
Internal method to notify camera of the visible batches in the last render. | ||||||||||
unsigned int | _getNumRenderedFaces (void) const | |||||||||
Internal method to retrieve the number of visible faces in the last render. | ||||||||||
unsigned int | _getNumRenderedBatches (void) const | |||||||||
Internal method to retrieve the number of visible batches in the last render. | ||||||||||
const Quaternion & | getDerivedOrientation (void) const | |||||||||
Gets the derived orientation of the camera, including any rotation inherited from a node attachment and reflection matrix. | ||||||||||
const Vector3 & | getDerivedPosition (void) const | |||||||||
Gets the derived position of the camera, including any translation inherited from a node attachment and reflection matrix. | ||||||||||
Vector3 | getDerivedDirection (void) const | |||||||||
Gets the derived direction vector of the camera, including any rotation inherited from a node attachment and reflection matrix. | ||||||||||
Vector3 | getDerivedUp (void) const | |||||||||
Gets the derived up vector of the camera, including any rotation inherited from a node attachment and reflection matrix. | ||||||||||
Vector3 | getDerivedRight (void) const | |||||||||
Gets the derived right vector of the camera, including any rotation inherited from a node attachment and reflection matrix. | ||||||||||
const Quaternion & | getRealOrientation (void) const | |||||||||
Gets the real world orientation of the camera, including any rotation inherited from a node attachment. | ||||||||||
const Vector3 & | getRealPosition (void) const | |||||||||
Gets the real world position of the camera, including any translation inherited from a node attachment. | ||||||||||
Vector3 | getRealDirection (void) const | |||||||||
Gets the real world direction vector of the camera, including any rotation inherited from a node attachment. | ||||||||||
Vector3 | getRealUp (void) const | |||||||||
Gets the real world up vector of the camera, including any rotation inherited from a node attachment. | ||||||||||
Vector3 | getRealRight (void) const | |||||||||
Gets the real world right vector of the camera, including any rotation inherited from a node attachment. | ||||||||||
const String & | getMovableType (void) const | |||||||||
Overridden from MovableObject. | ||||||||||
void | setAutoTracking (bool enabled, SceneNode *target=0, const Vector3 &offset=Vector3::ZERO) | |||||||||
Enables / disables automatic tracking of a SceneNode. | ||||||||||
void | setLodBias (Real factor=1.0) | |||||||||
Sets the level-of-detail factor for this Camera. | ||||||||||
Real | getLodBias (void) const | |||||||||
Returns the level-of-detail bias factor currently applied to this camera. | ||||||||||
virtual void | setLodCamera (const Camera *lodCam) | |||||||||
Get a pointer to the camera which should be used to determine LOD settings. | ||||||||||
virtual const Camera * | getLodCamera () const | |||||||||
Get a pointer to the camera which should be used to determine LOD settings. | ||||||||||
Ray | getCameraToViewportRay (Real screenx, Real screeny) const | |||||||||
Gets a world space ray as cast from the camera through a viewport position. | ||||||||||
void | getCameraToViewportRay (Real screenx, Real screeny, Ray *outRay) const | |||||||||
Gets a world space ray as cast from the camera through a viewport position. | ||||||||||
PlaneBoundedVolume | getCameraToViewportBoxVolume (Real screenLeft, Real screenTop, Real screenRight, Real screenBottom, bool includeFarPlane=false) | |||||||||
Gets a world-space list of planes enclosing a volume based on a viewport rectangle. | ||||||||||
void | getCameraToViewportBoxVolume (Real screenLeft, Real screenTop, Real screenRight, Real screenBottom, PlaneBoundedVolume *outVolume, bool includeFarPlane=false) | |||||||||
Gets a world-space list of planes enclosing a volume based on a viewport rectangle. | ||||||||||
Real | _getLodBiasInverse (void) const | |||||||||
Internal method for OGRE to use for LOD calculations. | ||||||||||
void | _autoTrack (void) | |||||||||
Internal method used by OGRE to update auto-tracking cameras. | ||||||||||
virtual void | setWindow (Real Left, Real Top, Real Right, Real Bottom) | |||||||||
Sets the viewing window inside of viewport. | ||||||||||
virtual void | resetWindow (void) | |||||||||
Cancel view window. | ||||||||||
virtual bool | isWindowSet (void) const | |||||||||
Returns if a viewport window is being used. | ||||||||||
const std::vector< Plane > & | getWindowPlanes (void) const | |||||||||
Gets the window clip planes, only applicable if isWindowSet == true. | ||||||||||
Real | getBoundingRadius (void) const | |||||||||
Overridden from MovableObject. | ||||||||||
SceneNode * | getAutoTrackTarget (void) const | |||||||||
Get the auto tracking target for this camera, if any. | ||||||||||
const Vector3 & | getAutoTrackOffset (void) const | |||||||||
Get the auto tracking offset for this camera, if it is auto tracking. | ||||||||||
Viewport * | getViewport (void) const | |||||||||
Get the last viewport which was attached to this camera. | ||||||||||
void | _notifyViewport (Viewport *viewport) | |||||||||
Notifies this camera that a viewport is using it. | ||||||||||
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. | ||||||||||
bool | getAutoAspectRatio (void) const | |||||||||
Retrieves if AutoAspectRatio is currently set or not. | ||||||||||
void | setCullingFrustum (Frustum *frustum) | |||||||||
Tells the camera to use a separate Frustum instance to perform culling. | ||||||||||
Frustum * | getCullingFrustum (void) const | |||||||||
Returns the custom culling frustum in use. | ||||||||||
virtual void | forwardIntersect (const Plane &worldPlane, std::vector< Vector4 > *intersect3d) const | |||||||||
Forward projects frustum rays to find forward intersection with plane. | ||||||||||
bool | isVisible (const AxisAlignedBox &bound, FrustumPlane *culledBy=0) const | |||||||||
| ||||||||||
bool | isVisible (const Sphere &bound, FrustumPlane *culledBy=0) const | |||||||||
| ||||||||||
bool | isVisible (const Vector3 &vert, FrustumPlane *culledBy=0) const | |||||||||
| ||||||||||
const Vector3 * | getWorldSpaceCorners (void) const | |||||||||
| ||||||||||
const Plane & | getFrustumPlane (unsigned short plane) const | |||||||||
| ||||||||||
bool | projectSphere (const Sphere &sphere, Real *left, Real *top, Real *right, Real *bottom) const | |||||||||
| ||||||||||
Real | getNearClipDistance (void) const | |||||||||
| ||||||||||
Real | getFarClipDistance (void) const | |||||||||
| ||||||||||
const Matrix4 & | getViewMatrix (void) const | |||||||||
Mainly for use by OGRE internally. | ||||||||||
const Matrix4 & | getViewMatrix (bool ownFrustumOnly) const | |||||||||
Specialised version of getViewMatrix allowing caller to differentiate whether the custom culling frustum should be allowed or not. | ||||||||||
virtual void | setUseRenderingDistance (bool use) | |||||||||
Set whether this camera should use the 'rendering distance' on objects to exclude distant objects from the final image. | ||||||||||
virtual bool | getUseRenderingDistance (void) const | |||||||||
Get whether this camera should use the 'rendering distance' on objects to exclude distant objects from the final image. | ||||||||||
virtual void | synchroniseBaseSettingsWith (const Camera *cam) | |||||||||
Synchronise core camera settings with another. | ||||||||||
const Vector3 & | getPositionForViewUpdate (void) const | |||||||||
Get the derived position of this frustum. | ||||||||||
const Quaternion & | getOrientationForViewUpdate (void) const | |||||||||
Get the derived orientation of this frustum. | ||||||||||
virtual void | setFOVy (const Radian &fovy) | |||||||||
Sets the Y-dimension Field Of View (FOV) of the frustum. | ||||||||||
virtual const Radian & | getFOVy (void) const | |||||||||
Retrieves the frustums Y-dimension Field Of View (FOV). | ||||||||||
virtual void | setNearClipDistance (Real nearDist) | |||||||||
Sets the position of the near clipping plane. | ||||||||||
virtual void | setFarClipDistance (Real farDist) | |||||||||
Sets the distance to the far clipping plane. | ||||||||||
virtual void | setAspectRatio (Real ratio) | |||||||||
Sets the aspect ratio for the frustum viewport. | ||||||||||
virtual Real | getAspectRatio (void) const | |||||||||
Retreives the current aspect ratio. | ||||||||||
virtual void | setFrustumOffset (const Vector2 &offset) | |||||||||
Sets frustum offsets, used in stereo rendering. | ||||||||||
virtual void | setFrustumOffset (Real horizontal=0.0, Real vertical=0.0) | |||||||||
Sets frustum offsets, used in stereo rendering. | ||||||||||
virtual const Vector2 & | getFrustumOffset () const | |||||||||
Retrieves the frustum offsets. | ||||||||||
virtual void | setFocalLength (Real focalLength=1.0) | |||||||||
Sets frustum focal length (used in stereo rendering). | ||||||||||
virtual Real | getFocalLength () const | |||||||||
Returns focal length of frustum. | ||||||||||
virtual void | setFrustumExtents (Real left, Real right, Real top, Real bottom) | |||||||||
Manually set the extents of the frustum. | ||||||||||
virtual void | resetFrustumExtents () | |||||||||
Reset the frustum extents to be automatically derived from other params. | ||||||||||
virtual void | getFrustumExtents (Real &outleft, Real &outright, Real &outtop, Real &outbottom) const | |||||||||
Get the extents of the frustum in view space. | ||||||||||
virtual const Matrix4 & | getProjectionMatrixRS (void) const | |||||||||
Gets the projection matrix for this frustum adjusted for the current rendersystem specifics (may be right or left-handed, depth range may vary). | ||||||||||
virtual const Matrix4 & | getProjectionMatrixWithRSDepth (void) const | |||||||||
Gets the depth-adjusted projection matrix for the current rendersystem, but one which still conforms to right-hand rules. | ||||||||||
virtual const Matrix4 & | getProjectionMatrix (void) const | |||||||||
Gets the normal projection matrix for this frustum, ie the projection matrix which conforms to standard right-handed rules and uses depth range [-1,+1]. | ||||||||||
virtual void | calcViewMatrixRelative (const Vector3 &relPos, Matrix4 &matToUpdate) const | |||||||||
Calculate a view matrix for this frustum, relative to a potentially dynamic point. | ||||||||||
virtual void | setCustomViewMatrix (bool enable, const Matrix4 &viewMatrix=Matrix4::IDENTITY) | |||||||||
Set whether to use a custom view matrix on this frustum. | ||||||||||
virtual bool | isCustomViewMatrixEnabled (void) const | |||||||||
Returns whether a custom view matrix is in use. | ||||||||||
virtual void | setCustomProjectionMatrix (bool enable, const Matrix4 &projectionMatrix=Matrix4::IDENTITY) | |||||||||
Set whether to use a custom projection matrix on this frustum. | ||||||||||
virtual bool | isCustomProjectionMatrixEnabled (void) const | |||||||||
Returns whether a custom projection matrix is in use. | ||||||||||
virtual const Plane * | getFrustumPlanes (void) const | |||||||||
Retrieves the clipping planes of the frustum (world space). | ||||||||||
virtual bool | isVisible (void) const | |||||||||
Returns whether or not this object is supposed to be visible or not. | ||||||||||
uint32 | getTypeFlags (void) const | |||||||||
Overridden from MovableObject::getTypeFlags. | ||||||||||
const AxisAlignedBox & | getBoundingBox (void) const | |||||||||
Overridden from MovableObject. | ||||||||||
void | _updateRenderQueue (RenderQueue *queue) | |||||||||
Overridden from MovableObject. | ||||||||||
void | _notifyCurrentCamera (Camera *cam) | |||||||||
Overridden from MovableObject. | ||||||||||
const MaterialPtr & | getMaterial (void) const | |||||||||
Overridden from Renderable. | ||||||||||
void | getRenderOperation (RenderOperation &op) | |||||||||
Overridden from Renderable. | ||||||||||
void | getWorldTransforms (Matrix4 *xform) const | |||||||||
Overridden from Renderable. | ||||||||||
Real | getSquaredViewDepth (const Camera *cam) const | |||||||||
Overridden from Renderable. | ||||||||||
const LightList & | getLights (void) const | |||||||||
Overridden from Renderable. | ||||||||||
virtual void | setProjectionType (ProjectionType pt) | |||||||||
Sets the type of projection to use (orthographic or perspective). | ||||||||||
virtual ProjectionType | getProjectionType (void) const | |||||||||
Retrieves info on the type of projection used (orthographic or perspective). | ||||||||||
virtual void | setOrthoWindow (Real w, Real h) | |||||||||
Sets the orthographic window settings, for use with orthographic rendering only. | ||||||||||
virtual void | setOrthoWindowHeight (Real h) | |||||||||
Sets the orthographic window height, for use with orthographic rendering only. | ||||||||||
virtual void | setOrthoWindowWidth (Real w) | |||||||||
Sets the orthographic window width, for use with orthographic rendering only. | ||||||||||
virtual Real | getOrthoWindowHeight () const | |||||||||
Gets the orthographic window height, for use with orthographic rendering only. | ||||||||||
virtual Real | getOrthoWindowWidth () const | |||||||||
Gets the orthographic window width, for use with orthographic rendering only. | ||||||||||
virtual void | enableReflection (const Plane &p) | |||||||||
Modifies this frustum so it always renders from the reflection of itself through the plane specified. | ||||||||||
virtual void | enableReflection (const MovablePlane *p) | |||||||||
Modifies this frustum so it always renders from the reflection of itself through the plane specified. | ||||||||||
virtual void | disableReflection (void) | |||||||||
Disables reflection modification previously turned on with enableReflection. | ||||||||||
virtual bool | isReflected (void) const | |||||||||
Returns whether this frustum is being reflected. | ||||||||||
virtual const Matrix4 & | getReflectionMatrix (void) const | |||||||||
Returns the reflection matrix of the frustum if appropriate. | ||||||||||
virtual const Plane & | getReflectionPlane (void) const | |||||||||
Returns the reflection plane of the frustum if appropriate. | ||||||||||
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. | ||||||||||
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. | ||||||||||
virtual void | disableCustomNearClipPlane (void) | |||||||||
Disables any custom near clip plane. | ||||||||||
virtual bool | isCustomNearClipPlaneEnabled (void) const | |||||||||
Is a custom near clip plane in use? | ||||||||||
void | visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false) | |||||||||
| ||||||||||
virtual void | _notifyCreator (MovableObjectFactory *fact) | |||||||||
Notify the object of it's creator (internal use only). | ||||||||||
virtual MovableObjectFactory * | _getCreator (void) const | |||||||||
Get the creator of this object, if any (internal use only). | ||||||||||
virtual void | _notifyManager (SceneManager *man) | |||||||||
Notify the object of it's manager (internal use only). | ||||||||||
virtual SceneManager * | _getManager (void) const | |||||||||
Get the manager of this object, if any (internal use only). | ||||||||||
virtual Node * | getParentNode (void) const | |||||||||
Returns the node to which this object is attached. | ||||||||||
virtual SceneNode * | getParentSceneNode (void) const | |||||||||
Returns the scene node to which this object is attached. | ||||||||||
virtual void | _notifyAttached (Node *parent, bool isTagPoint=false) | |||||||||
Internal method called to notify the object that it has been attached to a node. | ||||||||||
virtual bool | isAttached (void) const | |||||||||
Returns true if this object is attached to a SceneNode or TagPoint. | ||||||||||
virtual void | detatchFromParent (void) | |||||||||
Detaches an object from a parent SceneNode or TagPoint, if attached. | ||||||||||
virtual bool | isInScene (void) const | |||||||||
Returns true if this object is attached to a SceneNode or TagPoint, and this SceneNode / TagPoint is currently in an active part of the scene graph. | ||||||||||
virtual void | _notifyMoved (void) | |||||||||
Internal method called to notify the object that it has been moved. | ||||||||||
virtual const AxisAlignedBox & | getWorldBoundingBox (bool derive=false) const | |||||||||
Retrieves the axis-aligned bounding box for this object in world coordinates. | ||||||||||
virtual const Sphere & | getWorldBoundingSphere (bool derive=false) const | |||||||||
Retrieves the worldspace bounding sphere for this object. | ||||||||||
virtual void | setVisible (bool visible) | |||||||||
Tells this object whether to be visible or not, if it has a renderable component. | ||||||||||
virtual bool | getVisible (void) const | |||||||||
Gets this object whether to be visible or not, if it has a renderable component. | ||||||||||
virtual void | setRenderingDistance (Real dist) | |||||||||
Sets the distance at which the object is no longer rendered. | ||||||||||
virtual Real | getRenderingDistance (void) const | |||||||||
Gets the distance at which batches are no longer rendered. | ||||||||||
virtual void | setUserObject (UserDefinedObject *obj) | |||||||||
Call this to associate your own custom user object instance with this MovableObject. | ||||||||||
virtual UserDefinedObject * | getUserObject (void) | |||||||||
Retrieves a pointer to a custom application object associated with this movable by an earlier call to setUserObject. | ||||||||||
virtual void | setUserAny (const Any &anything) | |||||||||
Sets any kind of user value on this object. | ||||||||||
virtual void | setUserAny (const Any &anything) | |||||||||
Sets any kind of user value on this object. | ||||||||||
virtual const Any & | getUserAny (void) const | |||||||||
Retrieves the custom user value associated with this object. | ||||||||||
virtual const Any & | getUserAny (void) const | |||||||||
Retrieves the custom user value associated with this object. | ||||||||||
virtual void | setRenderQueueGroup (uint8 queueID) | |||||||||
Sets the render queue group this entity will be rendered through. | ||||||||||
virtual uint8 | getRenderQueueGroup (void) const | |||||||||
Gets the queue group for this entity, see setRenderQueueGroup for full details. | ||||||||||
virtual const Matrix4 & | _getParentNodeFullTransform (void) const | |||||||||
return the full transformation of the parent sceneNode or the attachingPoint node | ||||||||||
virtual void | setQueryFlags (uint32 flags) | |||||||||
Sets the query flags for this object. | ||||||||||
virtual void | addQueryFlags (uint32 flags) | |||||||||
As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. | ||||||||||
virtual void | removeQueryFlags (unsigned long flags) | |||||||||
As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. | ||||||||||
virtual uint32 | getQueryFlags (void) const | |||||||||
Returns the query flags relevant for this object. | ||||||||||
virtual void | setVisibilityFlags (uint32 flags) | |||||||||
Sets the visiblity flags for this object. | ||||||||||
virtual void | addVisibilityFlags (uint32 flags) | |||||||||
As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. | ||||||||||
virtual void | removeVisibilityFlags (uint32 flags) | |||||||||
As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object. | ||||||||||
virtual uint32 | getVisibilityFlags (void) const | |||||||||
Returns the visibility flags relevant for this object. | ||||||||||
virtual void | setListener (Listener *listener) | |||||||||
Sets a listener for this object. | ||||||||||
virtual Listener * | getListener (void) const | |||||||||
Gets the current listener for this object. | ||||||||||
virtual const LightList & | queryLights (void) const | |||||||||
Gets a list of lights, ordered relative to how close they are to this movable object. | ||||||||||
virtual LightList * | _getLightList () | |||||||||
Returns a pointer to the current list of lights for this object. | ||||||||||
EdgeData * | getEdgeList (void) | |||||||||
Define a default implementation of method from ShadowCaster which implements no shadows. | ||||||||||
bool | hasEdgeList (void) | |||||||||
Define a default implementation of method from ShadowCaster which implements no shadows. | ||||||||||
ShadowRenderableListIterator | getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, bool extrudeVertices, Real extrusionDist, unsigned long flags=0) | |||||||||
Define a default implementation of method from ShadowCaster which implements no shadows. | ||||||||||
const AxisAlignedBox & | getLightCapBounds (void) const | |||||||||
Overridden member from ShadowCaster. | ||||||||||
const AxisAlignedBox & | getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const | |||||||||
Overridden member from ShadowCaster. | ||||||||||
void | setCastShadows (bool enabled) | |||||||||
Sets whether or not this object will cast shadows. | ||||||||||
bool | getCastShadows (void) const | |||||||||
Returns whether shadow casting is enabled for this object. | ||||||||||
Real | getPointExtrusionDistance (const Light *l) const | |||||||||
Get the distance to extrude for a point/spot light. | ||||||||||
virtual void | setDebugDisplayEnabled (bool enabled) | |||||||||
Sets whether or not the debug display of this object is enabled. | ||||||||||
virtual bool | isDebugDisplayEnabled (void) const | |||||||||
Gets whether debug display of this object is enabled. | ||||||||||
const StringVector & | getAnimableValueNames (void) const | |||||||||
Gets a list of animable value names for this object. | ||||||||||
virtual AnimableValuePtr | createAnimableValue (const String &valueName) | |||||||||
Create a reference-counted AnimableValuePtr for the named value. | ||||||||||
void * | operator new (size_t sz, const char *file, int line, const char *func) | |||||||||
operator new, with debug line info | ||||||||||
void * | operator new (size_t sz) | |||||||||
void * | operator new (size_t sz, void *ptr) | |||||||||
placement operator new | ||||||||||
void * | operator new[] (size_t sz, const char *file, int line, const char *func) | |||||||||
array operator new, with debug line info | ||||||||||
void * | operator new[] (size_t sz) | |||||||||
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 *) | |||||||||
virtual Technique * | getTechnique (void) const | |||||||||
Retrieves a pointer to the Material Technique this renderable object uses. | ||||||||||
virtual bool | preRender (SceneManager *sm, RenderSystem *rsys) | |||||||||
Called just prior to the Renderable being rendered. | ||||||||||
virtual void | postRender (SceneManager *sm, RenderSystem *rsys) | |||||||||
Called immediately after the Renderable has been rendered. | ||||||||||
virtual unsigned short | getNumWorldTransforms (void) const | |||||||||
Returns the number of world transform matrices this renderable requires. | ||||||||||
void | setUseIdentityProjection (bool useIdentityProjection) | |||||||||
Sets whether or not to use an 'identity' projection. | ||||||||||
bool | getUseIdentityProjection (void) const | |||||||||
Returns whether or not to use an 'identity' projection. | ||||||||||
void | setUseIdentityView (bool useIdentityView) | |||||||||
Sets whether or not to use an 'identity' view. | ||||||||||
bool | getUseIdentityView (void) const | |||||||||
Returns whether or not to use an 'identity' view. | ||||||||||
virtual bool | getCastsShadows (void) const | |||||||||
Method which reports whether this renderable would normally cast a shadow. | ||||||||||
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. | ||||||||||
const Vector4 & | getCustomParameter (size_t index) const | |||||||||
Gets the custom value associated with this Renderable at the given index. | ||||||||||
virtual void | _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const | |||||||||
Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows. | ||||||||||
virtual void | setPolygonModeOverrideable (bool override) | |||||||||
Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. | ||||||||||
virtual bool | getPolygonModeOverrideable (void) const | |||||||||
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. | ||||||||||
virtual RenderSystemData * | getRenderSystemData () const | |||||||||
Sets render system private data. | ||||||||||
virtual void | setRenderSystemData (RenderSystemData *val) const | |||||||||
gets render system private data | ||||||||||
Static Public Member Functions | ||||||||||
static void | setDefaultQueryFlags (uint32 flags) | |||||||||
Set the default query flags for all future MovableObject instances. | ||||||||||
static uint32 | getDefaultQueryFlags () | |||||||||
Get the default query flags for all future MovableObject instances. | ||||||||||
static void | setDefaultVisibilityFlags (uint32 flags) | |||||||||
Set the default visibility flags for all future MovableObject instances. | ||||||||||
static uint32 | getDefaultVisibilityFlags () | |||||||||
Get the default visibility flags for all future MovableObject instances. | ||||||||||
static void | extrudeVertices (const HardwareVertexBufferSharedPtr &vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist) | |||||||||
Utility method for extruding vertices based on a light. | ||||||||||
Static Public Attributes | ||||||||||
static const Real | INFINITE_FAR_PLANE_ADJUST | |||||||||
Small constant used to reduce far plane projection to avoid inaccuracies. | ||||||||||
Protected Types | ||||||||||
typedef std::map< String, StringVector > | AnimableDictionaryMap | |||||||||
typedef std::map< size_t, Vector4 > | CustomParameterMap | |||||||||
Protected Member Functions | ||||||||||
bool | isViewOutOfDate (void) const | |||||||||
void | invalidateFrustum (void) const | |||||||||
Signal to update frustum information. | ||||||||||
void | invalidateView (void) const | |||||||||
Signal to update view information. | ||||||||||
virtual void | setWindowImpl (void) const | |||||||||
Do actual window setting, using parameters set in SetWindow call. | ||||||||||
virtual std::vector< Vector4 > | getRayForwardIntersect (const Vector3 &anchor, const Vector3 *dir, Real planeOffset) const | |||||||||
Helper function for forwardIntersect that intersects rays with canonical plane. | ||||||||||
virtual void | calcProjectionParameters (Real &left, Real &right, Real &bottom, Real &top) const | |||||||||
virtual void | updateFrustum (void) const | |||||||||
Update frustum if out of date. | ||||||||||
virtual void | updateView (void) const | |||||||||
Update view if out of date. | ||||||||||
virtual void | updateFrustumImpl (void) const | |||||||||
Implementation of updateFrustum (called if out of date). | ||||||||||
virtual void | updateViewImpl (void) const | |||||||||
Implementation of updateView (called if out of date). | ||||||||||
virtual void | updateFrustumPlanes (void) const | |||||||||
virtual void | updateFrustumPlanesImpl (void) const | |||||||||
Implementation of updateFrustumPlanes (called if out of date). | ||||||||||
virtual void | updateWorldSpaceCorners (void) const | |||||||||
virtual void | updateWorldSpaceCornersImpl (void) const | |||||||||
Implementation of updateWorldSpaceCorners (called if out of date). | ||||||||||
virtual void | updateVertexData (void) const | |||||||||
virtual bool | isFrustumOutOfDate (void) const | |||||||||
Real | getExtrusionDistance (const Vector3 &objectPos, const Light *light) const | |||||||||
Helper method for calculating extrusion distance. | ||||||||||
virtual void | updateEdgeListLightFacing (EdgeData *edgeData, const Vector4 &lightPos) | |||||||||
Tells the caster to perform the tasks necessary to update the edge data's light listing. | ||||||||||
virtual void | generateShadowVolume (EdgeData *edgeData, const HardwareIndexBufferSharedPtr &indexBuffer, const Light *light, ShadowRenderableList &shadowRenderables, unsigned long flags) | |||||||||
Generates the indexes required to render a shadow volume into the index buffer which is passed in, and updates shadow renderables to use it. | ||||||||||
virtual void | extrudeBounds (AxisAlignedBox &box, const Vector4 &lightPos, Real extrudeDist) const | |||||||||
Utility method for extruding a bounding box. | ||||||||||
virtual const String & | getAnimableDictionaryName (void) const | |||||||||
Get the name of the animable dictionary for this class. | ||||||||||
void | createAnimableDictionary (void) const | |||||||||
Internal method for creating a dictionary of animable value names for the class, if it does not already exist. | ||||||||||
StringVector & | _getAnimableValueNames (void) | |||||||||
Get an updateable reference to animable value list. | ||||||||||
virtual void | initialiseAnimableDictionary (StringVector &) const | |||||||||
Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters. | ||||||||||
Protected Attributes | ||||||||||
String | mName | |||||||||
Camera name. | ||||||||||
SceneManager * | mSceneMgr | |||||||||
Scene manager responsible for the scene. | ||||||||||
Quaternion | mOrientation | |||||||||
Camera orientation, quaternion style. | ||||||||||
Vector3 | mPosition | |||||||||
Camera position - default (0,0,0). | ||||||||||
Quaternion | mDerivedOrientation | |||||||||
Derived orientation/position of the camera, including reflection. | ||||||||||
Vector3 | mDerivedPosition | |||||||||
Quaternion | mRealOrientation | |||||||||
Real world orientation/position of the camera. | ||||||||||
Vector3 | mRealPosition | |||||||||
bool | mYawFixed | |||||||||
Whether to yaw around a fixed axis. | ||||||||||
Vector3 | mYawFixedAxis | |||||||||
Fixed axis to yaw around. | ||||||||||
PolygonMode | mSceneDetail | |||||||||
Rendering type. | ||||||||||
unsigned int | mVisFacesLastRender | |||||||||
Stored number of visible faces in the last render. | ||||||||||
unsigned int | mVisBatchesLastRender | |||||||||
Stored number of visible faces in the last render. | ||||||||||
SceneNode * | mAutoTrackTarget | |||||||||
SceneNode which this Camera will automatically track. | ||||||||||
Vector3 | mAutoTrackOffset | |||||||||
Tracking offset for fine tuning. | ||||||||||
Real | mSceneLodFactor | |||||||||
Real | mSceneLodFactorInv | |||||||||
Inverted scene LOD factor, can be used by Renderables to adjust their LOD. | ||||||||||
Real | mWLeft | |||||||||
Viewing window. | ||||||||||
Real | mWTop | |||||||||
Viewing window. | ||||||||||
Real | mWRight | |||||||||
Viewing window. | ||||||||||
Real | mWBottom | |||||||||
Viewing window. | ||||||||||
bool | mWindowSet | |||||||||
Is viewing window used. | ||||||||||
std::vector< Plane > | mWindowClipPlanes | |||||||||
Windowed viewport clip planes. | ||||||||||
bool | mRecalcWindow | |||||||||
Viewport * | mLastViewport | |||||||||
The last viewport to be added using this camera. | ||||||||||
bool | mAutoAspectRatio | |||||||||
Whether aspect ratio will automatically be recalculated when a viewport changes its size. | ||||||||||
Frustum * | mCullFrustum | |||||||||
Custom culling frustum. | ||||||||||
bool | mUseRenderingDistance | |||||||||
Whether or not the rendering distance of objects should take effect for this camera. | ||||||||||
const Camera * | mLodCamera | |||||||||
Camera to use for LOD calculation. | ||||||||||
ProjectionType | mProjType | |||||||||
Orthographic or perspective? | ||||||||||
Radian | mFOVy | |||||||||
y-direction field-of-view (default 45) | ||||||||||
Real | mFarDist | |||||||||
Far clip distance - default 10000. | ||||||||||
Real | mNearDist | |||||||||
Near clip distance - default 100. | ||||||||||
Real | mAspect | |||||||||
x/y viewport ratio - default 1.3333 | ||||||||||
Real | mOrthoHeight | |||||||||
Ortho height size (world units). | ||||||||||
Vector2 | mFrustumOffset | |||||||||
Off-axis frustum center offset - default (0.0, 0.0). | ||||||||||
Real | mFocalLength | |||||||||
Focal length of frustum (for stereo rendering, defaults to 1.0). | ||||||||||
Plane | mFrustumPlanes [6] | |||||||||
The 6 main clipping planes. | ||||||||||
Quaternion | mLastParentOrientation | |||||||||
Stored versions of parent orientation / position. | ||||||||||
Vector3 | mLastParentPosition | |||||||||
Matrix4 | mProjMatrixRS | |||||||||
Pre-calced projection matrix for the specific render system. | ||||||||||
Matrix4 | mProjMatrixRSDepth | |||||||||
Pre-calced standard projection matrix but with render system depth range. | ||||||||||
Matrix4 | mProjMatrix | |||||||||
Pre-calced standard projection matrix. | ||||||||||
Matrix4 | mViewMatrix | |||||||||
Pre-calced view matrix. | ||||||||||
bool | mRecalcFrustum | |||||||||
Something's changed in the frustum shape? | ||||||||||
bool | mRecalcView | |||||||||
Something re the view pos has changed. | ||||||||||
bool | mRecalcFrustumPlanes | |||||||||
Something re the frustum planes has changed. | ||||||||||
bool | mRecalcWorldSpaceCorners | |||||||||
Something re the world space corners has changed. | ||||||||||
bool | mRecalcVertexData | |||||||||
Something re the vertex data has changed. | ||||||||||
bool | mCustomViewMatrix | |||||||||
Are we using a custom view matrix? | ||||||||||
bool | mCustomProjMatrix | |||||||||
Are we using a custom projection matrix? | ||||||||||
bool | mFrustumExtentsManuallySet | |||||||||
Have the frustum extents been manually set? | ||||||||||
Real | mLeft | |||||||||
Frustum extents. | ||||||||||
Real | mRight | |||||||||
Frustum extents. | ||||||||||
Real | mTop | |||||||||
Frustum extents. | ||||||||||
Real | mBottom | |||||||||
Frustum extents. | ||||||||||
AxisAlignedBox | mBoundingBox | |||||||||
VertexData | mVertexData | |||||||||
MaterialPtr | mMaterial | |||||||||
Vector3 | mWorldSpaceCorners [8] | |||||||||
bool | mReflect | |||||||||
Is this frustum to act as a reflection of itself? | ||||||||||
Matrix4 | mReflectMatrix | |||||||||
Derived reflection matrix. | ||||||||||
Plane | mReflectPlane | |||||||||
Fixed reflection plane. | ||||||||||
const MovablePlane * | mLinkedReflectPlane | |||||||||
Pointer to a reflection plane (automatically updated). | ||||||||||
Plane | mLastLinkedReflectionPlane | |||||||||
Record of the last world-space reflection plane info used. | ||||||||||
bool | mObliqueDepthProjection | |||||||||
Is this frustum using an oblique depth projection? | ||||||||||
Plane | mObliqueProjPlane | |||||||||
Fixed oblique projection plane. | ||||||||||
const MovablePlane * | mLinkedObliqueProjPlane | |||||||||
Pointer to oblique projection plane (automatically updated). | ||||||||||
Plane | mLastLinkedObliqueProjPlane | |||||||||
Record of the last world-space oblique depth projection plane info used. | ||||||||||
MovableObjectFactory * | mCreator | |||||||||
Creator of this object (if created by a factory). | ||||||||||
SceneManager * | mManager | |||||||||
SceneManager holding this object (if applicable). | ||||||||||
Node * | mParentNode | |||||||||
node to which this object is attached | ||||||||||
bool | mParentIsTagPoint | |||||||||
bool | mVisible | |||||||||
Is this object visible? | ||||||||||
bool | mDebugDisplay | |||||||||
Is debug display enabled? | ||||||||||
Real | mUpperDistance | |||||||||
Upper distance to still render. | ||||||||||
Real | mSquaredUpperDistance | |||||||||
bool | mBeyondFarDistance | |||||||||
Hidden because of distance? | ||||||||||
Any | mUserAny | |||||||||
User defined link to another object / value / whatever. | ||||||||||
Any | mUserAny | |||||||||
uint8 | mRenderQueueID | |||||||||
The render queue to use when rendering this object. | ||||||||||
bool | mRenderQueueIDSet | |||||||||
Flags whether the RenderQueue's default should be used. | ||||||||||
uint32 | mQueryFlags | |||||||||
Flags determining whether this object is included / excluded from scene queries. | ||||||||||
uint32 | mVisibilityFlags | |||||||||
Flags determining whether this object is visible (compared to SceneManager mask). | ||||||||||
AxisAlignedBox | mWorldAABB | |||||||||
Cached world AABB of this object. | ||||||||||
Sphere | mWorldBoundingSphere | |||||||||
AxisAlignedBox | mWorldDarkCapBounds | |||||||||
World space AABB of this object's dark cap. | ||||||||||
bool | mCastShadows | |||||||||
Does this object cast shadows? | ||||||||||
bool | mRenderingDisabled | |||||||||
Does rendering this object disabled by listener? | ||||||||||
Listener * | mListener | |||||||||
MovableObject listener - only one allowed (no list) for size & performance reasons. */. | ||||||||||
LightList | mLightList | |||||||||
List of lights for this object. | ||||||||||
ulong | mLightListUpdated | |||||||||
The last frame that this light list was updated in. | ||||||||||
CustomParameterMap | mCustomParameters | |||||||||
bool | mPolygonModeOverrideable | |||||||||
bool | mUseIdentityProjection | |||||||||
bool | mUseIdentityView | |||||||||
RenderSystemData * | mRenderSystemData | |||||||||
Static Protected Attributes | ||||||||||
static String | msMovableType | |||||||||
Shared class-level name for Movable type. | ||||||||||
static uint32 | msDefaultQueryFlags | |||||||||
Default query flags. | ||||||||||
static uint32 | msDefaultVisibilityFlags | |||||||||
Default visibility flags. | ||||||||||
static AnimableDictionaryMap | msAnimableDictionary | |||||||||
Static map of class name to list of animable value names. | ||||||||||
Friends | ||||||||||
_OgreExport friend std::ostream & | operator<< (std::ostream &o, const Camera &c) | |||||||||
Function for outputting to a stream. |
Definition at line 81 of file OgreCamera.h.
|
Definition at line 234 of file OgreAnimable.h. |
|
Definition at line 371 of file OgreRenderable.h. |
|
Definition at line 123 of file OgreShadowCaster.h. |
|
Definition at line 124 of file OgreShadowCaster.h. |
|
Standard constructor.
|
|
Standard destructor.
|
|
Internal method used by OGRE to update auto-tracking cameras.
|
|
Get an updateable reference to animable value list.
Definition at line 260 of file OgreAnimable.h. References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT. |
|
Get the creator of this object, if any (internal use only).
Definition at line 171 of file OgreMovableObject.h. |
|
Returns a pointer to the current list of lights for this object.
Definition at line 428 of file OgreMovableObject.h. |
|
Internal method for OGRE to use for LOD calculations.
|
|
Get the manager of this object, if any (internal use only).
Definition at line 175 of file OgreMovableObject.h. |
|
Internal method to retrieve the number of visible batches in the last render.
|
|
Internal method to retrieve the number of visible faces in the last render.
|
|
return the full transformation of the parent sceneNode or the attachingPoint node
|
|
Internal method called to notify the object that it has been attached to a node.
Reimplemented in Ogre::Entity, Ogre::Light, and Ogre::ParticleSystem. |
|
Notify the object of it's creator (internal use only).
Definition at line 169 of file OgreMovableObject.h. |
|
Overridden from MovableObject.
Reimplemented from Ogre::MovableObject. |
|
Notify the object of it's manager (internal use only).
Definition at line 173 of file OgreMovableObject.h. |
|
Internal method called to notify the object that it has been moved.
Reimplemented in Ogre::Light. |
|
Internal method to notify camera of the visible batches in the last render.
|
|
Internal method to notify camera of the visible faces in the last render.
|
|
Notifies this camera that a viewport is using it.
Definition at line 530 of file OgreCamera.h. |
|
Tells the Camera to contact the SceneManager to render from it's viewpoint.
|
|
Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.
Reimplemented in Ogre::SubEntity. Definition at line 279 of file OgreRenderable.h. References Ogre::GpuProgramParameters::_writeRawConstant(), Ogre::GpuProgramParameters::AutoConstantEntry::data, Ogre::GpuProgramParameters::AutoConstantEntry::elementCount, and Ogre::GpuProgramParameters::AutoConstantEntry::physicalIndex. |
|
Overridden from MovableObject.
Implements Ogre::MovableObject. |
|
As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object.
Definition at line 346 of file OgreMovableObject.h. |
|
As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object.
Definition at line 374 of file OgreMovableObject.h. |
|
|
|
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) |
|
Internal method for creating a dictionary of animable value names for the class, if it does not already exist.
Definition at line 247 of file OgreAnimable.h. |
|
Create a reference-counted AnimableValuePtr for the named value.
Reimplemented in Ogre::Light. Definition at line 313 of file OgreAnimable.h. References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT. |
|
Detaches an object from a parent SceneNode or TagPoint, if attached.
|
|
Disables any custom near clip plane.
|
|
Disables reflection modification previously turned on with enableReflection.
|
|
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.
|
|
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.
|
|
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.
|
|
Modifies this frustum so it always renders from the reflection of itself through the plane specified.
|
|
Utility method for extruding a bounding box.
|
|
Utility method for extruding vertices based on a light.
|
|
Forward projects frustum rays to find forward intersection with plane.
|
|
Generates the indexes required to render a shadow volume into the index buffer which is passed in, and updates shadow renderables to use it.
|
|
Get the name of the animable dictionary for this class.
Reimplemented in Ogre::Light. Definition at line 242 of file OgreAnimable.h. References Ogre::StringUtil::BLANK. |
|
Gets a list of animable value names for this object.
Definition at line 288 of file OgreAnimable.h. References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT. |
|
Retreives the current aspect ratio.
|
|
Retrieves if AutoAspectRatio is currently set or not.
|
|
Get the auto tracking offset for this camera, if it is auto tracking.
Definition at line 521 of file OgreCamera.h. |
|
Get the auto tracking target for this camera, if any.
Definition at line 519 of file OgreCamera.h. |
|
Overridden from MovableObject.
Implements Ogre::MovableObject. |
|
Overridden from MovableObject.
Reimplemented from Ogre::Frustum. |
|
Gets a world-space list of planes enclosing a volume based on a viewport rectangle.
|
|
Gets a world-space list of planes enclosing a volume based on a viewport rectangle.
|
|
Gets a world space ray as cast from the camera through a viewport position.
|
|
Gets a world space ray as cast from the camera through a viewport position.
|
|
Returns whether shadow casting is enabled for this object.
Implements Ogre::ShadowCaster. Definition at line 458 of file OgreMovableObject.h. |
|
Method which reports whether this renderable would normally cast a shadow.
Reimplemented in Ogre::InstancedGeometry::GeometryBucket, Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity. Definition at line 214 of file OgreRenderable.h. |
|
Returns the custom culling frustum in use.
Definition at line 558 of file OgreCamera.h. |
|
Gets the custom value associated with this Renderable at the given index.
Definition at line 240 of file OgreRenderable.h. References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT. |
|
Overridden member from ShadowCaster.
Implements Ogre::ShadowCaster. |
|
Get the default query flags for all future MovableObject instances.
Definition at line 361 of file OgreMovableObject.h. |
|
Get the default visibility flags for all future MovableObject instances.
Definition at line 389 of file OgreMovableObject.h. |
|
Gets the derived direction vector of the camera, including any rotation inherited from a node attachment and reflection matrix.
|
|
Gets the derived orientation of the camera, including any rotation inherited from a node attachment and reflection matrix.
|
|
Gets the derived position of the camera, including any translation inherited from a node attachment and reflection matrix.
Referenced by Ogre::VisibleObjectsBoundsInfo::merge(). |
|
Gets the derived right vector of the camera, including any rotation inherited from a node attachment and reflection matrix.
|
|
Gets the derived up vector of the camera, including any rotation inherited from a node attachment and reflection matrix.
|
|
|
|
Define a default implementation of method from ShadowCaster which implements no shadows.
Implements Ogre::ShadowCaster. Reimplemented in Ogre::Entity, Ogre::ManualObject, and Ogre::StaticGeometry::Region. Definition at line 431 of file OgreMovableObject.h. |
|
Helper method for calculating extrusion distance.
|
|
Reimplemented from Ogre::Frustum. |
|
Returns focal length of frustum.
|
|
Retrieves the frustums Y-dimension Field Of View (FOV).
|
|
Get the extents of the frustum in view space.
|
|
Retrieves the frustum offsets.
|
|
Reimplemented from Ogre::Frustum. |
|
Retrieves the clipping planes of the frustum (world space).
|
|
Overridden member from ShadowCaster.
Implements Ogre::ShadowCaster. |
|
Overridden from Renderable.
Implements Ogre::Renderable. |
|
Gets the current listener for this object.
Definition at line 400 of file OgreMovableObject.h. |
|
Returns the level-of-detail bias factor currently applied to this camera.
|
|
Get a pointer to the camera which should be used to determine LOD settings.
|
|
Overridden from Renderable.
Implements Ogre::Renderable. |
|
Overridden from MovableObject.
Reimplemented from Ogre::Frustum. |
|
Gets the camera's name.
Reimplemented from Ogre::MovableObject. |
|
Reimplemented from Ogre::Frustum. |
|
Returns the number of world transform matrices this renderable requires.
Reimplemented in Ogre::BorderRenderable, Ogre::InstancedGeometry::GeometryBucket, and Ogre::SubEntity. Definition at line 143 of file OgreRenderable.h. |
|
Returns the camera's current orientation.
|
|
Get the derived orientation of this frustum.
Reimplemented from Ogre::Frustum. |
|
Gets the orthographic window height, for use with orthographic rendering only.
|
|
Gets the orthographic window width, for use with orthographic rendering only.
|
|
Returns the node to which this object is attached.
|
|
Returns the scene node to which this object is attached.
|
|
Get the distance to extrude for a point/spot light.
Implements Ogre::ShadowCaster. |
|
Retrieves the level of detail that the camera will render.
|
|
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
Reimplemented in Ogre::BorderRenderable. Definition at line 304 of file OgreRenderable.h. |
|
Retrieves the camera's position.
|
|
Get the derived position of this frustum.
Reimplemented from Ogre::Frustum. |
|
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].
|
|
Gets the projection matrix for this frustum adjusted for the current rendersystem specifics (may be right or left-handed, depth range may vary).
|
|
Gets the depth-adjusted projection matrix for the current rendersystem, but one which still conforms to right-hand rules.
|
|
Retrieves info on the type of projection used (orthographic or perspective).
|
|
Returns the query flags relevant for this object.
Definition at line 353 of file OgreMovableObject.h. |
|
Helper function for forwardIntersect that intersects rays with canonical plane.
|
|
Gets the real world direction vector of the camera, including any rotation inherited from a node attachment.
|
|
Gets the real world orientation of the camera, including any rotation inherited from a node attachment.
|
|
Gets the real world position of the camera, including any translation inherited from a node attachment.
|
|
Gets the real world right vector of the camera, including any rotation inherited from a node attachment.
|
|
Gets the real world up vector of the camera, including any rotation inherited from a node attachment.
|
|
Returns the reflection matrix of the frustum if appropriate.
Definition at line 545 of file OgreFrustum.h. |
|
Returns the reflection plane of the frustum if appropriate.
Definition at line 547 of file OgreFrustum.h. |
|
Gets the distance at which batches are no longer rendered.
Definition at line 286 of file OgreMovableObject.h. |
|
Overridden from Renderable.
Implements Ogre::Renderable. |
|
Gets the queue group for this entity, see setRenderQueueGroup for full details.
|
|
Sets render system private data.
Definition at line 356 of file OgreRenderable.h. |
|
Gets the camera's right vector.
|
|
Returns a pointer to the SceneManager this camera is rendering through.
|
|
Define a default implementation of method from ShadowCaster which implements no shadows.
Implements Ogre::ShadowCaster. Reimplemented in Ogre::Entity, Ogre::ManualObject, and Ogre::StaticGeometry::Region. |
|
Overridden from Renderable.
Implements Ogre::Renderable. |
|
Retrieves a pointer to the Material Technique this renderable object uses.
Reimplemented in Ogre::InstancedGeometry::GeometryBucket, Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity. Definition at line 87 of file OgreRenderable.h. |
|
Overridden from MovableObject::getTypeFlags.
Reimplemented from Ogre::MovableObject. |
|
Gets the camera's up vector.
|
|
Returns whether or not to use an 'identity' projection.
Definition at line 168 of file OgreRenderable.h. |
|
Returns whether or not to use an 'identity' view.
Definition at line 193 of file OgreRenderable.h. |
|
Retrieves the custom user value associated with this object.
Definition at line 319 of file OgreRenderable.h. |
|
Retrieves the custom user value associated with this object.
Definition at line 314 of file OgreMovableObject.h. |
|
Get whether this camera should use the 'rendering distance' on objects to exclude distant objects from the final image.
Definition at line 603 of file OgreCamera.h. |
|
Retrieves a pointer to a custom application object associated with this movable by an earlier call to setUserObject.
Definition at line 298 of file OgreMovableObject.h. |
|
Specialised version of getViewMatrix allowing caller to differentiate whether the custom culling frustum should be allowed or not.
|
|
Mainly for use by OGRE internally.
Reimplemented from Ogre::Frustum. |
|
Get the last viewport which was attached to this camera.
Definition at line 528 of file OgreCamera.h. |
|
Returns the visibility flags relevant for this object.
Definition at line 381 of file OgreMovableObject.h. |
|
Gets this object whether to be visible or not, if it has a renderable component.
|
|
Gets the window clip planes, only applicable if isWindowSet == true.
|
|
Retrieves the axis-aligned bounding box for this object in world coordinates.
Implements Ogre::ShadowCaster. Reimplemented in Ogre::Entity. |
|
Retrieves the worldspace bounding sphere for this object.
Reimplemented in Ogre::Entity. |
|
Reimplemented from Ogre::Frustum. |
|
Overridden from Renderable.
Implements Ogre::Renderable. |
|
Define a default implementation of method from ShadowCaster which implements no shadows.
Implements Ogre::ShadowCaster. Reimplemented in Ogre::Entity, Ogre::ManualObject, and Ogre::StaticGeometry::Region. Definition at line 433 of file OgreMovableObject.h. |
|
Internal method for initialising dictionary; should be implemented by subclasses wanting to expose animable parameters.
Reimplemented in Ogre::Light. Definition at line 280 of file OgreAnimable.h. |
|
Signal to update frustum information.
Reimplemented from Ogre::Frustum. |
|
Signal to update view information.
Reimplemented from Ogre::Frustum. |
|
Returns true if this object is attached to a SceneNode or TagPoint.
|
|
Is a custom near clip plane in use?
Definition at line 612 of file OgreFrustum.h. |
|
Returns whether a custom projection matrix is in use.
Definition at line 394 of file OgreFrustum.h. |
|
Returns whether a custom view matrix is in use.
Definition at line 369 of file OgreFrustum.h. |
|
Gets whether debug display of this object is enabled.
Definition at line 497 of file OgreMovableObject.h. |
|
|
|
Returns true if this object is attached to a SceneNode or TagPoint, and this SceneNode / TagPoint is currently in an active part of the scene graph.
|
|
Returns whether this frustum is being reflected.
Definition at line 543 of file OgreFrustum.h. |
|
Reimplemented from Ogre::Frustum. |
|
Returns whether or not this object is supposed to be visible or not.
Reimplemented in Ogre::InstancedGeometry::BatchInstance, and Ogre::StaticGeometry::Region. |
|
Reimplemented from Ogre::Frustum. |
|
Reimplemented from Ogre::Frustum. |
|
Reimplemented from Ogre::Frustum. |
|
Returns if a viewport window is being used.
Definition at line 512 of file OgreCamera.h. |
|
Points the camera at a location in worldspace.
|
|
Points the camera at a location in worldspace.
|
|
Moves the camera's position by the vector offset provided along world axes.
|
|
Moves the camera's position by the vector offset provided along it's own axes (relative to orientation).
|
|
Definition at line 101 of file OgreMemoryAllocatedObject.h. |
|
Definition at line 95 of file OgreMemoryAllocatedObject.h. |
|
Definition at line 89 of file OgreMemoryAllocatedObject.h. |
|
Definition at line 112 of file OgreMemoryAllocatedObject.h. |
|
Definition at line 106 of file OgreMemoryAllocatedObject.h. |
|
placement operator new
Definition at line 73 of file OgreMemoryAllocatedObject.h. |
|
Definition at line 67 of file OgreMemoryAllocatedObject.h. |
|
operator new, with debug line info
Definition at line 62 of file OgreMemoryAllocatedObject.h. |
|
Definition at line 84 of file OgreMemoryAllocatedObject.h. |
|
array operator new, with debug line info
Definition at line 79 of file OgreMemoryAllocatedObject.h. |
|
Pitches the camera up/down anticlockwise around it's local z axis.
|
|
Called immediately after the Renderable has been rendered.
Definition at line 119 of file OgreRenderable.h. |
|
Called just prior to the Renderable being rendered.
Definition at line 116 of file OgreRenderable.h. |
|
Reimplemented from Ogre::Frustum. |
|
Gets a list of lights, ordered relative to how close they are to this movable object.
|
|
As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object.
Definition at line 350 of file OgreMovableObject.h. |
|
As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object.
Definition at line 378 of file OgreMovableObject.h. |
|
Reset the frustum extents to be automatically derived from other params.
|
|
Cancel view window.
|
|
Rolls the camera anticlockwise, around its local z axis.
|
|
Rotate the camera around an arbitrary axis using a Quaternion.
|
|
Rotate the camera around an arbitrary axis.
|
|
Sets the aspect ratio for the frustum viewport.
|
|
If set to true a viewport that owns this frustum will be able to recalculate the aspect ratio whenever the frustum is resized.
|
|
Enables / disables automatic tracking of a SceneNode.
|
|
Sets whether or not this object will cast shadows.
Definition at line 456 of file OgreMovableObject.h. |
|
Tells the camera to use a separate Frustum instance to perform culling.
Definition at line 556 of file OgreCamera.h. |
|
Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters.
Definition at line 231 of file OgreRenderable.h. |
|
Set whether to use a custom projection matrix on this frustum.
|
|
Set whether to use a custom view matrix on this frustum.
|
|
Sets whether or not the debug display of this object is enabled.
Definition at line 495 of file OgreMovableObject.h. |
|
Set the default query flags for all future MovableObject instances.
Definition at line 357 of file OgreMovableObject.h. |
|
Set the default visibility flags for all future MovableObject instances.
Definition at line 385 of file OgreMovableObject.h. |
|
Sets the camera's direction vector.
|
|
Sets the camera's direction vector.
|
|
Sets the distance to the far clipping plane.
|
|
Tells the camera whether to yaw around it's own local Y axis or a fixed axis of choice.
|
|
Sets frustum focal length (used in stereo rendering).
|
|
Sets the Y-dimension Field Of View (FOV) of the frustum.
|
|
Manually set the extents of the frustum.
|
|
Sets frustum offsets, used in stereo rendering.
|
|
Sets frustum offsets, used in stereo rendering.
|
|
Sets a listener for this object.
Definition at line 396 of file OgreMovableObject.h. |
|
Sets the level-of-detail factor for this Camera.
|
|
Get a pointer to the camera which should be used to determine LOD settings.
|
|
Sets the position of the near clipping plane.
|
|
Sets the camera's orientation.
|
|
Sets the orthographic window settings, for use with orthographic rendering only.
|
|
Sets the orthographic window height, for use with orthographic rendering only.
|
|
Sets the orthographic window width, for use with orthographic rendering only.
|
|
Sets the level of rendering detail required from this camera.
|
|
Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
Definition at line 296 of file OgreRenderable.h. |
|
Sets the camera's position.
|
|
Sets the camera's position.
|
|
Sets the type of projection to use (orthographic or perspective). Default is perspective. |
|
Sets the query flags for this object.
Definition at line 342 of file OgreMovableObject.h. |
|
Sets the distance at which the object is no longer rendered.
Definition at line 280 of file OgreMovableObject.h. |
|
Sets the render queue group this entity will be rendered through.
Reimplemented in Ogre::Entity, and Ogre::ParticleSystem. |
|
gets render system private data
Definition at line 364 of file OgreRenderable.h. |
|
Sets whether or not to use an 'identity' projection.
Definition at line 154 of file OgreRenderable.h. |
|
Sets whether or not to use an 'identity' view.
Definition at line 179 of file OgreRenderable.h. |
|
Sets any kind of user value on this object.
Definition at line 315 of file OgreRenderable.h. |
|
Sets any kind of user value on this object.
Definition at line 310 of file OgreMovableObject.h. |
|
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.
Definition at line 599 of file OgreCamera.h. |
|
Call this to associate your own custom user object instance with this MovableObject.
Definition at line 294 of file OgreMovableObject.h. |
|
Sets the visiblity flags for this object.
Definition at line 370 of file OgreMovableObject.h. |
|
Tells this object whether to be visible or not, if it has a renderable component.
Reimplemented in Ogre::Light. |
|
Sets the viewing window inside of viewport.
|
|
Do actual window setting, using parameters set in SetWindow call.
|
|
Synchronise core camera settings with another.
|
|
Tells the caster to perform the tasks necessary to update the edge data's light listing. Can be overridden if the subclass needs to do additional things.
|
|
Update frustum if out of date.
|
|
Implementation of updateFrustum (called if out of date).
|
|
|
|
Implementation of updateFrustumPlanes (called if out of date).
|
|
|
|
Update view if out of date.
|
|
Implementation of updateView (called if out of date).
|
|
|
|
Implementation of updateWorldSpaceCorners (called if out of date).
|
|
Implements Ogre::MovableObject. |
|
Rotates the camera anticlockwise around it's local y axis.
|
|
Function for outputting to a stream.
|
|
Small constant used to reduce far plane projection to avoid inaccuracies.
Definition at line 620 of file OgreFrustum.h. |
|
x/y viewport ratio - default 1.3333
Definition at line 78 of file OgreFrustum.h. |
|
Whether aspect ratio will automatically be recalculated when a viewport changes its size.
Definition at line 147 of file OgreCamera.h. |
|
Tracking offset for fine tuning.
Definition at line 123 of file OgreCamera.h. |
|
SceneNode which this Camera will automatically track.
Definition at line 121 of file OgreCamera.h. |
|
Hidden because of distance?
Definition at line 120 of file OgreMovableObject.h. |
|
Frustum extents.
Definition at line 118 of file OgreFrustum.h. |
|
Definition at line 148 of file OgreFrustum.h. |
|
Does this object cast shadows?
Definition at line 138 of file OgreMovableObject.h. |
|
Creator of this object (if created by a factory).
Definition at line 106 of file OgreMovableObject.h. |
|
Custom culling frustum.
Definition at line 149 of file OgreCamera.h. |
|
Definition at line 372 of file OgreRenderable.h. |
|
Are we using a custom projection matrix?
Definition at line 114 of file OgreFrustum.h. |
|
Are we using a custom view matrix?
Definition at line 112 of file OgreFrustum.h. |
|
Is debug display enabled?
Definition at line 115 of file OgreMovableObject.h. |
|
Derived orientation/position of the camera, including reflection.
Definition at line 96 of file OgreCamera.h. |
|
Definition at line 97 of file OgreCamera.h. |
|
Far clip distance - default 10000.
Definition at line 74 of file OgreFrustum.h. |
|
Focal length of frustum (for stereo rendering, defaults to 1.0).
Definition at line 84 of file OgreFrustum.h. |
|
y-direction field-of-view (default 45)
Definition at line 72 of file OgreFrustum.h. |
|
Have the frustum extents been manually set?
Definition at line 116 of file OgreFrustum.h. |
|
Off-axis frustum center offset - default (0.0, 0.0).
Definition at line 82 of file OgreFrustum.h. |
|
The 6 main clipping planes.
Definition at line 87 of file OgreFrustum.h. |
|
Record of the last world-space oblique depth projection plane info used.
Definition at line 172 of file OgreFrustum.h. |
|
Record of the last world-space reflection plane info used.
Definition at line 163 of file OgreFrustum.h. |
|
Stored versions of parent orientation / position.
Definition at line 90 of file OgreFrustum.h. |
|
Definition at line 91 of file OgreFrustum.h. |
|
The last viewport to be added using this camera.
Definition at line 143 of file OgreCamera.h. |
|
Frustum extents.
Definition at line 118 of file OgreFrustum.h. |
|
List of lights for this object.
Reimplemented in Ogre::StaticGeometry::Region. Definition at line 146 of file OgreMovableObject.h. |
|
The last frame that this light list was updated in.
Reimplemented in Ogre::StaticGeometry::Region. Definition at line 148 of file OgreMovableObject.h. |
|
Pointer to oblique projection plane (automatically updated).
Definition at line 170 of file OgreFrustum.h. |
|
Pointer to a reflection plane (automatically updated).
Definition at line 161 of file OgreFrustum.h. |
|
MovableObject listener - only one allowed (no list) for size & performance reasons. */.
Definition at line 143 of file OgreMovableObject.h. |
|
Camera to use for LOD calculation.
Definition at line 153 of file OgreCamera.h. |
|
SceneManager holding this object (if applicable).
Definition at line 108 of file OgreMovableObject.h. |
|
Definition at line 151 of file OgreFrustum.h. |
|
Camera name.
Reimplemented from Ogre::MovableObject. Definition at line 85 of file OgreCamera.h. |
|
Near clip distance - default 100.
Definition at line 76 of file OgreFrustum.h. |
|
Is this frustum using an oblique depth projection?
Definition at line 166 of file OgreFrustum.h. |
|
Fixed oblique projection plane.
Definition at line 168 of file OgreFrustum.h. |
|
Camera orientation, quaternion style.
Definition at line 90 of file OgreCamera.h. |
|
Ortho height size (world units).
Definition at line 80 of file OgreFrustum.h. |
|
Definition at line 111 of file OgreMovableObject.h. |
|
node to which this object is attached
Definition at line 110 of file OgreMovableObject.h. |
|
Definition at line 373 of file OgreRenderable.h. |
|
Camera position - default (0,0,0).
Definition at line 93 of file OgreCamera.h. |
|
Pre-calced standard projection matrix.
Definition at line 98 of file OgreFrustum.h. |
|
Pre-calced projection matrix for the specific render system.
Definition at line 94 of file OgreFrustum.h. |
|
Pre-calced standard projection matrix but with render system depth range.
Definition at line 96 of file OgreFrustum.h. |
|
Orthographic or perspective?
Definition at line 69 of file OgreFrustum.h. |
|
Flags determining whether this object is included / excluded from scene queries.
Definition at line 128 of file OgreMovableObject.h. |
|
Real world orientation/position of the camera.
Definition at line 100 of file OgreCamera.h. |
|
Definition at line 101 of file OgreCamera.h. |
|
Something's changed in the frustum shape?
Definition at line 102 of file OgreFrustum.h. |
|
Something re the frustum planes has changed.
Definition at line 106 of file OgreFrustum.h. |
|
Something re the vertex data has changed.
Definition at line 110 of file OgreFrustum.h. |
|
Something re the view pos has changed.
Definition at line 104 of file OgreFrustum.h. |
|
Definition at line 141 of file OgreCamera.h. |
|
Something re the world space corners has changed.
Definition at line 108 of file OgreFrustum.h. |
|
Is this frustum to act as a reflection of itself?
Definition at line 155 of file OgreFrustum.h. |
|
Derived reflection matrix.
Definition at line 157 of file OgreFrustum.h. |
|
Fixed reflection plane.
Definition at line 159 of file OgreFrustum.h. |
|
Does rendering this object disabled by listener?
Definition at line 141 of file OgreMovableObject.h. |
|
The render queue to use when rendering this object.
Definition at line 124 of file OgreMovableObject.h. |
|
Flags whether the RenderQueue's default should be used.
Definition at line 126 of file OgreMovableObject.h. |
|
Definition at line 377 of file OgreRenderable.h. |
|
Frustum extents.
Definition at line 118 of file OgreFrustum.h. |
|
Static map of class name to list of animable value names.
Definition at line 236 of file OgreAnimable.h. |
|
Rendering type.
Definition at line 109 of file OgreCamera.h. |
|
Definition at line 126 of file OgreCamera.h. |
|
Inverted scene LOD factor, can be used by Renderables to adjust their LOD.
Definition at line 128 of file OgreCamera.h. |
|
Scene manager responsible for the scene.
Definition at line 87 of file OgreCamera.h. |
|
Default query flags.
Definition at line 152 of file OgreMovableObject.h. |
|
Default visibility flags.
Definition at line 154 of file OgreMovableObject.h. |
|
Shared class-level name for Movable type.
Reimplemented from Ogre::Frustum. Definition at line 118 of file OgreCamera.h. |
|
Definition at line 118 of file OgreMovableObject.h. |
|
Frustum extents.
Definition at line 118 of file OgreFrustum.h. |
|
Upper distance to still render.
Definition at line 117 of file OgreMovableObject.h. |
|
Definition at line 374 of file OgreRenderable.h. |
|
Definition at line 375 of file OgreRenderable.h. |
|
Definition at line 376 of file OgreRenderable.h. |
|
User defined link to another object / value / whatever.
Definition at line 122 of file OgreMovableObject.h. |
|
Whether or not the rendering distance of objects should take effect for this camera.
Definition at line 151 of file OgreCamera.h. |
|
Definition at line 149 of file OgreFrustum.h. |
|
Pre-calced view matrix.
Definition at line 100 of file OgreFrustum.h. |
|
Stored number of visible faces in the last render.
Definition at line 115 of file OgreCamera.h. |
|
Stored number of visible faces in the last render.
Definition at line 112 of file OgreCamera.h. |
|
Flags determining whether this object is visible (compared to SceneManager mask).
Definition at line 130 of file OgreMovableObject.h. |
|
Is this object visible?
Definition at line 113 of file OgreMovableObject.h. |
|
Viewing window.
Definition at line 135 of file OgreCamera.h. |
|
Windowed viewport clip planes.
Definition at line 139 of file OgreCamera.h. |
|
Is viewing window used.
Definition at line 137 of file OgreCamera.h. |
|
Viewing window.
Definition at line 135 of file OgreCamera.h. |
|
Cached world AABB of this object.
Reimplemented in Ogre::ParticleSystem. Definition at line 132 of file OgreMovableObject.h. |
|
Definition at line 134 of file OgreMovableObject.h. |
|
World space AABB of this object's dark cap.
Definition at line 136 of file OgreMovableObject.h. |
|
Definition at line 152 of file OgreFrustum.h. |
|
Viewing window.
Definition at line 135 of file OgreCamera.h. |
|
Viewing window.
Definition at line 135 of file OgreCamera.h. |
|
Whether to yaw around a fixed axis.
Definition at line 104 of file OgreCamera.h. |
|
Fixed axis to yaw around.
Definition at line 106 of file OgreCamera.h. |
Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sat Apr 11 13:47:14 2009