Changed Documented method purpose statements

Removed method RotateAroundPoint
~g2k
This commit is contained in:
2006-06-18 14:32:40 -04:00
parent b03bdb0cbc
commit 9eb72b1baa

View File

@@ -17,7 +17,7 @@ namespace OpenArena
//Constructors //Constructors
Camera(); //Default Constructor Camera(); //Default Constructor
//Purpose: //Purpose:
// // Creates a new Camera object located at the origin, pointing at the negative z-axis with up being the positive y-axis
//Camera(const Camera&); //Copy Constructor //Camera(const Camera&); //Copy Constructor
//Purpose: //Purpose:
@@ -26,62 +26,68 @@ namespace OpenArena
//Observer Accessors //Observer Accessors
Vec3f Position(); Vec3f Position();
//Purpose: //Purpose:
// // Returns the position vector of this camera.
// This vector is the location of the camera.
Vec3f View(); Vec3f View();
//Purpose: //Purpose:
// // Returns the view vector of this camera.
// This vector is the direction the camera is pointing.
Vec3f UpVector(); Vec3f UpVector();
//Purpose: //Purpose:
// // Returns the up vector of this camera.
// This vector points up in the rendered view.
Vec3f Strafe(); Vec3f Strafe();
//Purpose: //Purpose:
// // Returns the strafe vector fo this camera.
// This is the direction StrafeCamera will move
//Mutators //Mutators
void PositionCamera(double xpos, double ypos, double zpos, void PositionCamera(double xpos, double ypos, double zpos,
double xview, double yview, double zview, double xview, double yview, double zview,
double xup, double yup, double zup); double xup, double yup, double zup);
//Purpose: //Purpose:
// // Relocates and reorientates the camera as determined by the given vector components.
void PositionCamera(Vec3f pos, Vec3f view, Vec3f up); void PositionCamera(Vec3f pos, Vec3f view, Vec3f up);
//Purpose: //Purpose:
// // Relocates and reorientates the camera as determined by the given vectos.
void Camera::RotateView(double angle, Vec3d axis); void Camera::RotateView(double angle, Vec3d axis);
//Purpose: //Purpose:
// // Rotates the camera by angle degrees about the axis specified by axis.
void RotateView(double angle, double X, double Y, double Z); void RotateView(double angle, double X, double Y, double Z);
//Purpose: //Purpose:
// // Rotates the camera by angle degrees about the axis specified by the given components.
// Works the same as glRotatef(angle, X, Y, Z).
void SetViewByMouse(Window window); void SetViewByMouse(Window window);
//Purpose: //Purpose:
// // Updates the view Vector based on the change in mouse position since the last time it was called.
void RotateAroundPoint(Vec3f vCenter, double X, double Y, double Z); //This function needs to be reimagined and better fleshed out.
//void RotateAroundPoint(Vec3f vCenter, double X, double Y, double Z);
//Purpose: //Purpose:
// // Rotates the camera arount the point vCenter X degrees around the x-axis, Y degrees around the y-axis, and Z degrees around the z-axis in that order
void StrafeCamera(double speed); void StrafeCamera(double speed);
//Purpose: //Purpose:
// // Moves the camera along it's strafe vector speed units.
void MoveCamera(double speed); void MoveCamera(double speed);
//Purpose: //Purpose:
// // Moves the camera along it's view vector speed units.
void Update(); void Update();
//Purpose: //Purpose:
// // Recalculates the strafe vector.
void Look(); void Look();
//Purpose: //Purpose:
// // Calls gluLookAt with stored values to set the scene to the camera.
private: private:
Vec3f m_vPosition; Vec3f m_vPosition;