Struct CinemachineOrbitalTransposer.Heading

How the "forward" direction is defined. Orbital offset is in relation to the forward direction.

Namespace: Cinemachine

Syntax

[DocumentationSorting(DocumentationSortingAttribute.Level.UserRef)]
[Serializable]
public struct Heading

Constructors

Heading(CinemachineOrbitalTransposer.Heading.HeadingDefinition, Int32, Single)

Constructor

Declaration

public Heading(CinemachineOrbitalTransposer.Heading.HeadingDefinition def, int filterStrength, float bias)

Parameters

Type	Name	Description
CinemachineOrbitalTransposer.Heading.HeadingDefinition	def	The heading definition
Int32	filterStrength	The strength of the heading filter
Single	bias	The heading bias

Fields

m_Bias

Additional Y rotation applied to the target heading. When this value is 0, the camera will be placed behind the target

Declaration

[Range(-180F, 180F)]
[FormerlySerializedAs("m_HeadingBias")]
[Tooltip("Where the camera is placed when the X-axis value is zero.  This is a rotation in degrees around the Y axis.  When this value is 0, the camera will be placed behind the target.  Nonzero offsets will rotate the zero position around the target.")]
public float m_Bias

Field Value

Type	Description
Single

m_Definition

The method by which the 'default heading' is calculated if recentering to target heading is enabled

Declaration

[FormerlySerializedAs("m_HeadingDefinition")]
[Tooltip("How 'forward' is defined.  The camera will be placed by default behind the target.  PositionDelta will consider 'forward' to be the direction in which the target is moving.")]
public CinemachineOrbitalTransposer.Heading.HeadingDefinition m_Definition

Field Value

Type	Description
CinemachineOrbitalTransposer.Heading.HeadingDefinition

m_VelocityFilterStrength

Size of the velocity sampling window for target heading filter. Used only if deriving heading from target's movement

Declaration

[Range(0F, 10F)]
[Tooltip("Size of the velocity sampling window for target heading filter.  This filters out irregularities in the target's movement.  Used only if deriving heading from target's movement (PositionDelta or Velocity)")]
public int m_VelocityFilterStrength

Field Value

Type	Description
Int32