CinemachineOrbitalTransposer Class

Cinemachine

CinemachineOrbitalTransposer Class

This is a CinemachineComponent in the the Body section of the component pipeline. Its job is to position the camera in a variable relationship to a the vcam's Follow target object, with offsets and damping. This component is typically used to implement a camera that follows its target. It can accept player input from an input device, which allows the player to dynamically control the relationship between the camera and the target, for example with a joystick. The OrbitalTransposer introduces the concept of __Heading__, which is the direction in which the target is moving, and the OrbitalTransposer will attempt to position the camera in relationship to the heading, which is by default directly behind the target. You can control the default relationship by adjusting the Heading Bias setting. If you attach an input controller to the OrbitalTransposer, then the player can also control the way the camera positions itself in relation to the target heading. This allows the camera to move to any spot on an orbit around the target.
Inheritance Hierarchy
SystemObject  Object
    Component
      Behaviour
        MonoBehaviour
          CinemachineCinemachineComponentBase
            CinemachineCinemachineTransposer
              CinemachineCinemachineOrbitalTransposer

Namespace:  Cinemachine
Assembly:  Cinemachine (in Cinemachine.dll) Version: 2.0.0.0 (2.0.0.0)
Syntax
[DocumentationSortingAttribute(6f, DocumentationSortingAttributeLevel.UserRef)]
[AddComponentMenu("")]
[RequireComponent(typeof(CinemachinePipeline))]
[SaveDuringPlayAttribute]
public class CinemachineOrbitalTransposer : CinemachineTransposer
Cinemachine.CinemachineOrbitalTransposer = function();

Type.createClass(
	'Cinemachine.CinemachineOrbitalTransposer',
	Cinemachine.CinemachineTransposer);

The CinemachineOrbitalTransposer type exposes the following members.

Properties
  NameDescription
Protected propertyAngularDamping
Damping speeds for each of the 3 axes of the target's rotation
(Inherited from CinemachineTransposer.)
Protected propertyDamping
Damping speeds for each of the 3 axes of the offset from target
(Inherited from CinemachineTransposer.)
Protected propertyEffectiveOffset
Get the target offset, with sanitization
(Inherited from CinemachineTransposer.)
Public propertyFollowTarget
Returns the owner vcam's Follow target.
(Inherited from CinemachineComponentBase.)
Public propertyIsValid
True if component is enabled and has a valid Follow target
(Inherited from CinemachineTransposer.)
Public propertyLookAtTarget
Returns the owner vcam's LookAt target.
(Inherited from CinemachineComponentBase.)
Public propertyStage
Get the Cinemachine Pipeline stage that this component implements. Always returns the Body stage
(Inherited from CinemachineTransposer.)
Public propertyVcamState
Returns the owner vcam's CameraState.
(Inherited from CinemachineComponentBase.)
Public propertyVirtualCamera
Get the associated CinemachineVirtualCameraBase
(Inherited from CinemachineComponentBase.)
Top
Methods
  NameDescription
Public methodGeTargetCameraPosition
Internal API for the Inspector Editor, so it can draw a marker at the target
(Inherited from CinemachineTransposer.)
Public methodGetReferenceOrientation
Internal API for the Inspector Editor, so it can draw a marker at the target
(Inherited from CinemachineTransposer.)
Protected methodInitPrevFrameStateInfo
Initializes the state for previous frame if appropriate.
(Inherited from CinemachineTransposer.)
Public methodMutateCameraState
Positions the virtual camera according to the transposer rules.
(Overrides CinemachineTransposerMutateCameraState(CameraState, Single).)
Public methodOnPositionDragged
API for the editor, to process a position drag from the user. This implementation adds the delta to the follow offset, after zeroing out local x.
(Overrides CinemachineTransposerOnPositionDragged(Vector3).)
Protected methodOnValidate (Overrides CinemachineTransposerOnValidate.)
Protected methodTrackTarget
Positions the virtual camera according to the transposer rules.
(Inherited from CinemachineTransposer.)
Public methodUpdateHeading
When in slave mode, this should be called once and only once every hrame to update the heading. When not in slave mode, this is called automatically.
Top
Fields
  NameDescription
Public fieldm_BindingMode
The coordinate space to use when interpreting the offset from the target
(Inherited from CinemachineTransposer.)
Public fieldm_FollowOffset
The distance which the transposer will attempt to maintain from the transposer subject
(Inherited from CinemachineTransposer.)
Public fieldm_Heading
The definition of Forward. Camera will follow behind.
Public fieldm_HeadingIsSlave
Drive the x-axis setting programmatically. Automatic heading updating will be disabled.
Public fieldm_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.
(Inherited from CinemachineTransposer.)
Public fieldm_RecenterToTargetHeading
Parameters that control Automating Heading Recentering
Public fieldm_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.
(Inherited from CinemachineTransposer.)
Public fieldm_XAxis
Axis representing the current heading. Value is in degrees and represents a rotation about the up vector
Public fieldm_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
(Inherited from CinemachineTransposer.)
Public fieldm_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.
(Inherited from CinemachineTransposer.)
Public fieldm_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
(Inherited from CinemachineTransposer.)
Public fieldm_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
(Inherited from CinemachineTransposer.)
Top
See Also