ogl::CCamera Class Reference
[OpenGL module, Nodes]

A generic camera node. More...

#include <OpenGLModule.h>

Inherits fsf::CNode.

Collaboration diagram for ogl::CCamera:

[legend]

List of all members.

Public Member Functions
Creators
	CCamera ()
	Default constructor.
	CCamera (fsf::CNode *pParent, fsf::Time tTime=0)
	2-parameter constructor: parent and time stamp
	CCamera (std::string &strName, fsf::CNode *pParent, fsf::Time tTime=0)
	3-parameter constructor: node name, parent and time stamp
	CCamera (const CCamera &rhs)
	Copy constructor.
virtual fsf::CNode *	clone () const
	Cloning: necessary for run-time polymorphism.
Manipulators
CCamera &	operator= (const CCamera &)
	Assignment operator.
void	lockCamera ()
	Locks camera mutex.
void	unlockCamera ()
	Unlocks camera mutex.
void	setX (double d)
	Sets X coordinate of camera position (world coordinates).
void	setY (double d)
	Sets Y coordinate of camera position (world coordinates).
void	setZ (double d)
	Sets Z coordinate of camera position (world coordinates).
void	setRefX (double d)
	Sets X coordinate of reference point position (world coordinates).
void	setRefY (double d)
	Sets Y coordinate of reference point position (world coordinates).
void	setRefZ (double d)
	Sets Z coordinate of reference point position (world coordinates).
void	setUpX (double d)
	Sets X component of up vector (world coordinates).
void	setUpY (double d)
	Sets Y component of up vector (world coordinates).
void	setUpZ (double d)
	Sets Z component of up vector (world coordinates).
void	setNearDistance (double dNear)
	Sets near distance (camera coordinates).
void	setFarDistance (double dFar)
	Sets far distance (camera coordinates).
void	setLeft (double dLeft)
	Sets coordinate of left clipping plane (camera coordinates).
void	setRight (double dRight)
	Sets coordinate of right clipping plane (camera coordinates).
void	setBottom (double dBottom)
	Sets coordinate of bottom clipping plane (camera coordinates).
void	setTop (double dTop)
	Sets coordinate of top clipping plane (camera coordinates).
void	frustum ()
	Calls OpenGL's glFrustum with this camera's parameter values.
void	ortho ()
	Calls OpenGL's glOrtho with this camera's parameter values.
void	lookAt ()
	Calls GLU's g;uLookAt with this camera's parameter values.
Accessors
virtual void	getTypeID (std::string &str) const
double	getX () const
	Gets X coordinate of camera position (world coordinates).
double	getY () const
	Gets Y coordinate of camera position (world coordinates).
double	getZ () const
	Gets Z coordinate of camera position (world coordinates).
double	getRefX () const
	Gets X coordinate of reference point position (world coordinates).
double	getRefY () const
	Gets Y coordinate of reference point position (world coordinates).
double	getRefZ () const
	Gets Z coordinate of reference point position (world coordinates).
double	getUpX () const
	Gets X component of up vector (world coordinates).
double	getUpY () const
	Gets Y component of up vector (world coordinates).
double	getUpZ () const
	Gets Z component of up vector (world coordinates).
double	getNearDistance () const
	Gets near distance (camera coordinates).
double	getFarDistance () const
	Gets far distance (camera coordinates).
double	getLeft () const
	Gets coordinate of left clipping plane (camera coordinates).
double	getRight () const
	Gets coordinate of right clipping plane (camera coordinates).
double	getBottom () const
	Gets coordinate of bottom clipping plane (camera coordinates).
double	getTop () const
	Gets coordinate of top clipping plane (camera coordinates).

---

Detailed Description

A generic camera node.

Encapsulates OpenGL's camera attributes

---

Constructor & Destructor Documentation

ogl::CCamera::CCamera

(

)

[inline]

Default constructor.

ogl::CCamera::CCamera	(	fsf::CNode *	pParent,
		fsf::Time	tTime = 0
	)			[inline]

2-parameter constructor: parent and time stamp

ogl::CCamera::CCamera	(	std::string &	strName,
		fsf::CNode *	pParent,
		fsf::Time	tTime = 0
	)			[inline]

3-parameter constructor: node name, parent and time stamp

CCamera::CCamera

(

const CCamera &

rhs

)

Copy constructor.

---

Member Function Documentation

virtual fsf::CNode* ogl::CCamera::clone

(

)

const [inline, virtual]

Cloning: necessary for run-time polymorphism.

