OpenArena::Camera Class Reference

Write brief comment for Camera here. More...

#include <camera.h>

List of all members.

Public Member Functions
	Camera ()
	Creates a new Camera object.
Vec3f	Position ()
	Returns this Camera's position.
Vec3f	View ()
	Write brief comment for View here.
Vec3f	UpVector ()
	Write brief comment for UpVector here.
Vec3f	Strafe ()
	Write brief comment for Strafe here.
void	PositionCamera (double xpos, double ypos, double zpos, double xview, double yview, double zview, double xup, double yup, double zup)
	Write brief comment for PositionCamera here.
void	PositionCamera (Vec3f pos, Vec3f view, Vec3f up)
	Write brief comment for PositionCamera here.
void	Camera::RotateView (double angle, Vec3d axis)
	Write brief comment for RotateView here.
void	RotateView (double angle, double X, double Y, double Z)
	Write brief comment for RotateView here.
void	SetViewByMouse (Window window)
	Write brief comment for SetViewByMouse here.
void	StrafeCamera (double speed)
	Write brief comment for StrafeCamera here.
void	MoveCamera (double speed)
	Write brief comment for MoveCamera here.
void	Update ()
	Write brief comment for Update here.
void	Look ()
	Write brief comment for Look here.
void	RotateHorizontal (float angle)
	Write brief comment for RotateHorizontal here.
void	RotateVertical (float angle)
	Write brief comment for RotateVertical here.
Private Member Functions
Vec3f	GetUpVector ()
	Write brief comment for GetUpVector here.
Vec3f	GetRightVector ()
	Write brief comment for GetRightVector here.
Vec3f	GetForwardVector ()
	Write brief comment for GetForwardVector here.
Private Attributes
Vec3f	m_vPosition
Vec3f	m_vView
Vec3f	m_vUpVector
Vec3f	m_vStrafe

---

Detailed Description

Write brief comment for Camera here.

Write detailed description for Camera here.

Remarks:

Write remarks for Camera here.

See also:

Separate items with the '|' character.

---

Constructor & Destructor Documentation

OpenArena::Camera::Camera

(

)

Creates a new Camera object.

Creates a new Camera object located at the origin, pointing at the negative z-axis with up being the positive y-axis.

---

Member Function Documentation

void OpenArena::Camera::Camera::RotateView	(	double	angle,
		Vec3d	axis
	)

Write brief comment for RotateView here.

Parameters:

	angle	Description of parameter angle.
	axis	Description of parameter axis.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for RotateView here.

Remarks:

Write remarks for RotateView here.

See also:

Separate items with the '|' character.

Vec3f OpenArena::Camera::GetForwardVector

(

)

[private]

Write brief comment for GetForwardVector here.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for GetForwardVector here.

Remarks:

Write remarks for GetForwardVector here.

See also:

Separate items with the '|' character.

Vec3f OpenArena::Camera::GetRightVector

(

)

[private]

Write brief comment for GetRightVector here.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for GetRightVector here.

Remarks:

Write remarks for GetRightVector here.

See also:

Separate items with the '|' character.

Vec3f OpenArena::Camera::GetUpVector

(

)

[private]

Write brief comment for GetUpVector here.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for GetUpVector here.

Remarks:

Write remarks for GetUpVector here.

See also:

Separate items with the '|' character.

void OpenArena::Camera::Look

(

)

Write brief comment for Look here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for Look here.

Remarks:

Write remarks for Look here.

See also:

Separate items with the '|' character.

void OpenArena::Camera::MoveCamera

(

double

speed

)

Write brief comment for MoveCamera here.

Parameters:

speed

Description of parameter speed.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for MoveCamera here.

Remarks:

Write remarks for MoveCamera here.

See also:

Separate items with the '|' character.

Vec3f OpenArena::Camera::Position

(

)

Returns this Camera's position.

Returns:

This Camera's position as a Vec3d vector.

Returns this Camera's position.

