Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
Mezzanine::Graphics::CameraProxy Class Reference

This is the proxy class for placing and manipulating a camera in the scene. More...

#include <cameraproxy.h>

+ Inheritance diagram for Mezzanine::Graphics::CameraProxy:
+ Collaboration diagram for Mezzanine::Graphics::CameraProxy:

Public Member Functions

 CameraProxy (const UInt32 ID, SceneManager *Creator)
 Class constructor. More...
 
 CameraProxy (const XML::Node &SelfRoot, SceneManager *Creator)
 XML constructor. More...
 
virtual ~CameraProxy ()
 Class destructor.
 
virtual Ogre::MovableObject * _GetBaseGraphicsObject () const
 Accessor for the internal graphics object. More...
 
virtual Ogre::Camera * _GetGraphicsObject () const
 Accessor for the internal camera. More...
 
virtual Real GetAspectRatio () const
 Gets the aspect ratio of the cameras veiw. More...
 
virtual Ray GetCameraToViewportRay (const Real ScreenX, const Real ScreenY) const
 Gets a Ray from the camera to the viewport. More...
 
virtual String GetDerivedSerializableName () const
 Gets the most derived serializable name of this WorldProxy. More...
 
virtual Vector3 GetDirection () const
 Gets the direction the light from this source is being emitted. More...
 
virtual Real GetFarClipDistance () const
 Gets the distance in world units at which objects are considered too far to render. More...
 
virtual Real GetFieldOfViewY () const
 Gets the vertical field of view of the camera frustrum. More...
 
virtual Vector3 GetFixedYawAxis () const
 If fixed yaw is enabled, on which axis is yawing disabled. More...
 
virtual Real GetNearClipDistance () const
 Gets the distance in world units at which objects are considered too close to render. More...
 
virtual Graphics::OrientationMode GetOrientationMode () const
 Gets the orientation mode of this cameras frustrum. More...
 
virtual Real GetOrthoWindowHeight () const
 Gets the current height of the Orthographic projection window in world units. More...
 
virtual Real GetOrthoWindowWidth () const
 Gets the current width of the Orthographic projection window in world units. More...
 
virtual Graphics::CameraPolyMode GetPolygonMode () const
 Gets the debug rendering mode for this camera. More...
 
virtual Graphics::ProjectionType GetProjectionType () const
 Get the type of projection used by the camera. More...
 
virtual Mezzanine::ProxyType GetProxyType () const
 Accessor for the type of proxy. More...
 
virtual ViewportGetViewport () const
 Gets the Viewport this camera is attached to, if any. More...
 
virtual Boole IsFixedYawEnabled () const
 Gets whether this cameras Yaw rotation is based on a fixed axis. More...
 
virtual void LookAt (const Vector3 &TargetLoc)
 Sets the direction the camera faces based on a 3D point. More...
 
virtual void MoveRelative (const Vector3 &ToMove)
 Moves the camera through local space. More...
 
virtual void ProtoDeSerializeProperties (const XML::Node &SelfRoot)
 Take the data stored in an XML Node and overwrite the properties of this object with it. More...
 
virtual void ProtoSerializeProperties (XML::Node &SelfRoot) const
 Convert the properties of this class to an XML::Node ready for serialization. More...
 
virtual void SetAspectRatio (const Real Ratio)
 Sets the aspect ratio of the cameras veiw. More...
 
virtual void SetDirection (const Vector3 &Dir)
 Sets the direction the light will be emitted from this source. More...
 
virtual void SetFarClipDistance (const Real FarDist)
 Sets the distance in world units at which objects are considered too far to render. More...
 
virtual void SetFieldOfViewY (const Real FOV)
 Sets the vertical field of view of the camera frustrum. More...
 
virtual void SetFixedYawAxis (const Boole UseFixed, const Vector3 &Axis=Vector3::Unit_Y())
 Sets whether or not to lock rotation around the Y axis. More...
 
virtual void SetNearClipDistance (const Real NearDist)
 Sets the distance in world units at which objects are considered too close to render. More...
 
