Cinemachine
 | CinemachineTransposer Class |
This is a CinemachineComponent in the Body section of the component pipeline.
Its job is to position the camera in a fixed relationship to the vcam's Follow
target object, with offsets and damping.
The Tansposer will only change the camera's position in space. It will not
re-orient or otherwise aim the camera. To to that, you need to instruct
the vcam in the Aim section of its pipeline.
Inheritance HierarchySystemObject Object
Component
Behaviour
MonoBehaviour
CinemachineCinemachineComponentBase
CinemachineCinemachineTransposer
CinemachineCinemachineOrbitalTransposer
Component
Behaviour
MonoBehaviour
CinemachineCinemachineComponentBase
CinemachineCinemachineTransposer
CinemachineCinemachineOrbitalTransposer
Namespace: Cinemachine
Assembly: Cinemachine (in Cinemachine.dll) Version: 2.0.0.0 (2.0.0.0)
Syntax[DocumentationSortingAttribute(5f, DocumentationSortingAttributeLevel.UserRef)] [AddComponentMenu("")] [RequireComponent(typeof(CinemachinePipeline))] [SaveDuringPlayAttribute] public class CinemachineTransposer : CinemachineComponentBase
Cinemachine.CinemachineTransposer = function(); Type.createClass( 'Cinemachine.CinemachineTransposer', Cinemachine.CinemachineComponentBase);
The CinemachineTransposer type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CinemachineTransposer |
Properties| Name | Description | |
|---|---|---|
 | AngularDamping |
Damping speeds for each of the 3 axes of the target's rotation
|
| Damping |
Damping speeds for each of the 3 axes of the offset from target
|
| EffectiveOffset | Get the target offset, with sanitization |
 | FollowTarget | Returns the owner vcam's Follow target. (Inherited from CinemachineComponentBase.) |
| IsValid | True if component is enabled and has a valid Follow target (Overrides CinemachineComponentBaseIsValid.) |
| LookAtTarget | Returns the owner vcam's LookAt target. (Inherited from CinemachineComponentBase.) |
| Stage | Get the Cinemachine Pipeline stage that this component implements.
Always returns the Body stage (Overrides CinemachineComponentBaseStage.) |
| VcamState | Returns the owner vcam's CameraState. (Inherited from CinemachineComponentBase.) |
| VirtualCamera | Get the associated CinemachineVirtualCameraBase (Inherited from CinemachineComponentBase.) |
Methods| Name | Description | |
|---|---|---|
| GeTargetCameraPosition | Internal API for the Inspector Editor, so it can draw a marker at the target |
| GetReferenceOrientation | Internal API for the Inspector Editor, so it can draw a marker at the target |
 | InitPrevFrameStateInfo | Initializes the state for previous frame if appropriate. |
| MutateCameraState | Positions the virtual camera according to the transposer rules. (Overrides CinemachineComponentBaseMutateCameraState(CameraState, Single).) |
| OnPositionDragged | API for the editor, to process a position drag from the user.
This implementation adds the delta to the follow offset. (Overrides CinemachineComponentBaseOnPositionDragged(Vector3).) |
| OnValidate | |
| TrackTarget | Positions the virtual camera according to the transposer rules. |
Fields| Name | Description | |
|---|---|---|
 | 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_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_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_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 |
See Also