Class CinemachineTransposer
This is a deprecated component. Use CinemachineOrbitalFollow instead.
Inheritance
Inherited Members
Namespace: Unity.Cinemachine
Assembly: solution.dll
Syntax
[Obsolete("CinemachineTransposer has been deprecated. Use CinemachineFollow instead")]
[AddComponentMenu("")]
[CameraPipeline(CinemachineCore.Stage.Body)]
public class CinemachineTransposer : CinemachineComponentBase
Fields
Name | Description |
---|---|
m_AngularDamping | How aggressively the camera tries to track the target's orientation. Small numbers are more responsive. Larger numbers give a more heavy slowly responding camera. |
m_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. |
m_BindingMode | The coordinate space to use when interpreting the offset from the target |
m_FollowOffset | The distance which the transposer will attempt to maintain from the transposer subject |
m_PitchDamping | How aggressively the camera tries to track the target rotation's X angle. Small numbers are more responsive. Larger numbers give a more heavy slowly responding camera. |
m_RollDamping | How aggressively the camera tries to track the target rotation's Z angle. Small numbers are more responsive. Larger numbers give a more heavy slowly responding camera. |
m_XDamping | How aggressively the camera tries to maintain the offset in the X-axis. Small numbers are more responsive, rapidly translating the camera to keep the target's x-axis offset. Larger numbers give a more heavy slowly responding camera. Using different settings per axis can yield a wide range of camera behaviors |
m_YDamping | How aggressively the camera tries to maintain the offset in the Y-axis. Small numbers are more responsive, rapidly translating the camera to keep the target's y-axis offset. Larger numbers give a more heavy slowly responding camera. Using different settings per axis can yield a wide range of camera behaviors |
m_YawDamping | How aggressively the camera tries to track the target rotation's Y angle. Small numbers are more responsive. Larger numbers give a more heavy slowly responding camera. |
m_ZDamping | How aggressively the camera tries to maintain the offset in the Z-axis. Small numbers are more responsive, rapidly translating the camera to keep the target's z-axis offset. Larger numbers give a more heavy slowly responding camera. Using different settings per axis can yield a wide range of camera behaviors |
Properties
Name | Description |
---|---|
EffectiveOffset | Get the target offset, with sanitization |
IsValid | True if component is enabled and has a valid Follow target |
Stage | Get the Cinemachine Pipeline stage that this component implements. Always returns the Body stage |
TrackerSettings | Get the damping settings |
Methods
Name | Description |
---|---|
ForceCameraPosition(Vector3, Quaternion) | Force the virtual camera to assume a given position and orientation |
GetMaxDampTime() | Report maximum damping time needed for this component. |
MutateCameraState(ref CameraState, float) | Positions the virtual camera according to the transposer rules. |
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. |
OnValidate() | Derived classes should call this from their OnValidate() implementation |