virtual void SetOrientationMode (const Graphics::OrientationMode OriMode)
 Sets the orientation mode of this cameras frustrum. More...
 
virtual void SetOrthoWindow (const Real Width, const Real Height)
 Defines the size of the Orthographic projection window in world units. More...
 
virtual void SetOrthoWindowHeight (const Real Height)
 Defines the size of the Orthographic projection window in world units. More...
 
virtual void SetOrthoWindowWidth (const Real Width)
 Defines the size of the Orthographic projection window in world units. More...
 
virtual void SetPolygonMode (const Graphics::CameraPolyMode PolyMode)
 Sets the debug rendering mode for this camera. More...
 
virtual void SetProjectionType (const Graphics::ProjectionType ProjType)
 Sets the type of projection to be used with this camera. More...
 
- Public Member Functions inherited from Mezzanine::Graphics::RenderableProxy
 RenderableProxy (SceneManager *Creator)
 XML-assist Constructor. More...
 
 RenderableProxy (const UInt32 ID, SceneManager *Creator)
 Normal Constructor. More...
 
virtual ~RenderableProxy ()
 Class destructor.
 
virtual Ogre::SceneNode * _GetGraphicsNode () const
 Accessor for the internal node in the scenegraph for this proxy. More...
 
virtual void AddToWorld ()
 Performs all the necessary task to ensure this object is connected to it's respective world and ready for use. More...
 
virtual AxisAlignedBox GetAABB () const
 Gets this proxies AABB. More...
 
virtual Boole GetCastShadows () const
 Gets whether or not this proxy can cast a shadow. More...
 
virtual WorldManagerGetCreator () const
 Gets a pointer to this proxies creator. More...
 
virtual UInt32 GetLightMask () const
 Gets which types of lights will affect this proxy. More...
 
virtual Vector3 GetLocation () const
 Gets this objects current location. More...
 
virtual Quaternion GetOrientation () const
 Gets this objects current orientation. More...
 
virtual UInt32 GetQueryMask () const
 Gets the bitmask that will be used to determine if this object should be counted in scene queries. More...
 
virtual Boole GetReceiveShadows () const
 Gets whether or not this proxy can be rendered with a shadow casted on it. More...
 
virtual Real GetRenderDistance () const
 Gets the distance at which the proxy will stop rendering. More...
 
virtual Vector3 GetScale () const
 Gets the scaling currently being applied to this object. More...
 
virtual UInt32 GetVisibilityMask () const
 Gets the bitmask that will be used to determine if this object should be visible when rendering. More...
 
virtual Boole GetVisible () const
 Gets whether or not this proxy is visible. More...
 
virtual Boole IsInWorld () const
 Gets whether or not this object is inside of it's world. More...
 
virtual void Pitch (const Real Angle)
 Rotate the object around the X axis. More...
 
virtual void RemoveFromWorld ()
 Unhooks this proxy from it's respective world. More...
 
virtual void Roll (const Real Angle)
 Rotate the object around the Z axis. More...
 
virtual void Rotate (const Vector3 &Axis, const Real Angle)
 Rotates the object from it's existing rotation. More...
 
virtual void Rotate (const Quaternion &Rotation)
 Rotates the object from it's existing rotation. More...
 
virtual void Scale (const Vector3 &Scale)
 Scales the object from it's current size. More...
 
virtual void Scale (const Real X, const Real Y, const Real Z)
 Scales the object from it's current size. More...
 
virtual void SetCastShadows (const Boole CastShadows)
 Sets whether or not this proxy can cast a shadow. More...
 
virtual void SetLightMask (const UInt32 Mask)
 Sets which types of lights will affect this proxy. More...
 
virtual void SetLocation (const Vector3 &Loc)
 Sets the location of this object in parent space. More...
 
virtual void SetLocation (const Real X, const Real Y, const Real Z)
 Sets the location of this object in parent space via Reals. More...
 
virtual void SetOrientation (const Quaternion &Ori)
 Sets the orientation of this object in parent space. More...
 
