Class CinemachinePositionComposer

This is a Cinemachine Component in the Body section of the component pipeline. Its job is to position the camera in a fixed screen-space relationship to the camera's Tracking target object, with offsets and damping.

The camera will be first moved along the camera Z axis until the target is at the desired distance from the camera's X-Y plane. The camera will then be moved in its XY plane until the target is at the desired point on the camera's screen.

The Position Composer will only change the camera's position in space. It will not re-orient or otherwise aim the camera.

For this component to work properly, the camera's tracking target must not be null. The tracking target will define what the camera is looking at.

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
CinemachineComponentBase
CinemachinePositionComposer
Implements
Inherited Members
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: solution.dll
Syntax
[AddComponentMenu("Cinemachine/Procedural/Position Control/Cinemachine Position Composer")]
[DisallowMultipleComponent]
[CameraPipeline(CinemachineCore.Stage.Body)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.cinemachine@3.0/manual/CinemachinePositionComposer.html")]
public class CinemachinePositionComposer : CinemachineComponentBase, CinemachineFreeLookModifier.IModifiablePositionDamping, CinemachineFreeLookModifier.IModifiableDistance, CinemachineFreeLookModifier.IModifiableComposition

Fields

Name Description
CameraDistance

The distance along the camera axis that will be maintained from the target
CenterOnActivate

Force target to center of screen when this camera activates.
If false, will clamp target to the edges of the dead zone
Composition

Settings for screen-space composition
Damping

How aggressively the camera tries to follow the target in screen space. Small numbers are more responsive, rapidly orienting the camera to keep the target in the dead zone. Larger numbers give a more heavy slowly responding camera. Using different vertical and horizontal settings can yield a wide range of camera behaviors.
DeadZoneDepth

The camera will not move along its z-axis if the target is within this distance of the specified camera distance
Lookahead

This setting will instruct the composer to adjust its target offset based on the motion of the target. The composer will look at a point where it estimates the target will be a little into the future.
TargetOffset

Offset from the target object (in target-local co-ordinates). The camera will attempt to frame the point which is the target's position plus this offset. Use it to correct for cases when the target's origin is not the point of interest for the camera.

Properties

Name Description
BodyAppliesAfterAim

FramingTransposer algorithm takes camera orientation as input, so even though it is a Body component, it must apply after Aim
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

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.
OnTransitionFromCamera(ICinemachineCamera, Vector3, float)

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