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

Object

Object

Component

Behaviour

MonoBehaviour

CinemachineExtension

CinemachineRecomposer

Inherited Members

CinemachineExtension.Epsilon

CinemachineExtension.VirtualCamera

CinemachineExtension.Awake()

CinemachineExtension.OnEnable()

CinemachineExtension.OnDestroy()

CinemachineExtension.ConnectToVcam(Boolean)

CinemachineExtension.PrePipelineMutateCameraStateCallback(CinemachineVirtualCameraBase, CameraState, Single)

CinemachineExtension.InvokePostPipelineStageCallback(CinemachineVirtualCameraBase, CinemachineCore.Stage, CameraState, Single)

CinemachineExtension.PostPipelineStageCallback(CinemachineVirtualCameraBase, CinemachineCore.Stage, CameraState, Single)

CinemachineExtension.OnTargetObjectWarped(Transform, Vector3)

CinemachineExtension.ForceCameraPosition(Vector3, Quaternion)

CinemachineExtension.OnTransitionFromCamera(ICinemachineCamera, Vector3, Single)

CinemachineExtension.GetMaxDampTime()

CinemachineExtension.RequiresUserInput

CinemachineExtension.GetExtraState<T>(ICinemachineCamera)

CinemachineExtension.GetAllExtraStates<T>()

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(String, Single)

MonoBehaviour.InvokeRepeating(String, Single, Single)

MonoBehaviour.CancelInvoke(String)

MonoBehaviour.IsInvoking(String)

MonoBehaviour.StartCoroutine(String)

MonoBehaviour.StartCoroutine(String, Object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(String)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(Object)

MonoBehaviour.useGUILayout

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, Component)

Component.TryGetComponent<T>(T)

Component.GetComponent(String)

Component.GetComponentInChildren(Type, Boolean)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(Boolean)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, Boolean)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(Boolean)

Component.GetComponentsInChildren<T>(Boolean, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, Boolean)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(Boolean)

Component.GetComponentsInParent<T>(Boolean, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.CompareTag(String)

Component.SendMessageUpwards(String, Object, SendMessageOptions)

Component.SendMessageUpwards(String, Object)

Component.SendMessageUpwards(String)

Component.SendMessageUpwards(String, SendMessageOptions)

Component.SendMessage(String, Object)

Component.SendMessage(String)

Component.SendMessage(String, Object, SendMessageOptions)

Component.SendMessage(String, SendMessageOptions)

Component.BroadcastMessage(String, Object, SendMessageOptions)

Component.BroadcastMessage(String, Object)

Component.BroadcastMessage(String)

Component.BroadcastMessage(String, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Component.rigidbody

Component.rigidbody2D

Component.camera

Component.light

Component.animation

Component.constantForce

Component.renderer

Component.audio

Component.networkView

Component.collider

Component.collider2D

Component.hingeJoint

Component.particleSystem

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(Object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, Boolean)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, Boolean)

Object.Destroy(Object, Single)

Object.Destroy(Object)

Object.DestroyImmediate(Object, Boolean)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, Single)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectOfType<T>()

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.ToString()

Object.name

Object.hideFlags

Namespace: Global Namespace

Syntax

[AddComponentMenu("")]
[ExecuteAlways]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.cinemachine@2.8/manual/CinemachineRecomposer.html")]
public class CinemachineRecomposer : CinemachineExtension

Fields

m_ApplyAfter

When to apply the adjustment

Declaration

[Tooltip("When to apply the adjustment")]
public CinemachineCore.Stage m_ApplyAfter

Field Value

Type	Description
CinemachineCore.Stage

m_Dutch

Roll the camera by this much

Declaration

[Tooltip("Roll the camera by this much")]
public float m_Dutch

Field 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_FollowAttachment

Field 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_LookAtAttachment

Field Value

Type	Description
Single

m_Pan

Pan the camera by this much

Declaration

[Tooltip("Pan the camera by this much")]
public float m_Pan

Field Value

Type	Description
Single

m_Tilt

Tilt the camera by this much

Declaration

[Tooltip("Tilt the camera by this much")]
public float m_Tilt

Field 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_ZoomScale

Field 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

CinemachineExtension.PostPipelineStageCallback(CinemachineVirtualCameraBase, CinemachineCore.Stage, ref CameraState, Single)

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

Overrides

CinemachineExtension.PrePipelineMutateCameraStateCallback(CinemachineVirtualCameraBase, ref CameraState, Single)