virtual void SetOrientation (const Real X, const Real Y, const Real Z, const Real W)
 Sets the orientation of this object in parent space via Reals. More...
 
virtual void SetQueryMask (const UInt32 Mask)
 Sets the bitmesk that will be used to determine if this object should be counted in scene queries. More...
 
virtual void SetRenderDistance (const Real Distance)
 Sets the distance at which the proxy will stop rendering. More...
 
virtual void SetScale (const Vector3 &Sc)
 Sets the scaling to be applied to this object. More...
 
virtual void SetScale (const Real X, const Real Y, const Real Z)
 Sets the scaling to be applied to this object via Reals. More...
 
virtual void SetVisibilityMask (const UInt32 Mask)
 Sets the bitmask that will be used to determine if this object should be visible when rendering. More...
 
virtual void SetVisible (const Boole Visible)
 Sets whether or not this proxy is visible. More...
 
virtual void Translate (const Vector3 &Trans)
 Moves this object from it's current location. More...
 
virtual void Translate (const Real X, const Real Y, const Real Z)
 Moves this object from it's current location. More...
 
virtual void Yaw (const Real Angle)
 Rotate the object around the Y axis. More...
 
- Public Member Functions inherited from Mezzanine::WorldProxy
 WorldProxy ()
 Blank constructor.
 
 WorldProxy (const UInt32 ID)
 Normal/ID constructor. More...
 
virtual ~WorldProxy ()
 Class destructor.
 
void _Bind (WorldObject *NewParent)
 Binds this proxy to a WorldObject. More...
 
virtual WorldObjectGetParentObject () const
 Gets a pointer to the parent object controlling this proxy. More...
 
virtual UInt32 GetProxyID () const
 Gets the unique ID of this proxy. More...
 
virtual void ProtoDeSerialize (const XML::Node &SelfRoot)
 Take the data stored in an XML Node and overwrite this object with it. More...
 
virtual void ProtoSerialize (XML::Node &ParentNode) const
 Convert this class to an XML::Node ready for serialization. More...
 
- Public Member Functions inherited from Mezzanine::TransformableObject
virtual ~TransformableObject ()
 Class Destructor.
 
virtual Vector3 ConvertGlobalToLocal (const Vector3 &Location) const
 Converts a point in global space to the same point in local space. More...
 
virtual Quaternion ConvertGlobalToLocal (const Quaternion &Orientation) const
 Converts a rotation in global space to the same rotation in local space. More...
 
virtual Vector3 ConvertLocalToGlobal (const Vector3 &Location) const
 Converts a point in local space to the same point in global space. More...
 
virtual Quaternion ConvertLocalToGlobal (const Quaternion &Orientation) const
 Converts a rotation in local space to the same rotation in global space. More...
 

Static Public Member Functions

static String GetSerializableName ()
 Get the name of the the XML tag the proxy class will leave behind as its instances are serialized. More...
 
- Static Public Member Functions inherited from Mezzanine::Graphics::RenderableProxy
static String GetSerializableName ()
 Get the name of the the XML tag the proxy class will leave behind as its instances are serialized. More...
 
- Static Public Member Functions inherited from Mezzanine::WorldProxy
static String GetSerializableName ()
 Get the name of the the XML tag the proxy class will leave behind as its instances are serialized. More...
 

Protected Member Functions

virtual void CreateCamera ()
 Creates an internal Camera to be used by the calling instance. More...
 
virtual void DestroyCamera ()
 Destroys the internal Camera in use by this proxy. More...
 
- Protected Member Functions inherited from Mezzanine::WorldProxy
virtual void ProtoDeSerializeImpl (const XML::Node &SelfRoot)
 Implementation method for deseriailizing additional sets of data. More...
 
virtual void ProtoSerializeImpl (XML::Node &SelfRoot) const
 Implementation method for serializing additional sets of data. More...
 

Static Protected Member Functions

static String GenerateName ()
 Generates a name for this Camera to placate the internal system. More...
 

Protected Attributes

