docs.unity3d.com
    Show / Hide Table of Contents

    Class CinemachineCameraOffset

    An add-on module for Cinemachine Virtual Camera that adds a final offset to the camera

    Inheritance
    Object
    CinemachineExtension
    CinemachineCameraOffset
    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 CinemachineCameraOffset : CinemachineExtension

    Fields

    m_ApplyAfter

    When to apply the offset

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

    m_Offset

    Offset the camera's position by this much (camera space)

    Declaration
    public Vector3 m_Offset
    Field Value
    Type Description
    Vector3

    m_PreserveComposition

    If applying offset after aim, re-adjust the aim to preserve the screen position of the LookAt target as much as possible

    Declaration
    public bool m_PreserveComposition
    Field Value
    Type Description
    Boolean

    Methods

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

    Applies the specified offset to the camera state

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