![]() |
OGRE 1.12.10
Object-Oriented Graphics Rendering Engine
|
A viewpoint from which the scene will be rendered. More...
#include <OgreCamera.h>
Classes | |
class | Listener |
Listener interface so you can be notified of Camera events. More... | |
Public Member Functions | |
Camera (const String &name, SceneManager *sm) | |
Standard constructor. | |
virtual | ~Camera () |
Standard destructor. | |
void | _autoTrack (void) |
Internal method used by OGRE to update auto-tracking cameras. | |
Real | _getLodBiasInverse (void) const |
Internal method for OGRE to use for LOD calculations. | |
unsigned int | _getNumRenderedBatches (void) const |
Internal method to retrieve the number of visible batches in the last render. | |
unsigned int | _getNumRenderedFaces (void) const |
Internal method to retrieve the number of visible faces in the last render. | |
void | _notifyRenderedBatches (unsigned int numbatches) |
Internal method to notify camera of the visible batches in the last render. | |
void | _notifyRenderedFaces (unsigned int numfaces) |
Internal method to notify camera of the visible faces in the last render. | |
void | _notifyViewport (Viewport *viewport) |
Notifies this camera that a viewport is using it. | |
void | _renderScene (Viewport *vp, bool includeOverlays) |
Tells the Camera to contact the SceneManager to render from it's viewpoint. | |
virtual void | addListener (Listener *l) |
Add a listener to this camera. | |
virtual void | forwardIntersect (const Plane &worldPlane, std::vector< Vector4 > *intersect3d) const |
Forward projects frustum rays to find forward intersection with plane. | |
bool | getAutoAspectRatio (void) const |
Retrieves if AutoAspectRatio is currently set or not. | |
const Vector3 & | getAutoTrackOffset (void) const |
Get the auto tracking offset for this camera, if it is auto tracking. | |
SceneNode * | getAutoTrackTarget (void) const |
Get the auto tracking target for this camera, if any. | |
Real | getBoundingRadius (void) const override |
Retrieves the radius of the origin-centered bounding sphere for this object. | |
PlaneBoundedVolume | getCameraToViewportBoxVolume (Real screenLeft, Real screenTop, Real screenRight, Real screenBottom, bool includeFarPlane=false) |
Gets a world-space list of planes enclosing a volume based on a viewport rectangle. | |
void | getCameraToViewportBoxVolume (Real screenLeft, Real screenTop, Real screenRight, Real screenBottom, PlaneBoundedVolume *outVolume, bool includeFarPlane=false) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
Ray | getCameraToViewportRay (Real screenx, Real screeny) const |
Gets a world space ray as cast from the camera through a viewport position. | |
void | getCameraToViewportRay (Real screenx, Real screeny, Ray *outRay) const |
Gets a world space ray as cast from the camera through a viewport position. | |
Frustum * | getCullingFrustum (void) const |
Returns the custom culling frustum in use. | |
Vector3 | getDerivedDirection (void) const |
Gets the derived direction vector of the camera, including any rotation inherited from a node attachment and reflection matrix. | |
const Quaternion & | getDerivedOrientation (void) const |
Gets the derived orientation of the camera, including any rotation inherited from a node attachment and reflection matrix. | |
const Vector3 & | getDerivedPosition (void) const |
Gets the derived position of the camera, including any translation inherited from a node attachment and reflection matrix. | |
Vector3 | getDerivedRight (void) const |
Gets the derived right vector of the camera, including any rotation inherited from a node attachment and reflection matrix. | |
Vector3 | getDerivedUp (void) const |
Gets the derived up vector of the camera, including any rotation inherited from a node attachment and reflection matrix. | |
Vector3 | getDirection (void) const |
Gets the camera's direction. | |
Real | getFarClipDistance (void) const |
Retrieves the distance from the frustum to the far clipping plane. | |
const Plane & | getFrustumPlane (unsigned short plane) const |
Retrieves a specified plane of the frustum (world space). | |
Real | getLodBias (void) const |
Returns the level-of-detail bias factor currently applied to this camera. | |
virtual const Camera * | getLodCamera () const |
Get a pointer to the camera which should be used to determine LOD settings. | |
const String & | getMovableType (void) const override |
Returns the type name of this object. | |
Real | getNearClipDistance (void) const |
Sets the position of the near clipping plane. | |
const Quaternion & | getOrientation (void) const |
Returns the camera's current orientation. | |
const Quaternion & | getOrientationForViewUpdate (void) const |
Get the derived orientation of this frustum. | |
Real | getPixelDisplayRatio () const |
Returns an estimated ratio between a pixel and the display area it represents. | |
PolygonMode | getPolygonMode (void) const |
Retrieves the level of detail that the camera will render. | |
const Vector3 & | getPosition (void) const |
Retrieves the camera's position. | |
const Vector3 & | getPositionForViewUpdate (void) const |
Get the derived position of this frustum. | |
Vector3 | getRealDirection (void) const |
Gets the real world direction vector of the camera, including any rotation inherited from a node attachment. | |
const Quaternion & | getRealOrientation (void) const |
Gets the real world orientation of the camera, including any rotation inherited from a node attachment. | |
const Vector3 & | getRealPosition (void) const |
Gets the real world position of the camera, including any translation inherited from a node attachment. | |
Vector3 | getRealRight (void) const |
Gets the real world right vector of the camera, including any rotation inherited from a node attachment. | |
Vector3 | getRealUp (void) const |
Gets the real world up vector of the camera, including any rotation inherited from a node attachment. | |
Vector3 | getRight (void) const |
Gets the camera's right vector. | |
SceneManager * | getSceneManager (void) const |
Returns a pointer to the SceneManager this camera is rendering through. | |
Vector3 | getUp (void) const |
Gets the camera's up vector. | |
bool | getUseMinPixelSize () const |
Returns whether to use min display size calculations. | |
virtual bool | getUseRenderingDistance (void) const |
Get whether this camera should use the 'rendering distance' on objects to exclude distant objects from the final image. | |
const Affine3 & | getViewMatrix (bool ownFrustumOnly) const |
Specialised version of getViewMatrix allowing caller to differentiate whether the custom culling frustum should be allowed or not. | |
const Affine3 & | getViewMatrix (void) const |
Gets the view matrix for this frustum. | |
Viewport * | getViewport (void) const |
Get the last viewport which was attached to this camera. | |
const std::vector< Plane > & | getWindowPlanes (void) const |
Gets the window clip planes, only applicable if isWindowSet == true. | |
const Corners & | getWorldSpaceCorners (void) const |
Gets the world space corners of the frustum. | |
void | getWorldTransforms (Matrix4 *mat) const override |
Gets the world transform matrix / matrices for this renderable object. | |
bool | isVisible (const AxisAlignedBox &bound, FrustumPlane *culledBy=0) const |
Tests whether the given container is visible in the Frustum. | |
bool | isVisible (const Sphere &bound, FrustumPlane *culledBy=0) const |
Tests whether the given container is visible in the Frustum. | |
bool | isVisible (const Vector3 &vert, FrustumPlane *culledBy=0) const |
Tests whether the given vertex is visible in the Frustum. | |
virtual bool | isWindowSet (void) const |
Returns if a viewport window is being used. | |
void | lookAt (const Vector3 &targetPoint) |
Points the camera at a location in worldspace. | |
void | lookAt (Real x, Real y, Real z) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
void | move (const Vector3 &vec) |
Moves the camera's position by the vector offset provided along world axes. | |
void | moveRelative (const Vector3 &vec) |
Moves the camera's position by the vector offset provided along it's own axes (relative to orientation). | |
void | pitch (const Radian &angle) |
Pitches the camera up/down anticlockwise around it's local z axis. | |
bool | projectSphere (const Sphere &sphere, Real *left, Real *top, Real *right, Real *bottom) const |
Project a sphere onto the near plane and get the bounding rectangle. | |
virtual void | removeListener (Listener *l) |
Remove a listener to this camera. | |
virtual void | resetWindow (void) |
Cancel view window. | |
void | roll (const Radian &angle) |
Rolls the camera anticlockwise, around its local z axis. | |
void | rotate (const Quaternion &q) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
void | rotate (const Vector3 &axis, const Radian &angle) |
Rotate the camera around an arbitrary axis. | |
void | setAutoAspectRatio (bool autoratio) |
If set to true a viewport that owns this frustum will be able to recalculate the aspect ratio whenever the frustum is resized. | |
void | setAutoTracking (bool enabled, SceneNode *const target=0, const Vector3 &offset=Vector3::ZERO) |
Enables / disables automatic tracking of a SceneNode. | |
void | setCullingFrustum (Frustum *frustum) |
Tells the camera to use a separate Frustum instance to perform culling. | |
void | setDirection (const Vector3 &vec) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
void | setDirection (Real x, Real y, Real z) |
Sets the camera's direction vector. | |
void | setFixedYawAxis (bool useFixed, const Vector3 &fixedAxis=Vector3::UNIT_Y) |
Tells the camera whether to yaw around it's own local Y axis or a fixed axis of choice. | |
void | setLodBias (Real factor=1.0) |
Sets the level-of-detail factor for this Camera. | |
virtual void | setLodCamera (const Camera *lodCam) |
Set a pointer to the camera which should be used to determine LOD settings. | |
void | setOrientation (const Quaternion &q) |
Sets the camera's orientation. | |
void | setPolygonMode (PolygonMode sd) |
Sets the level of rendering detail required from this camera. | |
void | setPosition (const Vector3 &vec) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
void | setPosition (Real x, Real y, Real z) |
Sets the camera's position. | |
void | setUseMinPixelSize (bool enable) |
Sets whether to use min display size calculations. | |
virtual void | setUseRenderingDistance (bool use) |
Set whether this camera should use the 'rendering distance' on objects to exclude distant objects from the final image. | |
virtual void | setWindow (Real left, Real top, Real right, Real bottom) |
Sets the viewing window inside of viewport. | |
virtual void | synchroniseBaseSettingsWith (const Camera *cam) |
Synchronise core camera settings with another. | |
void | yaw (const Radian &angle) |
Rotates the camera anticlockwise around it's local y axis. | |
![]() | |
Frustum (const String &name=BLANKSTRING) | |
Named constructor. | |
virtual | ~Frustum () |
void | _notifyCurrentCamera (Camera *cam) override |
Internal method to notify the object of the camera to be used for the next rendering operation. | |
void | _updateRenderQueue (RenderQueue *queue) override |
Internal method by which the movable object must add Renderable subclass instances to the rendering queue. | |
void | calcViewMatrixRelative (const Vector3 &relPos, Matrix4 &matToUpdate) const |
Calculate a view matrix for this frustum, relative to a potentially dynamic point. | |
void | disableCustomNearClipPlane (void) |
Disables any custom near clip plane. | |
void | disableReflection (void) |
Disables reflection modification previously turned on with enableReflection. | |
void | enableCustomNearClipPlane (const MovablePlane *plane) |
Links the frustum to a custom near clip plane, which can be used to clip geometry in a custom manner without using user clip planes. | |
void | enableCustomNearClipPlane (const Plane &plane) |
Links the frustum to a custom near clip plane, which can be used to clip geometry in a custom manner without using user clip planes. | |
void | enableReflection (const MovablePlane *p) |
Modifies this frustum so it always renders from the reflection of itself through the plane specified. | |
void | enableReflection (const Plane &p) |
Modifies this frustum so it always renders from the reflection of itself through the plane specified. | |
Real | getAspectRatio (void) const |
Retrieves the current aspect ratio. | |
const AxisAlignedBox & | getBoundingBox (void) const override |
Retrieves the local axis-aligned bounding box for this object. | |
Real | getBoundingRadius (void) const override |
Retrieves the radius of the origin-centered bounding sphere for this object. | |
const ColourValue & | getDebugColour () const |
Real | getFarClipDistance (void) const |
Retrieves the distance from the frustum to the far clipping plane. | |
Real | getFocalLength () const |
Returns focal length of frustum. | |
const Radian & | getFOVy (void) const |
Retrieves the frustums Y-dimension Field Of View (FOV). | |
RealRect | getFrustumExtents () const |
Get the extents of the frustum in view space. | |
void | getFrustumExtents (Real &outleft, Real &outright, Real &outtop, Real &outbottom) const |
const Vector2 & | getFrustumOffset () const |
Retrieves the frustum offsets. | |
virtual const Plane * | getFrustumPlanes (void) const |
Retrieves the clipping planes of the frustum (world space). | |
const LightList & | getLights (void) const override |
Gets a list of lights, ordered relative to how close they are to this renderable. | |
const MaterialPtr & | getMaterial (void) const override |
Retrieves a weak reference to the material this renderable object uses. | |
const String & | getMovableType (void) const override |
Returns the type name of this object. | |
Real | getNearClipDistance (void) const |
Sets the position of the near clipping plane. | |
OrientationMode | getOrientationMode () const |
Get the orientation mode of the frustum. | |
Real | getOrthoWindowHeight () const |
Gets the orthographic window height, for use with orthographic rendering only. | |
Real | getOrthoWindowWidth () const |
Gets the orthographic window width, for use with orthographic rendering only. | |
PlaneBoundedVolume | getPlaneBoundedVolume () |
Gets a world-space list of planes enclosing the frustum. | |
const Matrix4 & | getProjectionMatrix (void) const |
Gets the normal projection matrix for this frustum, ie the projection matrix which conforms to standard right-handed rules and uses depth range [-1,+1]. | |
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). | |
const Matrix4 & | getProjectionMatrixWithRSDepth (void) const |
Gets the depth-adjusted projection matrix for the current rendersystem, but one which still conforms to right-hand rules. | |
ProjectionType | getProjectionType (void) const |
Retrieves info on the type of projection used (orthographic or perspective). | |
const Affine3 & | getReflectionMatrix (void) const |
Returns the reflection matrix of the frustum if appropriate. | |
const Plane & | getReflectionPlane (void) const |
Returns the reflection plane of the frustum if appropriate. | |
void | getRenderOperation (RenderOperation &op) override |
Gets the render operation required to send this object to the frame buffer. | |
Real | getSquaredViewDepth (const Camera *cam) const override |
Returns the camera-relative squared depth of this renderable. | |
uint32 | getTypeFlags (void) const override |
Get the 'type flags' for this MovableObject. | |
const Affine3 & | getViewMatrix (void) const |
Gets the view matrix for this frustum. | |
void | getWorldTransforms (Matrix4 *xform) const override |
Gets the world transform matrix / matrices for this renderable object. | |
bool | isCustomNearClipPlaneEnabled (void) const |
Is a custom near clip plane in use? | |
bool | isCustomProjectionMatrixEnabled (void) const |
Returns whether a custom projection matrix is in use. | |
bool | isCustomViewMatrixEnabled (void) const |
Returns whether a custom view matrix is in use. | |
bool | isReflected (void) const |
Returns whether this frustum is being reflected. | |
void | resetFrustumExtents () |
Reset the frustum extents to be automatically derived from other params. | |
void | setAspectRatio (Real ratio) |
Sets the aspect ratio for the frustum viewport. | |
void | setCustomProjectionMatrix (bool enable, const Matrix4 &projectionMatrix=Matrix4::IDENTITY) |
Set whether to use a custom projection matrix on this frustum. | |
void | setCustomViewMatrix (bool enable, const Affine3 &viewMatrix=Affine3::IDENTITY) |
Set whether to use a custom view matrix on this frustum. | |
void | setDebugColour (const ColourValue &col) |
void | setFarClipDistance (Real farDist) |
Sets the distance to the far clipping plane. | |
void | setFocalLength (Real focalLength=1.0) |
Sets frustum focal length (used in stereo rendering). | |
void | setFOVy (const Radian &fovy) |
Sets the Y-dimension Field Of View (FOV) of the frustum. | |
void | setFrustumExtents (Real left, Real right, Real top, Real bottom) |
Manually set the extents of the frustum. | |
void | setFrustumOffset (const Vector2 &offset) |
Sets frustum offsets, used in stereo rendering. | |
void | setFrustumOffset (Real horizontal=0.0, Real vertical=0.0) |
Sets frustum offsets, used in stereo rendering. | |
void | setMaterial (const MaterialPtr &mat) |
void | setNearClipDistance (Real nearDist) |
Sets the position of the near clipping plane. | |
void | setOrientationMode (OrientationMode orientationMode) |
Set the orientation mode of the frustum. | |
void | setOrthoWindow (Real w, Real h) |
Sets the orthographic window settings, for use with orthographic rendering only. | |
void | setOrthoWindowHeight (Real h) |
Sets the orthographic window height, for use with orthographic rendering only. | |
void | setOrthoWindowWidth (Real w) |
Sets the orthographic window width, for use with orthographic rendering only. | |
virtual void | setProjectionType (ProjectionType pt) |
Sets the type of projection to use (orthographic or perspective). | |
void | visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false) |
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. | |
![]() | |
MovableObject () | |
Constructor. | |
MovableObject (const String &name) | |
Named constructor. | |
virtual | ~MovableObject () |
Virtual destructor - read Scott Meyers if you don't know why this is needed. | |
MovableObjectFactory * | _getCreator (void) const |
Get the creator of this object, if any (internal use only) | |
LightList * | _getLightList () |
Returns a pointer to the current list of lights for this object. | |
SceneManager * | _getManager (void) const |
Get the manager of this object, if any (internal use only) | |
virtual const Affine3 & | _getParentNodeFullTransform (void) const |
Return the full transformation of the parent sceneNode or the attachingPoint node. | |
virtual void | _notifyAttached (Node *parent, bool isTagPoint=false) |
Internal method called to notify the object that it has been attached to a node. | |
virtual void | _notifyCreator (MovableObjectFactory *fact) |
Notify the object of it's creator (internal use only) | |
virtual void | _notifyManager (SceneManager *man) |
Notify the object of it's manager (internal use only) | |
virtual void | _notifyMoved (void) |
Internal method called to notify the object that it has been moved. | |
virtual void | _releaseManualHardwareResources () |
Notifies the movable object that hardware resources were lost. | |
virtual void | _restoreManualHardwareResources () |
Notifies the movable object that hardware resources should be restored. | |
void | addQueryFlags (uint32 flags) |
As setQueryFlags, except the flags passed as parameters are appended to the existing flags on this object. | |
void | addVisibilityFlags (uint32 flags) |
As setVisibilityFlags, except the flags passed as parameters are appended to the existing flags on this object. | |
void | detachFromParent (void) |
Detaches an object from a parent SceneNode or TagPoint, if attached. | |
Real | getBoundingRadiusScaled () const |
as getBoundingRadius, but with scaling applied | |
bool | getCastShadows (void) const |
Returns whether shadow casting is enabled for this object. | |
const AxisAlignedBox & | getDarkCapBounds (const Light &light, Real dirLightExtrusionDist) const override |
Gets the world space bounding box of the dark cap, as extruded using the light provided. | |
EdgeData * | getEdgeList (void) |
Returns details of the edges which might be used to determine a silhouette. | |
const AxisAlignedBox & | getLightCapBounds (void) const override |
Gets the world space bounding box of the light cap. | |
uint32 | getLightMask () const |
Get a bitwise mask which will filter the lights affecting this object. | |
Listener * | getListener (void) const |
Gets the current listener for this object. | |
const String & | getName (void) const |
Returns the name of this object. | |
Node * | getParentNode (void) const |
Returns the node to which this object is attached. | |
SceneNode * | getParentSceneNode (void) const |
Returns the scene node to which this object is attached. | |
Real | getPointExtrusionDistance (const Light *l) const |
Get the distance to extrude for a point/spot light. | |
virtual uint32 | getQueryFlags (void) const |
Returns the query flags relevant for this object. | |
bool | getReceivesShadows () |
Returns whether the Material of any Renderable that this MovableObject will add to the render queue will receive shadows. | |
Real | getRenderingDistance (void) const |
Gets the distance at which batches are no longer rendered. | |
Real | getRenderingMinPixelSize () const |
Returns the minimum pixel size an object needs to be in both screen axes in order to be rendered. | |
uint8 | getRenderQueueGroup (void) const |
Gets the queue group for this entity. | |
const ShadowRenderableList & | getShadowVolumeRenderableList (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, size_t *indexBufferUsedSize, bool extrudeVertices, Real extrusionDist, unsigned long flags=0) |
Define a default implementation of method from ShadowCaster which implements no shadows. | |
const Any & | getUserAny (void) const |
UserObjectBindings & | getUserObjectBindings () |
Return an instance of user objects binding associated with this class. | |
const UserObjectBindings & | getUserObjectBindings () const |
Return an instance of user objects binding associated with this class. | |
virtual uint32 | getVisibilityFlags (void) const |
Returns the visibility flags relevant for this object. | |
bool | getVisible (void) const |
Gets this object whether to be visible or not, if it has a renderable component. | |
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. | |
bool | isAttached (void) const |
Returns true if this object is attached to a SceneNode or TagPoint. | |
bool | isDebugDisplayEnabled (void) const |
Gets whether debug display of this object is enabled. | |
virtual bool | isInScene (void) const |
Returns true if this object is attached to a SceneNode or TagPoint, and this SceneNode / TagPoint is currently in an active part of the scene graph. | |
bool | isParentTagPoint () const |
Gets whether the parent node is a TagPoint (or a SceneNode) | |
virtual bool | isVisible (void) const |
Returns whether or not this object is supposed to be visible or not. | |
const LightList & | queryLights (void) const |
Gets a list of lights, ordered relative to how close they are to this movable object. | |
void | removeQueryFlags (uint32 flags) |
As setQueryFlags, except the flags passed as parameters are removed from the existing flags on this object. | |
void | removeVisibilityFlags (uint32 flags) |
As setVisibilityFlags, except the flags passed as parameters are removed from the existing flags on this object. | |
void | setCastShadows (bool enabled) |
Sets whether or not this object will cast shadows. | |
void | setDebugDisplayEnabled (bool enabled) |
Sets whether or not the debug display of this object is enabled. | |
void | setLightMask (uint32 lightMask) |
Set a bitwise mask which will filter the lights affecting this object. | |
void | setListener (Listener *listener) |
Sets a listener for this object. | |
void | setQueryFlags (uint32 flags) |
Sets the query flags for this object. | |
void | setRenderingDistance (Real dist) |
Sets the distance at which the object is no longer rendered. | |
void | setRenderingMinPixelSize (Real pixelSize) |
Sets the minimum pixel size an object needs to be in both screen axes in order to be rendered. | |
virtual void | setRenderQueueGroup (uint8 queueID) |
Sets the render queue group this entity will be rendered through. | |
virtual void | setRenderQueueGroupAndPriority (uint8 queueID, ushort priority) |
Sets the render queue group and group priority this entity will be rendered through. | |
void | setUserAny (const Any &anything) |
void | setVisibilityFlags (uint32 flags) |
Sets the visibility flags for this object. | |
void | setVisible (bool visible) |
Tells this object whether to be visible or not, if it has a renderable component. | |
![]() | |
virtual | ~ShadowCaster () |
virtual ShadowRenderableListIterator | getShadowVolumeRenderableIterator (ShadowTechnique shadowTechnique, const Light *light, HardwareIndexBufferSharedPtr *indexBuffer, size_t *indexBufferUsedSize, bool extrudeVertices, Real extrusionDistance, unsigned long flags=0) |
bool | hasEdgeList () |
Returns whether the object has a valid edge list. | |
![]() | |
AnimableObject () | |
virtual | ~AnimableObject () |
virtual AnimableValuePtr | createAnimableValue (const String &valueName) |
Create a reference-counted AnimableValuePtr for the named value. | |
const StringVector & | getAnimableValueNames (void) const |
Gets a list of animable value names for this object. | |
![]() | |
Renderable () | |
virtual | ~Renderable () |
Virtual destructor needed as class has virtual methods. | |
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 bool | getCastsShadows (void) const |
Method which reports whether this renderable would normally cast a shadow. | |
const Vector4 & | getCustomParameter (size_t index) const |
Gets the custom value associated with this Renderable at the given index. | |
virtual unsigned short | getNumWorldTransforms (void) const |
Returns the number of world transform matrices this renderable requires. | |
bool | getPolygonModeOverrideable (void) const |
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. | |
const RenderSystemDataPtr & | getRenderSystemData () const |
virtual Technique * | getTechnique (void) const |
Retrieves a pointer to the Material Technique this renderable object uses. | |
bool | getUseIdentityProjection (void) const |
Returns whether or not to use an 'identity' projection. | |
bool | getUseIdentityView (void) const |
Returns whether or not to use an 'identity' view. | |
const Any & | getUserAny (void) const |
UserObjectBindings & | getUserObjectBindings () |
Return an instance of user objects binding associated with this class. | |
const UserObjectBindings & | getUserObjectBindings () const |
Return an instance of user objects binding associated with this class. | |
bool | hasCustomParameter (size_t index) const |
Checks whether a custom value is associated with this Renderable at the given index. | |
virtual void | postRender (SceneManager *sm, RenderSystem *rsys) |
Called immediately after the Renderable has been rendered. | |
virtual bool | preRender (SceneManager *sm, RenderSystem *rsys) |
Called just prior to the Renderable being rendered. | |
void | removeCustomParameter (size_t index) |
Removes a custom value which is associated with this Renderable at the given index. | |
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. | |
void | setPolygonModeOverrideable (bool override) |
Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. | |
void | setRenderSystemData (RenderSystemDataPtr val) const |
void | setUseIdentityProjection (bool useIdentityProjection) |
Sets whether or not to use an 'identity' projection. | |
void | setUseIdentityView (bool useIdentityView) |
Sets whether or not to use an 'identity' view. | |
void | setUserAny (const Any &anything) |
Additional Inherited Members | |
![]() | |
typedef Vector3 | Corners[8] |
![]() | |
typedef std::vector< ShadowRenderable * > | ShadowRenderableList |
typedef VectorIterator< ShadowRenderableList > | ShadowRenderableListIterator |
![]() | |
enum | { DEFAULT_PRIORITY = 100 } |
typedef SharedPtr< RenderSystemData > | RenderSystemDataPtr |
![]() | |
static uint32 | getDefaultQueryFlags () |
Get the default query flags for all future MovableObject instances. | |
static uint32 | getDefaultVisibilityFlags () |
Get the default visibility flags for all future MovableObject instances. | |
static void | setDefaultQueryFlags (uint32 flags) |
Set the default query flags for all future MovableObject instances. | |
static void | setDefaultVisibilityFlags (uint32 flags) |
Set the default visibility flags for all future MovableObject instances. | |
![]() | |
static void | clearShadowRenderableList (ShadowRenderableList &shadowRenderables) |
Common implementation of releasing shadow renderables. | |
static void | extrudeVertices (const HardwareVertexBufferSharedPtr &vertexBuffer, size_t originalVertexCount, const Vector4 &lightPos, Real extrudeDist) |
Utility method for extruding vertices based on a light. | |
![]() | |
static const Real | INFINITE_FAR_PLANE_ADJUST |
Small constant used to reduce far plane projection to avoid inaccuracies. | |
A viewpoint from which the scene will be rendered.
Ogre::Camera::Camera | ( | const String & | name, |
SceneManager * | sm | ||
) |
Standard constructor.
|
virtual |
Standard destructor.
SceneManager * Ogre::Camera::getSceneManager | ( | void | ) | const |
Returns a pointer to the SceneManager this camera is rendering through.
void Ogre::Camera::setPolygonMode | ( | PolygonMode | sd | ) |
Sets the level of rendering detail required from this camera.
PolygonMode Ogre::Camera::getPolygonMode | ( | void | ) | const |
Retrieves the level of detail that the camera will render.
Sets the camera's position.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Retrieves the camera's position.
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).
Sets the camera's direction vector.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Gets the camera's direction.
Gets the camera's up vector.
Gets the camera's right vector.
Points the camera at a location in worldspace.
targetPoint | A vector specifying the look at point. |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Rolls the camera anticlockwise, around its local z axis.
Rotates the camera anticlockwise around it's local y axis.
Pitches the camera up/down anticlockwise around it's local z axis.
Rotate the camera around an arbitrary axis.
void Ogre::Camera::rotate | ( | const Quaternion & | q | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Tells the camera whether to yaw around it's own local Y axis or a fixed axis of choice.
useFixed | If true , the axis passed in the second parameter will always be the yaw axis no matter what the camera orientation. If false, the camera yaws around the local Y. |
fixedAxis | The axis to use if the first parameter is true. |
const Quaternion & Ogre::Camera::getOrientation | ( | void | ) | const |
Returns the camera's current orientation.
void Ogre::Camera::setOrientation | ( | const Quaternion & | q | ) |
Sets the camera's orientation.
Internal method used by OGRE to update auto-tracking cameras.
Get the auto tracking target for this camera, if any.
Get the auto tracking offset for this camera, if it is auto tracking.
void Ogre::Camera::setAutoTracking | ( | bool | enabled, |
SceneNode *const | target = 0 , |
||
const Vector3 & | offset = Vector3::ZERO |
||
) |
Enables / disables automatic tracking of a SceneNode.
enabled | If true, the Camera will track the SceneNode supplied as the next parameter (cannot be null). If false the camera will cease tracking and will remain in it's current orientation. |
target | Pointer to the SceneNode which this Camera will track. Make sure you don't delete this SceneNode before turning off tracking (e.g. SceneManager::clearScene will delete it so be careful of this). Can be null if and only if the enabled param is false. |
offset | If supplied, the camera targets this point in local space of the target node instead of the origin of the target node. Good for fine tuning the look at point. |
Get the derived position of this frustum.
Reimplemented from Ogre::Frustum.
|
virtual |
Get the derived orientation of this frustum.
Reimplemented from Ogre::Frustum.
Tells the Camera to contact the SceneManager to render from it's viewpoint.
vp | The viewport to render to |
includeOverlays | Whether or not any overlay objects should be included |
Internal method to notify camera of the visible faces in the last render.
Internal method to notify camera of the visible batches in the last render.
Internal method to retrieve the number of visible faces in the last render.
Internal method to retrieve the number of visible batches in the last render.
const Quaternion & Ogre::Camera::getDerivedOrientation | ( | void | ) | const |
Gets the derived orientation of the camera, including any rotation inherited from a node attachment and reflection matrix.
Gets the derived position of the camera, including any translation inherited from a node attachment and reflection matrix.
Gets the derived direction 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.
Gets the derived right vector of the camera, including any rotation inherited from a node attachment and reflection matrix.
const Quaternion & Ogre::Camera::getRealOrientation | ( | void | ) | const |
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 direction 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.
Gets the real world right vector of the camera, including any rotation inherited from a node attachment.
Gets the world transform matrix / matrices for this renderable object.
Implements Ogre::Renderable.
Returns the type name of this object.
Implements Ogre::MovableObject.
Sets the level-of-detail factor for this Camera.
factor | The factor to apply to the usual level of detail calculation. Higher values increase the detail, so 2.0 doubles the normal detail and 0.5 halves it. |
Returns the level-of-detail bias factor currently applied to this camera.
Set a pointer to the camera which should be used to determine LOD settings.
Get a pointer to the camera which should be used to determine LOD settings.
Gets a world space ray as cast from the camera through a viewport position.
screenx,screeny | The x and y position at which the ray should intersect the viewport, in normalised screen coordinates [0,1] |
Gets a world space ray as cast from the camera through a viewport position.
screenx,screeny | The x and y position at which the ray should intersect the viewport, in normalised screen coordinates [0,1] |
outRay | Ray instance to populate with result |
PlaneBoundedVolume Ogre::Camera::getCameraToViewportBoxVolume | ( | Real | screenLeft, |
Real | screenTop, | ||
Real | screenRight, | ||
Real | screenBottom, | ||
bool | includeFarPlane = false |
||
) |
Gets a world-space list of planes enclosing a volume based on a viewport rectangle.
screenLeft,screenTop,screenRight,screenBottom | The bounds of the on-screen rectangle, expressed in normalised screen coordinates [0,1] |
includeFarPlane | If true, the volume is truncated by the camera far plane, by default it is left open-ended |
void Ogre::Camera::getCameraToViewportBoxVolume | ( | Real | screenLeft, |
Real | screenTop, | ||
Real | screenRight, | ||
Real | screenBottom, | ||
PlaneBoundedVolume * | outVolume, | ||
bool | includeFarPlane = false |
||
) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Internal method for OGRE to use for LOD calculations.
Sets the viewing window inside of viewport.
left | Relative to Viewport - 0 corresponds to left edge, 1 - to right edge (default - 0). |
top | Relative to Viewport - 0 corresponds to top edge, 1 - to bottom edge (default - 0). |
right | Relative to Viewport - 0 corresponds to left edge, 1 - to right edge (default - 1). |
bottom | Relative to Viewport - 0 corresponds to top edge, 1 - to bottom edge (default - 1). |
Returns if a viewport window is being used.
Gets the window clip planes, only applicable if isWindowSet == true.
Retrieves the radius of the origin-centered bounding sphere for this object.
Implements Ogre::MovableObject.
Get the last viewport which was attached to this camera.
Notifies this camera that a viewport is using it.
If set to true a viewport that owns this frustum will be able to recalculate the aspect ratio whenever the frustum is resized.
Retrieves if AutoAspectRatio is currently set or not.
Tells the camera to use a separate Frustum instance to perform culling.
frustum | Pointer to a frustum to use; this can either be a manual Frustum instance (which you can attach to scene nodes like any other MovableObject), or another camera. If you pass 0 to this method it reverts the camera to normal behaviour. |
Returns the custom culling frustum in use.
|
virtual |
Forward projects frustum rays to find forward intersection with plane.
|
virtual |
Tests whether the given container is visible in the Frustum.
bound | Bounding box to be checked (world space). |
culledBy | Optional pointer to an int which will be filled by the plane number which culled the box if the result was false ; |
true
is returned. false
is returned. Reimplemented from Ogre::Frustum.
Reimplemented in Ogre::PCZCamera.
|
virtual |
Tests whether the given container is visible in the Frustum.
bound | Bounding sphere to be checked (world space). |
culledBy | Optional pointer to an int which will be filled by the plane number which culled the box if the result was false ; |
true
is returned. false
is returned. Reimplemented from Ogre::Frustum.
|
virtual |
Tests whether the given vertex is visible in the Frustum.
vert | Vertex to be checked (world space). |
culledBy | Optional pointer to an int which will be filled by the plane number which culled the box if the result was false ; |
true
is returned. false
is returned. Reimplemented from Ogre::Frustum.
Gets the world space corners of the frustum.
Reimplemented from Ogre::Frustum.
Retrieves a specified plane of the frustum (world space).
Reimplemented from Ogre::Frustum.
|
virtual |
Project a sphere onto the near plane and get the bounding rectangle.
sphere | The world-space sphere to project. |
left | Pointers to destination values, these will be completed with the normalised device coordinates (in the range {-1,1}). |
top | Pointers to destination values, these will be completed with the normalised device coordinates (in the range {-1,1}). |
right | Pointers to destination values, these will be completed with the normalised device coordinates (in the range {-1,1}). |
bottom | Pointers to destination values, these will be completed with the normalised device coordinates (in the range {-1,1}). |
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.
Retrieves the distance from the frustum to the far clipping plane.
Gets the view matrix for this frustum.
Mainly for use by OGRE internally.
Specialised version of getViewMatrix allowing caller to differentiate whether the custom culling frustum should be allowed or not.
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.
use | True to use the rendering distance, false not to. |
Get whether this camera should use the 'rendering distance' on objects to exclude distant objects from the final image.
Synchronise core camera settings with another.
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.
|
inline |
Returns whether to use min display size calculations.
|
inline |
Returns an estimated ratio between a pixel and the display area it represents.
For orthographic cameras this function returns the amount of meters covered by a single pixel along the vertical axis. For perspective cameras the value returned is the amount of meters covered by a single pixel per meter distance from the camera.