Handles Camera FPS Controls. More...

Inheritance diagram for VerticesEngine.vxCameraChaseController:

Public Member Functions
void	Reset ()
	Forces camera to be at desired position and to stop moving. The is useful when the chased object is first created or after it has been teleported. Failing to call this after a large change to the chased object's position will result in the camera quickly flying across the world.

Public Member Functions inherited from VerticesEngine.vxComponent
void	Dispose ()
	Called when disposed.

Protected Member Functions
override void	Initialise ()
	Called on Initialise.

Protected Member Functions inherited from VerticesEngine.vxComponent
virtual void	OnDisposed ()

Properties
Vector3	ChasePosition `[get, set]`
	Position of object being chased.

Vector3	ChaseDirection `[get, set]`
	Direction the chased object is facing.

Vector3	Up `[get, set]`
	Chased object's Up vector.

Vector3	DesiredPositionOffset `[get, set]`
	Desired camera position in the chased object's coordinate system.

Vector3	DesiredPosition `[get]`
	Desired camera position in world space.

Vector3	LookAtOffset `[get, set]`
	Look at point in the chased object's coordinate system.

Vector3	LookAt `[get]`
	Look at point in world space.

float	Stiffness `[get, set]`
	Physics coefficient which controls the influence of the camera's position over the spring force. The stiffer the spring, the closer it will stay to the chased object.

float	Damping `[get, set]`
	Physics coefficient which approximates internal friction of the spring. Sufficient damping will prevent the spring from oscillating infinitely.

float	Mass `[get, set]`
	Mass of the camera body. Heaver objects require stiffer springs with less damping to move at the same rate as lighter objects.

Properties inherited from VerticesEngine.vxComponent
bool	IsEnabled `[get, set]`
	Is this enabled.

string	Name `[get, set]`

vxEntity	Entity `[get]`
	The entitiy which owns this component.

bool	IsDisposed `[get]`

Detailed Description

Handles Camera FPS Controls.

Member Function Documentation

override void VerticesEngine.vxCameraChaseController.Initialise ( )

protectedvirtual

Called on Initialise.

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

/github/workspace/src/VerticesEngine/src.shared/Cameras/Components/vxCameraChaseController.cs