ViewportCameraVP
 This is a pointer to the Viewport this camera is attached to, if any. More...
 
Vector3 FixedYawAxis
 A vector3 representing the fixed axis on which this camera will always Yaw/rotate. More...
 
Ogre::Camera * GraphicsCamera
 A pointer to the internal Camera this proxy is based on. More...
 
Boole UseFixedYaw
 A Boole storing whether or not the FixedYawAxis is being used. More...
 
- Protected Attributes inherited from Mezzanine::Graphics::RenderableProxy
Ogre::SceneNode * GraphicsNode
 A pointer to the internal object storing the proxy transform. More...
 
Boole InWorld
 This stores whether the proxy is currently in the graphics world or not. More...
 
SceneManagerManager
 This is a pointer to the scene manager that created and owns this proxy. More...
 
UInt32 QueryMask
 This is a bitmask identifying this objects type when being queried. Used for advanced query configuration. More...
 
UInt32 VisibilityMask
 This is a bitmask identifying this objects type when being rendered. Used for advanced visibility configuration. More...
 
- Protected Attributes inherited from Mezzanine::WorldProxy
WorldObjectParentObject
 Pointer to the Object this proxy belongs to. More...
 
UInt32 ProxyID
 The unique ID assigned to the type of proxy an instance is. More...
 

Friends

class Viewport
 

Detailed Description

This is the proxy class for placing and manipulating a camera in the scene.

Definition at line 65 of file cameraproxy.h.

Constructor & Destructor Documentation

Mezzanine::Graphics::CameraProxy::CameraProxy ( const UInt32  ID,
SceneManager Creator 
)

Class constructor.

Parameters
IDThe unique ID assigned to this CameraProxy.
CreatorA pointer to the manager that created this proxy.

Definition at line 150 of file cameraproxy.cpp.

Mezzanine::Graphics::CameraProxy::CameraProxy ( const XML::Node SelfRoot,
SceneManager Creator 
)

XML constructor.

Parameters
SelfRootAn XML::Node containing the data to populate this class with.
CreatorA pointer to the manager that created this proxy.

Definition at line 157 of file cameraproxy.cpp.

Member Function Documentation

Ogre::MovableObject * Mezzanine::Graphics::CameraProxy::_GetBaseGraphicsObject ( ) const
virtual

Accessor for the internal graphics object.

Returns
Returns a pointer to the internal object of this proxy.

Implements Mezzanine::Graphics::RenderableProxy.

Definition at line 407 of file cameraproxy.cpp.

Ogre::Camera * Mezzanine::Graphics::CameraProxy::_GetGraphicsObject ( ) const
virtual

Accessor for the internal camera.

Returns
Returns a pointer to the internal camera this proxy is based on.

Definition at line 404 of file cameraproxy.cpp.

void Mezzanine::Graphics::CameraProxy::CreateCamera ( )
protectedvirtual

Creates an internal Camera to be used by the calling instance.

Definition at line 170 of file cameraproxy.cpp.

void Mezzanine::Graphics::CameraProxy::DestroyCamera ( )
protectedvirtual

Destroys the internal Camera in use by this proxy.

Definition at line 179 of file cameraproxy.cpp.

String Mezzanine::Graphics::CameraProxy::GenerateName ( )
staticprotected

Generates a name for this Camera to placate the internal system.

Note
This will no longer be necessary in after the switch to Ogre 2.0.
Returns
Returns a string containing the auto-generated name of this Camera.

Definition at line 191 of file cameraproxy.cpp.

Real Mezzanine::Graphics::CameraProxy::GetAspectRatio ( ) const
virtual

Gets the aspect ratio of the cameras veiw.

Returns
Returns a Real representing the aspect ratio for the camera frustrum viewport.

Definition at line 283 of file cameraproxy.cpp.

Ray Mezzanine::Graphics::CameraProxy::GetCameraToViewportRay ( const Real  ScreenX,
const Real  ScreenY 
) const
virtual

Gets a Ray from the camera to the viewport.

