Struct TrackerSettings

Settings to control damping for target tracking.

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Unity.Cinemachine.TargetTracking

Assembly: Unity.Cinemachine.dll

Syntax

[Serializable]
public struct TrackerSettings

Fields

AngularDampingMode

How to calculate the angular damping for the target orientation. Use Quaternion if you expect the target to take on very steep pitches, which would be subject to gimbal lock if Eulers are used.

Declaration

public AngularDampingMode AngularDampingMode

Field Value

Type	Description
AngularDampingMode

BindingMode

The coordinate space to use when interpreting the offset from the target

Declaration

[Tooltip("The coordinate space to use when interpreting the offset from the target.  This is also used to set the camera's Up vector, which will be maintained when aiming the camera.")]
public BindingMode BindingMode

Field Value

Type	Description
BindingMode

PositionDamping

How aggressively the camera tries to maintain the offset, per axis. Small numbers are more responsive, rapidly translating the camera to keep the target's offset. Larger numbers give a more heavy slowly responding camera. Using different settings per axis can yield a wide range of camera behaviors

Declaration

[Tooltip("How aggressively the camera tries to maintain the offset, per axis.  Small numbers are more responsive, rapidly translating the camera to keep the target's offset.  Larger numbers give a more heavy slowly responding camera. Using different settings per axis can yield a wide range of camera behaviors.")]
public Vector3 PositionDamping

Field Value

Type	Description
Vector3

QuaternionDamping

How aggressively the camera tries to track the target's rotation. Small numbers are more responsive. Larger numbers give a more heavy slowly responding camera.

Declaration

[Range(0, 20)]
[Tooltip("How aggressively the camera tries to track the target's rotation.  Small numbers are more responsive.  Larger numbers give a more heavy slowly responding camera.")]
public float QuaternionDamping

Field Value

Type	Description
float

RotationDamping

How aggressively the camera tries to track the target's rotation, per axis. Small numbers are more responsive. Larger numbers give a more heavy slowly responding camera.

Declaration

[Tooltip("How aggressively the camera tries to track the target's rotation, per axis.  Small numbers are more responsive.  Larger numbers give a more heavy slowly responding camera.")]
public Vector3 RotationDamping

Field Value

Type	Description
Vector3

Properties

Default

Get the default tracking settings

Declaration

public static TrackerSettings Default { get; }

Property Value

Type	Description
TrackerSettings

Methods

Validate()

Called from OnValidate(). Makes sure the settings are sensible.

Declaration

public void Validate()

Extension Methods

TrackerSettingsExtensions.GetMaxDampTime(TrackerSettings)