CameraOrbit

Description

sealed class Tinman.Engine.Scenes.Entities.CameraOrbit

Derived from

CameraYawPitch abstract

A scene entity view that centers the camera on a given point in local-space, allowing the user to orbit around it.

The ICameraFocus.FocusOffset method adjusts Distance.

Public / Constructors

Camera​Orbit

public constructor CameraOrbit → ()

Creates a new instance of CameraOrbit.

Public / Attributes

Distance

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

value : float64

The distance, which will be clamped to DistanceRange.

The current distance between the camera and the point being orbited.

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.

Distance​Control

public attribute DistanceControl → (get,set)

value : InputModifiers

The input modifiers.

The input modifiers that must be present to enable control of Distance via the mouse, in addition to the default mouse wheel control.

Defaults to InputModifiers.Left and InputModifiers.Right.

Distance​Range

public attribute DistanceRange → (get,set)

value : RangeD

The camera distance range, which will be used to clamp Distance.

The range of allowed camera distance values.

Defaults to 0..Maths.MaxDouble.

Distance​Rate

public attribute DistanceRate → (get,set)

value : float64

The distance change rate (see remarks). Set to 0 to disable distance control.

The distance change rate for mouse control.

For a mouse wheel movement of w, the distance is changed as follows:

distance = distance * pow(sqrt(2), w / rate)

Defaults to 3.

See also

InputEvent.MouseWheel