Parameters
ScreenXA Real representing the relative location on screen, on the x axis(0.0 - 1.0).
ScreenYA Real representing the relative location on screen, on the y axis(0.0 - 1.0).

Definition at line 223 of file cameraproxy.cpp.

String Mezzanine::Graphics::CameraProxy::GetDerivedSerializableName ( ) const
virtual

Gets the most derived serializable name of this WorldProxy.

Note
When creating a new WorldProxy class verify this method has a valid return for it in order for serialization to work properly.
Returns
Returns the name of the XML tag from the most derived class of "this".

Reimplemented from Mezzanine::Graphics::RenderableProxy.

Definition at line 395 of file cameraproxy.cpp.

Vector3 Mezzanine::Graphics::CameraProxy::GetDirection ( ) const
virtual

Gets the direction the light from this source is being emitted.

Note
The direction is not used if this is a point light.
Returns
Returns a Vector3 representing the direction this proxy is emitting light.

Definition at line 220 of file cameraproxy.cpp.

Real Mezzanine::Graphics::CameraProxy::GetFarClipDistance ( ) const
virtual

Gets the distance in world units at which objects are considered too far to render.

Returns
Returns a Real representing the distance from the camera to the far clipping plane.

Definition at line 271 of file cameraproxy.cpp.

Real Mezzanine::Graphics::CameraProxy::GetFieldOfViewY ( ) const
virtual

Gets the vertical field of view of the camera frustrum.

Returns
Returns a Real representing the current vertical field of view of this camera in radians.

Definition at line 277 of file cameraproxy.cpp.

Vector3 Mezzanine::Graphics::CameraProxy::GetFixedYawAxis ( ) const
virtual

If fixed yaw is enabled, on which axis is yawing disabled.

Returns
Returns a Vector3 of 0s if disable, otherwise this return the Fixed Yaw Axis.

Definition at line 293 of file cameraproxy.cpp.

Real Mezzanine::Graphics::CameraProxy::GetNearClipDistance ( ) const
virtual

Gets the distance in world units at which objects are considered too close to render.

Returns
Returns a Real representing the distance from the camera to the near clipping plane.

Definition at line 265 of file cameraproxy.cpp.

Graphics::OrientationMode Mezzanine::Graphics::CameraProxy::GetOrientationMode ( ) const
virtual

Gets the orientation mode of this cameras frustrum.

Returns
An OrientationMode enum value that will identify the kind of orientation this cameras frustrum uses.

Definition at line 244 of file cameraproxy.cpp.

Real Mezzanine::Graphics::CameraProxy::GetOrthoWindowHeight ( ) const
virtual

Gets the current height of the Orthographic projection window in world units.

Returns
Returns a Real represnting the world unit height of the projection window when Orthographic projection is enabled.

Definition at line 259 of file cameraproxy.cpp.

Real Mezzanine::Graphics::CameraProxy::GetOrthoWindowWidth ( ) const
virtual

Gets the current width of the Orthographic projection window in world units.

Returns
Returns a Real represnting the world unit width of the projection window when Orthographic projection is enabled.

Definition at line 253 of file cameraproxy.cpp.

Graphics::CameraPolyMode Mezzanine::Graphics::CameraProxy::GetPolygonMode ( ) const
virtual

Gets the debug rendering mode for this camera.

Returns
Returns a CameraPolyMode enum value representing the current mode of this camera.

Definition at line 232 of file cameraproxy.cpp.

Graphics::ProjectionType Mezzanine::Graphics::CameraProxy::GetProjectionType ( ) const
virtual

Get the type of projection used by the camera.

Returns
A ProjectionType enum value that will identify the kind of projection this camera uses.

Definition at line 238 of file cameraproxy.cpp.

Mezzanine::ProxyType Mezzanine::Graphics::CameraProxy::GetProxyType ( ) const
virtual

Accessor for the type of proxy.

Todo:

Wrap LOD related methods (Camera/Bias).

Wrap reflection methods?

Returns
Returns enum value for the type of proxy this object is.

Implements Mezzanine::WorldProxy.

