iPcDefaultCamera Class Reference
This is a property class that wraps a standard first-person and third-person camera and related functionality. More...
#include <propclass/defcam.h>
Inheritance diagram for iPcDefaultCamera:

Public Types | |
enum | CameraMode |
Camera modes. More... | |
Public Member Functions | |
virtual bool | SetMode (CameraMode m, bool use_cd=true)=0 |
Set camera mode. | |
virtual CameraMode | GetMode () const =0 |
Get camera mode. | |
virtual bool | SetModeName (const char *m, bool use_cd=true)=0 |
Set camera mode by name. | |
virtual const char * | GetModeName () const =0 |
Get camera mode name. | |
virtual CameraMode | GetNextMode () const =0 |
Get next possible camera mode. | |
virtual void | SetSpringParameters (float springCoef, float intertialDampeningCoef, float springLength)=0 |
Set spring parameters for the current camera mode. | |
virtual void | SetMinMaxCameraDistance (float minDistance, float maxDistance)=0 |
Set the minimum and maximum distance between camera and player. | |
virtual void | SetTurnSpeed (float turnSpeed)=0 |
Set the turn speed for the camera. | |
virtual void | SetSwingCoef (float swingCoef)=0 |
Set the swing coefficient for the camera. | |
virtual void | SetFirstPersonOffset (const csVector3 &offset)=0 |
Set offset for first person camera (offset for camera relative to player model). | |
virtual void | SetThirdPersonOffset (const csVector3 &offset)=0 |
Set offset for third person camera (offset for camera relative to player model). | |
virtual void | CenterCamera ()=0 |
Center camera in any mode except first person mode. | |
virtual void | SetPitch (float pitch)=0 |
Control pitch. | |
virtual float | GetPitch () const =0 |
Get current pitch. | |
virtual void | SetPitchVelocity (float pitchVel)=0 |
Control velocity of pitch. | |
virtual float | GetPitchVelocity () const =0 |
Get current pitch velocity. | |
virtual void | MovePitch (float deltaPitch, int mode=-1)=0 |
Moves the pitch (up/down) of the camera. | |
virtual void | SetYaw (float yaw, int mode=-1)=0 |
Sets the yaw (left/right) of the camera. | |
virtual void | MoveYaw (float deltaYaw, int mode=-1)=0 |
Moves the yaw (left/right) of the camera. | |
virtual float | GetYaw (int mode=-1) const =0 |
Returns the yaw (left/right) of the camera. | |
virtual void | SetYawVelocity (float yawVel)=0 |
Sets the yaw (up/down) velocity of the camera. | |
virtual float | GetYawVelocity () const =0 |
Gets the yaw (up/down) velocity of the camera. | |
virtual void | SetDistance (float distance, int mode=-1)=0 |
Set the distance between the character's eyes and the camera. |
Detailed Description
This is a property class that wraps a standard first-person and third-person camera and related functionality.It depends on either iPcMesh or iPcLinearMovement.
This property class supports the following actions (add prefix 'cel.action.' to get the ID of the action and add prefix 'cel.parameter.' to get the ID of the parameter):
- SetCamera: parameters 'modename' (string), 'spring' (vector3), 'turnspeed' (float), 'swingcoef' (float), 'fpoffset' (vector3), 'tpoffset' (vector3), 'pitch' (float), 'pitchvelocity' (float), 'yaw' (float), 'yawvelocity' (float) and 'distance' (vector3=min,def,max).
- SetZoneManager: parameters 'entity' (string), 'entity' (region) and 'start' (string).
Definition at line 44 of file defcam.h.
Member Enumeration Documentation
|
Camera modes.
|
Member Function Documentation
|
Center camera in any mode except first person mode. This will basically force the camera behind the actor. |
|
Get camera mode.
|
|
Get camera mode name.
|
|
Get next possible camera mode. This is useful for looping over all camera modes with some key in a game. |
|
Get current pitch.
|
|
Get current pitch velocity.
|
|
Returns the yaw (left/right) of the camera.
|
|
Gets the yaw (up/down) velocity of the camera.
|
|
Moves the pitch (up/down) of the camera.
|
|
Moves the yaw (left/right) of the camera.
|
|
Set the distance between the character's eyes and the camera. The camera algorithms are responsible for calculating the actual position of the camera. |
|
Set offset for first person camera (offset for camera relative to player model).
|
|
Set the minimum and maximum distance between camera and player. Only used by m64_thirdperson, lara_thirdperson, and freelook. |
|
Set camera mode.
|
|
Set camera mode by name.
|
|
Control pitch.
|
|
Control velocity of pitch. This can be useful for looking up or down. |
|
Set spring parameters for the current camera mode.
|
|
Set the swing coefficient for the camera. Only used by lara_thirdperson. |
|
Set offset for third person camera (offset for camera relative to player model).
|
|
Set the turn speed for the camera. Only used by lara_thirdperson and m64_thirdperson. |
|
Sets the yaw (left/right) of the camera.
|
|
Sets the yaw (up/down) velocity of the camera.
|
The documentation for this class was generated from the following file:
- propclass/defcam.h
Generated for CEL: Crystal Entity Layer by doxygen 1.4.4