void OpenArena::Camera::PositionCamera	(	Vec3f	pos,
		Vec3f	view,
		Vec3f	up
	)

Write brief comment for PositionCamera here.

Parameters:

	pos	Description of parameter pos.
	view	Description of parameter view.
	up	Description of parameter up.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for PositionCamera here.

Remarks:

Write remarks for PositionCamera here.

See also:

Separate items with the '|' character.

void OpenArena::Camera::PositionCamera	(	double	xpos,
		double	ypos,
		double	zpos,
		double	xview,
		double	yview,
		double	zview,
		double	xup,
		double	yup,
		double	zup
	)

Write brief comment for PositionCamera here.

Parameters:

	xpos	Description of parameter xpos.
	ypos	Description of parameter ypos.
	zpos	Description of parameter zpos.
	xview	Description of parameter xview.
	yview	Description of parameter yview.
	zview	Description of parameter zview.
	xup	Description of parameter xup.
	yup	Description of parameter yup.
	zup	Description of parameter zup.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for PositionCamera here.

Remarks:

Write remarks for PositionCamera here.

See also:

Separate items with the '|' character.

void OpenArena::Camera::RotateHorizontal

(

float

angle

)

Write brief comment for RotateHorizontal here.

Parameters:

angle

Description of parameter angle.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for RotateHorizontal here.

Remarks:

Write remarks for RotateHorizontal here.

See also:

Separate items with the '|' character.

void OpenArena::Camera::RotateVertical

(

float

angle

)

Write brief comment for RotateVertical here.

Parameters:

angle

Description of parameter angle.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for RotateVertical here.

Remarks:

Write remarks for RotateVertical here.

See also:

Separate items with the '|' character.

void OpenArena::Camera::RotateView	(	double	angle,
		double	X,
		double	Y,
		double	Z
	)

Write brief comment for RotateView here.

Parameters:

	angle	Description of parameter angle.
	X	Description of parameter X.
	Y	Description of parameter Y.
	Z	Description of parameter Z.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for RotateView here.

Remarks:

Write remarks for RotateView here.

See also:

Separate items with the '|' character.

void OpenArena::Camera::SetViewByMouse

(

Window

window

)

Write brief comment for SetViewByMouse here.

Parameters:

window

Description of parameter window.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for SetViewByMouse here.

Remarks:

Write remarks for SetViewByMouse here.

See also:

Separate items with the '|' character.

Vec3f OpenArena::Camera::Strafe

(

)

Write brief comment for Strafe here.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for Strafe here.

Remarks:

Write remarks for Strafe here.

See also:

Separate items with the '|' character.

void OpenArena::Camera::StrafeCamera

(

double

speed

)

Write brief comment for StrafeCamera here.

Parameters:

speed

Description of parameter speed.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for StrafeCamera here.

Remarks:

Write remarks for StrafeCamera here.

See also:

Separate items with the '|' character.

void OpenArena::Camera::Update

(

)

Write brief comment for Update here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for Update here.

Remarks:

Write remarks for Update here.

See also:

Separate items with the '|' character.

Vec3f OpenArena::Camera::UpVector

(

)

Write brief comment for UpVector here.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for UpVector here.

Remarks:

Write remarks for UpVector here.

See also:

Separate items with the '|' character.

Vec3f OpenArena::Camera::View

(

)

Write brief comment for View here.

Returns:

Write description of return value here.

Exceptions:

<exception

class> Description of criteria for throwing this exception.

Write detailed description for View here.

Remarks:

Write remarks for View here.

See also:

Separate items with the '|' character.

---

Member Data Documentation

Vec3f OpenArena::Camera::m_vPosition [private]

Vec3f OpenArena::Camera::m_vStrafe [private]

Vec3f OpenArena::Camera::m_vUpVector [private]

Vec3f OpenArena::Camera::m_vView [private]

---

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

• My Documents/Visual Studio 2005/Projects/openarena-clean/src/camera.h
• My Documents/Visual Studio 2005/Projects/openarena-clean/src/camera.cpp

---