CameraYawPitch

Description

abstract class Tinman.Engine.Scenes.Entities.CameraYawPitch

Derived from

CameraCenter abstract
ISceneEntityViewFocusable

Extended by

CameraOrbit sealed

Abstract base class for scene entity views that place the camera in the coordinate system of an arbitrary local-space and allow the user to control its yaw and pitch angles.

Public / Methods

Rotate

public method Rotate → (2)

yaw in : float64

The Yaw delta to apply.

pitch in : float64

The Pitch delta to apply.

Rotates the camera.

Public / Attributes

Pitch

[JsonProperty]
public attribute Pitch → (get,set)

value : float64

The pitch angle in degrees, which will be clamped to PitchRange.

The pitch angle of the camera.

When setting the value and the range in one go, make sure to set the range first. Otherwise, the new value might get clamped to the old range. Defaults to 0.

See also

YawPitchRollTransform

Pitch​Range

public attribute PitchRange → (get,set)

value : RangeD

The allowed pitch angle range in degrees, which will be used to clamp Pitch.

The allowed range of pitch angles.

Defaults to [-90..90] degrees.

Pitch​Rate

public attribute PitchRate → (get,set)

value : float64

The rotation rate, given in screen pixels per degree.

The pitch rotation rate for mouse control.

Defaults to 3.

See also

InputEvent.MouseMove

Yaw

[JsonProperty]
public attribute Yaw → (get,set)

value : float64

The pitch angle in degrees, which will be clamped to YawRange.

The yaw angle of the camera.

When setting the value and the range in one go, make sure to set the range first. Otherwise, the new value might get clamped to the old range. Defaults to 0.

See also

YawPitchRollTransform

Yaw​Pitch​Control

public attribute YawPitchControl → (get,set)

value : InputModifiers

The input modifiers.

The input modifiers that must be present to enable control of Yaw and Pitch via the mouse.

Defaults to InputModifiers.Right.

Yaw​Range

public attribute YawRange → (get,set)

value : RangeD

The allowed yaw angle range in degrees, which will be used to clamp Yaw.

The allowed range of yaw angles.

Defaults to [-180..180] degrees.

Yaw​Rate

public attribute YawRate → (get,set)

value : float64

The rotation rate, given in screen pixels per degree.

The yaw rotation rate for mouse control.

Defaults to 3.

See also

InputEvent.MouseMove

Protected / Constructors

Camera​Yaw​Pitch

protected constructor CameraYawPitch → (1)

callbackMask opt : SceneObjectCallback = SceneObjectCallback.None

The value for ISceneObject.CallbackMask.

Creates a new instance of CameraYawPitch.

Protected / Attributes

modifiers

protected attribute modifiers → (InputModifiers)

The pressed mouse buttons.