Class CinemachineOrbitalTransposer

This is a deprecated component. Use CinemachineOrbitalFollow instead.

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
CinemachineComponentBase
CinemachineTransposer
CinemachineOrbitalTransposer
Implements
Inherited Members
Component.GetComponentIndex()
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
Object.Instantiate(Object, Scene)
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: Unity.Cinemachine
Assembly: Unity.Cinemachine.dll
Syntax
[Obsolete("CinemachineOrbitalTransposer has been deprecated. Use CinemachineOrbitalFollow instead")]
[AddComponentMenu("")]
[CameraPipeline(CinemachineCore.Stage.Body)]
public class CinemachineOrbitalTransposer : CinemachineTransposer, AxisState.IRequiresInput

Fields

m_Heading

The definition of Forward. Camera will follow behind.

Declaration
[Space]
[Tooltip("The definition of Forward.  Camera will follow behind.")]
public CinemachineOrbitalTransposer.Heading m_Heading
Field Value
Type Description
CinemachineOrbitalTransposer.Heading

m_HeadingIsDriven

Drive the x-axis setting programmatically. Automatic heading updating will be disabled.

Declaration
[FormerlySerializedAs("m_HeadingIsSlave")]
[HideInInspector]
public bool m_HeadingIsDriven
Field Value
Type Description
bool

m_RecenterToTargetHeading

Parameters that control Automating Heading Recentering

Declaration
[Tooltip("Automatic heading recentering.  The settings here defines how the camera will reposition itself in the absence of player input.")]
public AxisState.Recentering m_RecenterToTargetHeading
Field Value
Type Description
AxisState.Recentering

m_XAxis

Axis representing the current heading. Value is in degrees and represents a rotation about the up vector

Declaration
[Tooltip("Heading Control.  The settings here control the behaviour of the camera in response to the player's input.")]
public AxisState m_XAxis
Field Value
Type Description
AxisState

Methods

ForceCameraPosition(Vector3, Quaternion)

Force the virtual camera to assume a given position and orientation

Declaration
public override void ForceCameraPosition(Vector3 pos, Quaternion rot)
Parameters
Type Name Description
Vector3 pos

Worldspace position to take
Quaternion rot

Worldspace orientation to take
Overrides

GetAxisClosestValue(Vector3, Vector3)

What axis value would we need to get as close as possible to the desired cameraPos?

Declaration
public float GetAxisClosestValue(Vector3 cameraPos, Vector3 up)
Parameters
Type Name Description
Vector3 cameraPos

camera position we would like to approximate
Vector3 up

world up
Returns
Type Description
float

The best value to put into the X axis, to approximate the desired camera pos

MutateCameraState(ref CameraState, float)

Positions the virtual camera according to the transposer rules.

Declaration
public override void MutateCameraState(ref CameraState curState, float deltaTime)
Parameters
Type Name Description
CameraState curState

The current camera state
float deltaTime

Used for damping. If less than 0, no damping is done.
Overrides

OnEnable()

Standard OnEnable call. Updates the input axis provider.

Declaration
protected override void OnEnable()
Overrides

OnTargetObjectWarped(Transform, Vector3)

This is called to notify the user that a target got warped, so that we can update its internal state to make the camera also warp seamlessly.

Declaration
public override void OnTargetObjectWarped(Transform target, Vector3 positionDelta)
Parameters
Type Name Description
Transform target

The object that was warped
Vector3 positionDelta

The amount the target's position changed
Overrides

OnTransitionFromCamera(ICinemachineCamera, Vector3, float)

Notification that this virtual camera is going live. Base class implementation does nothing.

Declaration
public override bool OnTransitionFromCamera(ICinemachineCamera fromCam, Vector3 worldUp, float deltaTime)
Parameters
Type Name Description
ICinemachineCamera fromCam

The camera being deactivated. May be null.
Vector3 worldUp

Default world Up, set by the CinemachineBrain
float deltaTime

Delta time for time-based effects (ignore if less than or equal to 0)
Returns
Type Description
bool

True if the vcam should do an internal update as a result of this call
Overrides

OnValidate()

Legacy support for old serialized versions

Declaration
protected override void OnValidate()
Overrides

UpdateHeading(float, Vector3, ref AxisState)

Update the X axis and calculate the heading. This can be called by a delegate with a custom axis. Note that this method is obsolete.

Declaration
public float UpdateHeading(float deltaTime, Vector3 up, ref AxisState axis)
Parameters
Type Name Description
float deltaTime

Used for damping. If less than 0, no damping is done.
Vector3 up

World Up, set by the CinemachineBrain
AxisState axis

The axis whose heading to update.
Returns
Type Description
float

Axis value

UpdateHeading(float, Vector3, ref AxisState, ref Recentering, bool)

Update the X axis and calculate the heading. This can be called by a delegate with a custom axis.

Declaration
public float UpdateHeading(float deltaTime, Vector3 up, ref AxisState axis, ref AxisState.Recentering recentering, bool isLive)
Parameters
Type Name Description
float deltaTime

Used for damping. If less than 0, no damping is done.
Vector3 up

World Up, set by the CinemachineBrain
AxisState axis

The axis whose heading to update.
AxisState.Recentering recentering

The recentering state.
bool isLive

true if the vcam is live
Returns
Type Description
float

Axis value

Implements