Reimplemented from fsf::CNode.

void ogl::CCamera::frustum

(

)

[inline]

Calls OpenGL's glFrustum with this camera's parameter values.

double ogl::CCamera::getBottom

(

)

const [inline]

Gets coordinate of bottom clipping plane (camera coordinates).

double ogl::CCamera::getFarDistance

(

)

const [inline]

Gets far distance (camera coordinates).

double ogl::CCamera::getLeft

(

)

const [inline]

Gets coordinate of left clipping plane (camera coordinates).

double ogl::CCamera::getNearDistance

(

)

const [inline]

Gets near distance (camera coordinates).

double ogl::CCamera::getRefX

(

)

const [inline]

Gets X coordinate of reference point position (world coordinates).

double ogl::CCamera::getRefY

(

)

const [inline]

Gets Y coordinate of reference point position (world coordinates).

double ogl::CCamera::getRefZ

(

)

const [inline]

Gets Z coordinate of reference point position (world coordinates).

double ogl::CCamera::getRight

(

)

const [inline]

Gets coordinate of right clipping plane (camera coordinates).

double ogl::CCamera::getTop

(

)

const [inline]

Gets coordinate of top clipping plane (camera coordinates).

virtual void ogl::CCamera::getTypeID

(

std::string &

str

)

const [inline, virtual]

Reimplemented from fsf::CNode.

double ogl::CCamera::getUpX

(

)

const [inline]

Gets X component of up vector (world coordinates).

double ogl::CCamera::getUpY

(

)

const [inline]

Gets Y component of up vector (world coordinates).

double ogl::CCamera::getUpZ

(

)

const [inline]

Gets Z component of up vector (world coordinates).

double ogl::CCamera::getX

(

)

const [inline]

Gets X coordinate of camera position (world coordinates).

double ogl::CCamera::getY

(

)

const [inline]

Gets Y coordinate of camera position (world coordinates).

double ogl::CCamera::getZ

(

)

const [inline]

Gets Z coordinate of camera position (world coordinates).

void ogl::CCamera::lockCamera

(

)

[inline]

Locks camera mutex.

void ogl::CCamera::lookAt

(

)

[inline]

Calls GLU's g;uLookAt with this camera's parameter values.

CCamera & CCamera::operator=

(

const CCamera &

rhs

)

Assignment operator.

void ogl::CCamera::ortho

(

)

[inline]

Calls OpenGL's glOrtho with this camera's parameter values.

void ogl::CCamera::setBottom

(

double

dBottom

)

[inline]

Sets coordinate of bottom clipping plane (camera coordinates).

void ogl::CCamera::setFarDistance

(

double

dFar

)

[inline]

Sets far distance (camera coordinates).

void ogl::CCamera::setLeft

(

double

dLeft

)

[inline]

Sets coordinate of left clipping plane (camera coordinates).

void ogl::CCamera::setNearDistance

(

double

dNear

)

[inline]

Sets near distance (camera coordinates).

void ogl::CCamera::setRefX

(

double

d

)

[inline]

Sets X coordinate of reference point position (world coordinates).

void ogl::CCamera::setRefY

(

double

d

)

[inline]

Sets Y coordinate of reference point position (world coordinates).

void ogl::CCamera::setRefZ

(

double

d

)

[inline]

Sets Z coordinate of reference point position (world coordinates).

void ogl::CCamera::setRight

(

double

dRight

)

[inline]

Sets coordinate of right clipping plane (camera coordinates).

void ogl::CCamera::setTop

(

double

dTop

)

[inline]

Sets coordinate of top clipping plane (camera coordinates).

void ogl::CCamera::setUpX

(

double

d

)

[inline]

Sets X component of up vector (world coordinates).

void ogl::CCamera::setUpY

(

double

d

)

[inline]

Sets Y component of up vector (world coordinates).

void ogl::CCamera::setUpZ

(

double

d

)

[inline]

Sets Z component of up vector (world coordinates).

void ogl::CCamera::setX

(

double

d

)

[inline]

Sets X coordinate of camera position (world coordinates).

void ogl::CCamera::setY

(

double

d

)

[inline]

Sets Y coordinate of camera position (world coordinates).

void ogl::CCamera::setZ

(

double

d

)

[inline]

Sets Z coordinate of camera position (world coordinates).

void ogl::CCamera::unlockCamera

(

)

[inline]

Unlocks camera mutex.

---

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

• OpenGLModule.h
• OpenGLModule.cc