Class CinemachineRecomposer
An add-on module for Cinemachine Virtual Camera that adds a final tweak to the camera comnposition. It is intended for use in a Timeline context, where you want to hand-adjust the output of procedural or recorded camera aiming.
Inheritance
Inherited Members
Namespace: Global Namespace
Syntax
[AddComponentMenu("")]
[ExecuteAlways]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.cinemachine@2.6/manual/CinemachineRecomposer.html")]
public class CinemachineRecomposer : CinemachineExtensionFields
m_ApplyAfter
When to apply the adjustment
Declaration
[Tooltip("When to apply the adjustment")]
public CinemachineCore.Stage m_ApplyAfterField Value
| Type | Description |
|---|---|
| CinemachineCore.Stage |
m_Dutch
Roll the camera by this much
Declaration
[Tooltip("Roll the camera by this much")]
public float m_DutchField Value
| Type | Description |
|---|---|
| Single |
m_FollowAttachment
Lowering this value relaxes the camera's attention to the Follow target (normal = 1)
Declaration
[Range(0F, 1F)]
[Tooltip("Lowering this value relaxes the camera's attention to the Follow target (normal = 1)")]
public float m_FollowAttachmentField Value
| Type | Description |
|---|---|
| Single |
m_LookAtAttachment
Lowering this value relaxes the camera's attention to the LookAt target (normal = 1)
Declaration
[Range(0F, 1F)]
[Tooltip("Lowering this value relaxes the camera's attention to the LookAt target (normal = 1)")]
public float m_LookAtAttachmentField Value
| Type | Description |
|---|---|
| Single |
m_Pan
Pan the camera by this much
Declaration
[Tooltip("Pan the camera by this much")]
public float m_PanField Value
| Type | Description |
|---|---|
| Single |
m_Tilt
Tilt the camera by this much
Declaration
[Tooltip("Tilt the camera by this much")]
public float m_TiltField Value
| Type | Description |
|---|---|
| Single |
m_ZoomScale
Scale the zoom by this amount (normal = 1)
Declaration
[Tooltip("Scale the zoom by this amount (normal = 1)")]
public float m_ZoomScaleField Value
| Type | Description |
|---|---|
| Single |
Methods
PostPipelineStageCallback(CinemachineVirtualCameraBase, CinemachineCore.Stage, ref CameraState, Single)
Callback to tweak the settings
Declaration
protected override void PostPipelineStageCallback(CinemachineVirtualCameraBase vcam, CinemachineCore.Stage stage, ref CameraState state, float deltaTime)Parameters
| Type | Name | Description |
|---|---|---|
| CinemachineVirtualCameraBase | vcam | The virtual camera being processed |
| CinemachineCore.Stage | stage | The current pipeline stage |
| CameraState | state | The current virtual camera state |
| Single | deltaTime | The current applicable deltaTime |
Overrides
PrePipelineMutateCameraStateCallback(CinemachineVirtualCameraBase, ref CameraState, Single)
Callback to set the target attachment
Declaration
public override void PrePipelineMutateCameraStateCallback(CinemachineVirtualCameraBase vcam, ref CameraState curState, float deltaTime)Parameters
| Type | Name | Description |
|---|---|---|
| CinemachineVirtualCameraBase | vcam | The virtual camera being processed |
| CameraState | curState | Input state that must be mutated |
| Single | deltaTime | The current applicable deltaTime |