docs.unity3d.com
    Show / Hide Table of Contents

    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
    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.GetExtraState<T>(ICinemachineCamera)
    CinemachineExtension.GetAllExtraStates<T>()
    Namespace: Global Namespace
    Syntax
    public class CinemachineRecomposer : CinemachineExtension

    Fields

    m_ApplyAfter

    When to apply the adjustment

    Declaration
    public CinemachineCore.Stage m_ApplyAfter
    Field Value
    Type Description
    CinemachineCore.Stage

    m_Dutch

    Roll the camera by this much

    Declaration
    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
    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
    public float m_LookAtAttachment
    Field Value
    Type Description
    Single

    m_Pan

    Pan the camera by this much

    Declaration
    public float m_Pan
    Field Value
    Type Description
    Single

    m_Tilt

    Tilt the camera by this much

    Declaration
    public float m_Tilt
    Field Value
    Type Description
    Single

    m_ZoomScale

    Scale the zoom by this amount (normal = 1)

    Declaration
    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)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023