Class CinemachineRecomposer

An add-on module for Cm Camera that adds a final tweak to the camera composition. 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.ComponentOwner

CinemachineExtension.Awake()

CinemachineExtension.OnDestroy()

CinemachineExtension.OnEnable()

CinemachineExtension.ConnectToVcam(bool)

CinemachineExtension.InvokePostPipelineStageCallback(CinemachineVirtualCameraBase, CinemachineCore.Stage, ref CameraState, float)

CinemachineExtension.OnTargetObjectWarped(CinemachineVirtualCameraBase, Transform, Vector3)

CinemachineExtension.ForceCameraPosition(Vector3, Quaternion)

CinemachineExtension.OnTransitionFromCamera(ICinemachineCamera, Vector3, float)

CinemachineExtension.GetMaxDampTime()

CinemachineExtension.GetExtraState<T>(CinemachineVirtualCameraBase)

CinemachineExtension.GetAllExtraStates<T>(List<T>)

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

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.destroyCancellationToken

MonoBehaviour.useGUILayout

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

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

Component.GetComponentsInChildren<T>()

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

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

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

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

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

Component.GetComponents<T>()

Component.GetComponentIndex()

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

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

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

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

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.Instantiate(Object, Vector3, Quaternion)

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

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

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, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Unity.Cinemachine

Assembly: Unity.Cinemachine.dll

Syntax

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

Fields

ApplyAfter

When to apply the adjustment

Declaration

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

Field Value

Type	Description
CinemachineCore.Stage

Dutch

Roll the camera by this much

Declaration

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

Field Value

Type	Description
float

FollowAttachment

Lowering this value relaxes the camera's attention to the Follow target (normal = 1)

Declaration

[Range(0, 1)]
[Tooltip("Lowering this value relaxes the camera's attention to the Follow target (normal = 1)")]
[FormerlySerializedAs("m_FollowAttachment")]
public float FollowAttachment

Field Value

Type	Description
float

LookAtAttachment

Lowering this value relaxes the camera's attention to the LookAt target (normal = 1)

Declaration

[Range(0, 1)]
[Tooltip("Lowering this value relaxes the camera's attention to the LookAt target (normal = 1)")]
[FormerlySerializedAs("m_LookAtAttachment")]
public float LookAtAttachment

Field Value

Type	Description
float

Pan

Pan the camera by this much

Declaration

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

Field Value

Type	Description
float

Tilt

Tilt the camera by this much

Declaration

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

Field Value

Type	Description
float

ZoomScale

Scale the zoom by this amount (normal = 1)

Declaration

[Tooltip("Scale the zoom by this amount (normal = 1)")]
[FormerlySerializedAs("m_ZoomScale")]
public float ZoomScale

Field Value

Type	Description
float

Methods

PostPipelineStageCallback(CinemachineVirtualCameraBase, Stage, ref CameraState, float)

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
float	deltaTime	The current applicable deltaTime

Overrides

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

PrePipelineMutateCameraStateCallback(CinemachineVirtualCameraBase, ref CameraState, float)

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
float	deltaTime	The current applicable deltaTime

Overrides

CinemachineExtension.PrePipelineMutateCameraStateCallback(CinemachineVirtualCameraBase, ref CameraState, float)