Jumpvalley.Players.Camera.BaseCamera Class Reference

The base class that handles a 3d camera focusing on a 3d object. It includes support for camera panning and zoom controls. More...

Inheritance diagram for Jumpvalley.Players.Camera.BaseCamera:

Public Member Functions
Vector3	GetRotation ()
	Creates and returns a Vector3 with "x" representing the camera's pitch, "y" representing the camera's yaw, and "z" representing the camera's roll.
Vector3	GetPosition ()
	Calculates the camera position based on the position of the FocusedNode and the value of RightOffset
void	Update ()
	Updates the position and rotation of the currently associated Camera.
new void	Dispose ()
	Disposes of this BaseCamera object.
override void	_Process (double delta)

Public Attributes
float	PanningSensitivity = 0
	How sensitive camera panning is to player input. This value multiplies PanningSpeed when camera rotations are done through user input, such as when rotation is controlled by the mouse.
float	PanningSpeed = 0
	"Default" camera panning speed in radians per second. This value is used when the camera needs to be turned at a constant speed. It also serves as a factor for calculating the speed of the camera rotation every input/process frame when the camera rotation is done in response to user input.
float	Yaw = 0
	The yaw angle of the camera.
float	Roll = 0
	The roll angle of the camera.
float	MinPitch = (float)(-0.5 * Math.PI)
	The smallest pitch angle in radians that the camera can rotate in.
float	MaxPitch = (float)(0.5 * Math.PI)
	The largest pitch angle in radians that the camera can rotate in.
float	RightOffset = 0
	The offset of the camera's position to the right from the object that the camera is focusing on.
float	MinZoomOutDistance = 0
	The minimum value of ZoomOutDistance in meters.
float	MaxZoomOutDistance = 0
	The maximum value of ZoomOutDistance in meters.
Camera3D	Camera = null
	The actual camera node that this BaseCamera is associated with.
Node3D	FocusedNode = null
	The actual 3d node that the camera is focusing on.

Protected Member Functions
void	RaiseZoomOutDistanceChanged (float zoomOutDistance)

Properties
float	Pitch [get, set]
	The pitch angle of the camera.
float	ZoomOutDistance [get, set]
	How far zoomed out (in meters) that the camera is from the object that the camera is focusing on A value of 0 means that the camera is in first person while a value greater than 0 means that the camera is in third person.

Events
EventHandler< float >	ZoomOutDistanceChanged
	Event that's raised when the value of zoom out distance changes. The float argument is the new value of ZoomOutDistance

Detailed Description

The base class that handles a 3d camera focusing on a 3d object. It includes support for camera panning and zoom controls.

Member Function Documentation

GetPosition()

Vector3 Jumpvalley.Players.Camera.BaseCamera.GetPosition ( )

inline

Calculates the camera position based on the position of the FocusedNode and the value of RightOffset

Returns

The calculated camera position

GetRotation()

Vector3 Jumpvalley.Players.Camera.BaseCamera.GetRotation ( )

inline

Creates and returns a Vector3 with "x" representing the camera's pitch, "y" representing the camera's yaw, and "z" representing the camera's roll.

Returns

The created Vector3

---

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

• BaseCamera.cs