Definition at line 202 of file cameraproxy.cpp.

String Mezzanine::Graphics::CameraProxy::GetSerializableName ( )
static

Get the name of the the XML tag the proxy class will leave behind as its instances are serialized.

Returns
A string containing the name of this class.

Definition at line 398 of file cameraproxy.cpp.

Viewport * Mezzanine::Graphics::CameraProxy::GetViewport ( ) const
virtual

Gets the Viewport this camera is attached to, if any.

Returns
Returns a pointer to the Viewport this camera is rendering to, or NULL if not attached.

Definition at line 205 of file cameraproxy.cpp.

Boole Mezzanine::Graphics::CameraProxy::IsFixedYawEnabled ( ) const
virtual

Gets whether this cameras Yaw rotation is based on a fixed axis.

Returns
Returns true if a fixed Yaw axis is enabled and in use, false otherwise.

Definition at line 208 of file cameraproxy.cpp.

void Mezzanine::Graphics::CameraProxy::LookAt ( const Vector3 TargetLoc)
virtual

Sets the direction the camera faces based on a 3D point.

Parameters
TargetLocThe location in the world to look at.

Definition at line 211 of file cameraproxy.cpp.

void Mezzanine::Graphics::CameraProxy::MoveRelative ( const Vector3 ToMove)
virtual

Moves the camera through local space.

Parameters
ToMoveThe local space vector to move the camera by.

Definition at line 214 of file cameraproxy.cpp.

void Mezzanine::Graphics::CameraProxy::ProtoDeSerializeProperties ( const XML::Node SelfRoot)
virtual

Take the data stored in an XML Node and overwrite the properties of this object with it.

Parameters
SelfRootAn XML::Node containing the data to populate this class with.

Reimplemented from Mezzanine::Graphics::RenderableProxy.

Definition at line 326 of file cameraproxy.cpp.

void Mezzanine::Graphics::CameraProxy::ProtoSerializeProperties ( XML::Node SelfRoot) const
virtual

Convert the properties of this class to an XML::Node ready for serialization.

Parameters
SelfRootThe root node containing all the serialized data for this instance.

Reimplemented from Mezzanine::Graphics::RenderableProxy.

Definition at line 299 of file cameraproxy.cpp.

void Mezzanine::Graphics::CameraProxy::SetAspectRatio ( const Real  Ratio)
virtual

Sets the aspect ratio of the cameras veiw.

Parameters
RatioA Real that represents the camera frustrum viewport aspect ratio, where Ratio = width / height.

Definition at line 280 of file cameraproxy.cpp.

void Mezzanine::Graphics::CameraProxy::SetDirection ( const Vector3 Dir)
virtual

Sets the direction the light will be emitted from this source.

Note
The direction is not used if this is a point light.
Parameters
DirA Vector3 representing the direction the light will travel from this source.

Definition at line 217 of file cameraproxy.cpp.

void Mezzanine::Graphics::CameraProxy::SetFarClipDistance ( const Real  FarDist)
virtual

Sets the distance in world units at which objects are considered too far to render.

Parameters
FarDistA Real representing the distance.

Definition at line 268 of file cameraproxy.cpp.

void Mezzanine::Graphics::CameraProxy::SetFieldOfViewY ( const Real  FOV)
virtual

Sets the vertical field of view of the camera frustrum.

Remarks
Higher values (90+ degrees, 1.57079633+ radians) result in wide-angle, fish-eye views. Low values (30- degrees, 0.523598776- radians) result in telescopic views. Normal values are between 45 degrees(0.785398163 radians) and 60 degrees(1.04719755 radians).
Parameters
FOVThe field of view in radians.

Definition at line 274 of file cameraproxy.cpp.

void Mezzanine::Graphics::CameraProxy::SetFixedYawAxis ( const Boole  UseFixed,
const Vector3 Axis = Vector3::Unit_Y() 
)
virtual

Sets whether or not to lock rotation around the Y axis.

Remarks
This function is automatically called on by the camera constructor.
Parameters
UseFixedEnable or disable the locking of the axis.
AxisThe axis to lock, defaults to the Y axis.

