CEL

Public API Reference

Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members

iCelCameraMode Struct Reference

List of all members.

Public Member Functions

virtual void SetParentCamera (iPcNewCamera *camera)=0
 Tells the camera mode what camera has it attached.
virtual bool UseSpringPhysics () const =0
 Decides if this camera mode should use spring physics or not.
virtual bool DrawAttachedMesh () const =0
 Decides if the mesh the camera is attached to should be drawn or not in this mode.
virtual float GetSpringCoefficient () const =0
 Gets the spring coefficient to use for the spring physics.
virtual float GetSpringLength () const =0
 Gets the spring length to use for the spring physics.
virtual float GetInertialDampeningCoefficient () const =0
 Gets the inertial dampening coefficient to use for the spring physics.
virtual const csVector3 & GetPositionOffset () const =0
 Gets the desired camera position as an offset of the player's position.
virtual const csVector3 & GetDirection () const =0
 Gets the desired camera direction.
virtual const csVector3 & GetUp () const =0
 Gets the desired camera up vector.
virtual bool DecideCameraState ()=0
 Informs the camera mode that it should compute the desired position, direction, up, etc.

Detailed Description

Definition at line 55 of file newcamera.h.


Member Function Documentation

virtual bool iCelCameraMode::DecideCameraState  )  [pure virtual]
 

Informs the camera mode that it should compute the desired position, direction, up, etc.

of the camera now.

Returns:
True on success.

virtual bool iCelCameraMode::DrawAttachedMesh  )  const [pure virtual]
 

Decides if the mesh the camera is attached to should be drawn or not in this mode.

Returns:
True if the attached mesh should be drawn.

virtual const csVector3& iCelCameraMode::GetDirection  )  const [pure virtual]
 

Gets the desired camera direction.

Returns:
The desired camera direction.

virtual float iCelCameraMode::GetInertialDampeningCoefficient  )  const [pure virtual]
 

Gets the inertial dampening coefficient to use for the spring physics.

Returns:
The inertial dampening coefficient of this camera.

virtual const csVector3& iCelCameraMode::GetPositionOffset  )  const [pure virtual]
 

Gets the desired camera position as an offset of the player's position.

Returns:
The desired camera position as an offset of the player's position.

virtual float iCelCameraMode::GetSpringCoefficient  )  const [pure virtual]
 

Gets the spring coefficient to use for the spring physics.

Returns:
The spring coefficient of this camera mode.

virtual float iCelCameraMode::GetSpringLength  )  const [pure virtual]
 

Gets the spring length to use for the spring physics.

Returns:
The spring length of this camera mode.

virtual const csVector3& iCelCameraMode::GetUp  )  const [pure virtual]
 

Gets the desired camera up vector.

Returns:
The desired camera up vector.

virtual void iCelCameraMode::SetParentCamera iPcNewCamera camera  )  [pure virtual]
 

Tells the camera mode what camera has it attached.

Parameters:
camera The parent camera.

virtual bool iCelCameraMode::UseSpringPhysics  )  const [pure virtual]
 

Decides if this camera mode should use spring physics or not.

Returns:
True if this camera mode uses spring physics.


The documentation for this struct was generated from the following file:
Generated for CEL: Crystal Entity Layer by doxygen 1.4.4