Class CinemachineOrbitalTransposer
This is a deprecated component. Use CinemachineOrbitalFollow instead.
Inheritance
Implements
Inherited Members
Namespace: Unity.Cinemachine
Assembly: solution.dll
Syntax
[Obsolete("CinemachineOrbitalTransposer has been deprecated. Use CinemachineOrbitalFollow instead")]
[AddComponentMenu("")]
[CameraPipeline(CinemachineCore.Stage.Body)]
public class CinemachineOrbitalTransposer : CinemachineTransposer, AxisState.IRequiresInput
Fields
| Name | Description |
|---|---|
| m_Heading | The definition of Forward. Camera will follow behind. |
| m_HeadingIsDriven | Drive the x-axis setting programmatically. Automatic heading updating will be disabled. |
| m_RecenterToTargetHeading | Parameters that control Automating Heading Recentering |
| m_XAxis | Axis representing the current heading. Value is in degrees and represents a rotation about the up vector |
Methods
| Name | Description |
|---|---|
| ForceCameraPosition(Vector3, Quaternion) | Force the virtual camera to assume a given position and orientation |
| GetAxisClosestValue(Vector3, Vector3) | What axis value would we need to get as close as possible to the desired cameraPos? |
| MutateCameraState(ref CameraState, float) | Positions the virtual camera according to the transposer rules. |
| OnEnable() | Standard OnEnable call. Updates the input axis provider. |
| 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. |
| OnTransitionFromCamera(ICinemachineCamera, Vector3, float) | Notification that this virtual camera is going live. Base class implementation does nothing. |
| OnValidate() | Legacy support for old serialized versions |
| 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. |
| 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. |