Definition at line 286 of file cameraproxy.cpp.

void Mezzanine::Graphics::CameraProxy::SetNearClipDistance ( const Real  NearDist)
virtual

Sets the distance in world units at which objects are considered too close to render.

Parameters
NearDistA Real representing the distance.

Definition at line 262 of file cameraproxy.cpp.

void Mezzanine::Graphics::CameraProxy::SetOrientationMode ( const Graphics::OrientationMode  OriMode)
virtual

Sets the orientation mode of this cameras frustrum.

Parameters
OriModeAn OrientationMode enum value that expresses the type of orientation this cameras frustrum will use.

Definition at line 241 of file cameraproxy.cpp.

void Mezzanine::Graphics::CameraProxy::SetOrthoWindow ( const Real  Width,
const Real  Height 
)
virtual

Defines the size of the Orthographic projection window in world units.

Remarks
This function can change the aspect ratio of the screen, determined by the values passed in. To set the window size without changing the aspect ratio, call either the SetOrthoWindowHeight, or SetOrthoWindowWidth functions.
Parameters
WidthThe new width of the projection window.
HeightThe new height of the projection window.

Definition at line 247 of file cameraproxy.cpp.

void Mezzanine::Graphics::CameraProxy::SetOrthoWindowHeight ( const Real  Height)
virtual

Defines the size of the Orthographic projection window in world units.

Remarks
This function will not change the aspect ratio of the screen, unlike SetOrthoWindow. The aspect ratio will be preserved and the Width of the screen automatically recalculated based on the Height passed in.
Parameters
HeightThe new height of the projection window.

Definition at line 256 of file cameraproxy.cpp.

void Mezzanine::Graphics::CameraProxy::SetOrthoWindowWidth ( const Real  Width)
virtual

Defines the size of the Orthographic projection window in world units.

Remarks
This function will not change the aspect ratio of the screen, unlike SetOrthoWindow. The aspect ratio will be preserved and the Height of the screen automatically recalculated based on the Width passed in.
Parameters
WidthThe new width of the projection window.

Definition at line 250 of file cameraproxy.cpp.

void Mezzanine::Graphics::CameraProxy::SetPolygonMode ( const Graphics::CameraPolyMode  PolyMode)
virtual

Sets the debug rendering mode for this camera.

Parameters
PolyModeA CameraPolyMode enum value expressing the mode to be set.

Definition at line 229 of file cameraproxy.cpp.

void Mezzanine::Graphics::CameraProxy::SetProjectionType ( const Graphics::ProjectionType  ProjType)
virtual

Sets the type of projection to be used with this camera.

Remarks
By default, all cameras are enabled with Perspective projection. This is the standard 3-dimentional view anyone would expect in a 3D world. Orthographic projection is useful when displaying 2D worlds, or only 2 dimentions of a 3D world. It enables you to see the entire side of an object without regard for camera perspective. Perspective can be thought of as a pyramid, with the camera at the top of the cone. Orthographic would instead be a cube.
Parameters
ProjTypeA ProjectionType enum value that expresses the type of projection to be used.

Definition at line 235 of file cameraproxy.cpp.

Member Data Documentation

Viewport* Mezzanine::Graphics::CameraProxy::CameraVP
protected

This is a pointer to the Viewport this camera is attached to, if any.

Definition at line 78 of file cameraproxy.h.

Vector3 Mezzanine::Graphics::CameraProxy::FixedYawAxis
protected

A vector3 representing the fixed axis on which this camera will always Yaw/rotate.

Definition at line 72 of file cameraproxy.h.

Ogre::Camera* Mezzanine::Graphics::CameraProxy::GraphicsCamera
protected

A pointer to the internal Camera this proxy is based on.

Definition at line 75 of file cameraproxy.h.

Boole Mezzanine::Graphics::CameraProxy::UseFixedYaw
protected

A Boole storing whether or not the FixedYawAxis is being used.

Definition at line 81 of file cameraproxy.h.


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