Public API Reference

               

---

csCameraPosition::CameraPosition Struct Reference

iCameraPosition implementation. More...

#include <campos.h>

Inheritance diagram for csCameraPosition::CameraPosition:

List of all members.

Public Methods
virtual iObject *	QueryObject ()
	Get the iObject for this camera position. More...
virtual iCameraPosition *	Clone () const
	Create a clone this camera position. More...
virtual const char *	GetSector ()
	Return the home sector. More...
virtual void	SetSector (const char *Name)
	Set the home sector. More...
virtual const csVector3 &	GetPosition ()
	Return the position. More...
virtual void	SetPosition (const csVector3 &v)
	Set the position. More...
virtual const csVector3 &	GetUpwardVector ()
	Return the 'up' vector. More...
virtual void	SetUpwardVector (const csVector3 &v)
	Set the 'up' vector. More...
virtual const csVector3 &	GetForwardVector ()
	Return the 'front' vector. More...
virtual void	SetForwardVector (const csVector3 &v)
	Set the 'front' vector. More...
virtual void	Set (const char *sector, const csVector3 &pos, const csVector3 &forward, const csVector3 &upward)
	Set all attributes of the camera position. More...
virtual bool	Load (iCamera *c, iEngine *e)
	Load the camera position into a camera object. More...
virtual void	SetFarPlane (csPlane3 *pl)
	Set the 3D far plane used to clip all geometry. More...
virtual void	ClearFarPlane ()
	Clear the far plane so no clipping will occur. More...
virtual csPlane3 *	GetFarPlane () const
	Get the current far plane (or NULL if none is defined). More...

---

Detailed Description

iCameraPosition implementation.

Definition at line 78 of file csengine/campos.h.

---

Member Function Documentation

virtual void csCameraPosition::CameraPosition::ClearFarPlane (    )  [inline, virtual]

Clear the far plane so no clipping will occur. This is equivalent to SetFarPlane(NULL). Implements iCameraPosition. Definition at line 99 of file csengine/campos.h.

virtual iCameraPosition* csCameraPosition::CameraPosition::Clone (    )  const [virtual]

Create a clone this camera position. Implements iCameraPosition.

virtual csPlane3* csCameraPosition::CameraPosition::GetFarPlane (    )  const [inline, virtual]

Get the current far plane (or NULL if none is defined). Implements iCameraPosition. Definition at line 103 of file csengine/campos.h.

virtual const csVector3& csCameraPosition::CameraPosition::GetForwardVector (    )  [virtual]

Return the 'front' vector. Implements iCameraPosition.

virtual const csVector3& csCameraPosition::CameraPosition::GetPosition (    )  [virtual]

Return the position. Implements iCameraPosition.

virtual const char* csCameraPosition::CameraPosition::GetSector (    )  [virtual]

Return the home sector. Implements iCameraPosition.

virtual const csVector3& csCameraPosition::CameraPosition::GetUpwardVector (    )  [virtual]

Return the 'up' vector. Implements iCameraPosition.

virtual bool csCameraPosition::CameraPosition::Load (  iCamera *    c, iEngine *    e )  [virtual]

Load the camera position into a camera object. Implements iCameraPosition.

virtual iObject* csCameraPosition::CameraPosition::QueryObject (    )  [virtual]

Get the iObject for this camera position. Implements iCameraPosition.

virtual void csCameraPosition::CameraPosition::Set (  const char *    sector, const csVector3 &    pos, const csVector3 &    forward, const csVector3 &    upward )  [virtual]

Set all attributes of the camera position. Implements iCameraPosition.

virtual void csCameraPosition::CameraPosition::SetFarPlane (  csPlane3 *    pl )  [inline, virtual]

Set the 3D far plane used to clip all geometry. If the pointer is NULL then far plane clipping will be disabled. Otherwise it will be enabled and the plane will be copied (so you can free or reuse the pointer you give here). Note that the far-plane will cull away geometry which is on the negative side of the plane (with csPlane3::Classify() function). Implements iCameraPosition. Definition at line 95 of file csengine/campos.h.

virtual void csCameraPosition::CameraPosition::SetForwardVector (  const csVector3 &    v )  [virtual]

Set the 'front' vector. Implements iCameraPosition.

virtual void csCameraPosition::CameraPosition::SetPosition (  const csVector3 &    v )  [virtual]

Set the position. Implements iCameraPosition.

virtual void csCameraPosition::CameraPosition::SetSector (  const char *    Name )  [virtual]

Set the home sector. Implements iCameraPosition.

virtual void csCameraPosition::CameraPosition::SetUpwardVector (  const csVector3 &    v )  [virtual]

Set the 'up' vector. Implements iCameraPosition.

---

The documentation for this struct was generated from the following file:

• csengine/campos.h

---