C#Code
C#Code
Public Member Functions | Public Attributes | Private Attributes
Libraries._3D.Camera3D Class Reference

List of all members.

Public Member Functions

 Camera3D ()
 Camera3D (StringType ID)
 Camera3D (string ID)
void ResetAll ()
void GenerateMatricies ()
void SetEffect (Effect shaderEffect, bool setCamPos)
void SetProperties (Vector3 cameraPos, Vector2 aspect, float nearPlaneDist, float farPlaneDist, float yaw, float pitch, float roll, float FOV)
void Update (int timePassed)
StringType GetID ()
void SetYaw (float yaw)
void SetPitch (float pitch)
void SetRoll (float roll)
 Camera3D ()
 Camera3D (StringType ID)
 Camera3D (string ID)
void ResetAll ()
void GenerateMatricies ()
void SetEffect (Effect shaderEffect, bool setCamPos)
void SetProperties (Vector3 cameraPos, Vector2 aspect, float nearPlaneDist, float farPlaneDist, float yaw, float pitch, float roll, float FOV)
void Update (int timePassed)
StringType GetID ()
void SetYaw (float yaw)
void SetPitch (float pitch)
void SetRoll (float roll)

Public Attributes

Matrix m_viewMatrix
 View matrix.
Matrix m_projectionMatrix
 Projection matrix.
Vector3 m_cameraPos
 Camera position.
Vector2 m_aspect
 Aspect ratio. Something like 16x9.
float m_nearPlaneDist
 Near and far plane distance.
float m_farPlaneDist
float m_yaw
 Camera rotation. Values are in radians.
float m_pitch
float m_roll
float m_FOV
 Field of view, in degrees.

Private Attributes

StringType m_ID
 ID that reprents the camera, if any. It can be null if the camera doesn't have a ID.

Detailed Description

Basic 3D camera.


Constructor & Destructor Documentation

Libraries._3D.Camera3D.Camera3D ( )

Default constructor.

Libraries._3D.Camera3D.Camera3D ( StringType  ID)

Constructor.

ID - ID that represents the camera.
Libraries._3D.Camera3D.Camera3D ( string  ID)

Constructor.

ID - ID that represents the camera.
Libraries._3D.Camera3D.Camera3D ( )

Default constructor.

Libraries._3D.Camera3D.Camera3D ( StringType  ID)

Constructor.

ID - ID that represents the camera.
Libraries._3D.Camera3D.Camera3D ( string  ID)

Constructor.

ID - ID that represents the camera.

Member Function Documentation

void Libraries._3D.Camera3D.GenerateMatricies ( )

Generate the matricies with the current values.

void Libraries._3D.Camera3D.GenerateMatricies ( )

Generate the matricies with the current values.

StringType Libraries._3D.Camera3D.GetID ( )

Retrives the ID that represents the camera.

Return:
Value is the ID of the camera, null if no ID was set.

StringType Libraries._3D.Camera3D.GetID ( )

Retrives the ID that represents the camera.

Return:
Value is the ID of the camera, null if no ID was set.

void Libraries._3D.Camera3D.ResetAll ( )

Resets camera values to defaults.

void Libraries._3D.Camera3D.ResetAll ( )

Resets camera values to defaults.

void Libraries._3D.Camera3D.SetEffect ( Effect  shaderEffect,
bool  setCamPos 
)

Set the effect with the camera values.

shaderEffect - Shader effect to set.
setCamePos - True if the camera position should be set it the effect, false if not.
void Libraries._3D.Camera3D.SetEffect ( Effect  shaderEffect,
bool  setCamPos 
)

Set the effect with the camera values.

shaderEffect - Shader effect to set.
setCamePos - True if the camera position should be set it the effect, false if not.
void Libraries._3D.Camera3D.SetPitch ( float  pitch)

Set camera pitch.

yaw - Yaw to store.
void Libraries._3D.Camera3D.SetPitch ( float  pitch)

Set camera pitch.

yaw - Yaw to store.
void Libraries._3D.Camera3D.SetProperties ( Vector3  cameraPos,
Vector2  aspect,
float  nearPlaneDist,
float  farPlaneDist,
float  yaw,
float  pitch,
float  roll,
float  FOV 
)

Set the camera properties.

cameraPos - Camera position.
aspect - Aspect ration. Something like 16/9.
nearPlaneDist, farPlaneDist - Near and far plane distances. How close is the closest the camera sees and how far away is the farthest it sees.
yaw, pitch, roll - Rotation on axis. Values are in radians.
FOV - Field of view angle. Value in radians.
void Libraries._3D.Camera3D.SetProperties ( Vector3  cameraPos,
Vector2  aspect,
float  nearPlaneDist,
float  farPlaneDist,
float  yaw,
float  pitch,
float  roll,
float  FOV 
)

Set the camera properties.

cameraPos - Camera position.
aspect - Aspect ration. Something like 16/9.
nearPlaneDist, farPlaneDist - Near and far plane distances. How close is the closest the camera sees and how far away is the farthest it sees.
yaw, pitch, roll - Rotation on axis. Values are in radians.
FOV - Field of view angle. Value in radians.
void Libraries._3D.Camera3D.SetRoll ( float  roll)

Set camera roll.

roll - Roll to store.
void Libraries._3D.Camera3D.SetRoll ( float  roll)

Set camera roll.

roll - Roll to store.
void Libraries._3D.Camera3D.SetYaw ( float  yaw)

Set camera yaw.

yaw - Yaw to store.
void Libraries._3D.Camera3D.SetYaw ( float  yaw)

Set camera yaw.

yaw - Yaw to store.
void Libraries._3D.Camera3D.Update ( int  timePassed)

Updatge the camera.

timePassed - How long the update should handle.
void Libraries._3D.Camera3D.Update ( int  timePassed)

Updatge the camera.

timePassed - How long the update should handle.

Member Data Documentation

Aspect ratio. Something like 16x9.

Camera position.

Field of view, in degrees.

ID that reprents the camera, if any. It can be null if the camera doesn't have a ID.

Near and far plane distance.

Projection matrix.

View matrix.

Camera rotation. Values are in radians.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Enumerations Properties