Class CinemachineExternalCamera | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class CinemachineExternalCamera

    This component will expose a non-cinemachine camera to the cinemachine system, allowing it to participate in blends. Just add it as a component alongside an existing Unity Camera component.

    Inheritance
    MonoBehaviour
    CinemachineVirtualCameraBase
    CinemachineExternalCamera
    Inherited Members
    CinemachineVirtualCameraBase.CinemachineGUIDebuggerCallback
    CinemachineVirtualCameraBase.m_ExcludedPropertiesInInspector
    CinemachineVirtualCameraBase.m_LockStageInInspector
    CinemachineVirtualCameraBase.ValidatingStreamVersion
    CinemachineVirtualCameraBase.m_Priority
    CinemachineVirtualCameraBase.AddExtension(CinemachineExtension)
    CinemachineVirtualCameraBase.RemoveExtension(CinemachineExtension)
    CinemachineVirtualCameraBase.InvokePostPipelineStageCallback(CinemachineVirtualCameraBase, CinemachineCore.Stage, CameraState, Single)
    CinemachineVirtualCameraBase.Name
    CinemachineVirtualCameraBase.Description
    CinemachineVirtualCameraBase.Priority
    CinemachineVirtualCameraBase.SetPositionBlendMethod(CameraState, CinemachineVirtualCameraBase.PositionBlendMethod)
    CinemachineVirtualCameraBase.VirtualCameraGameObject
    CinemachineVirtualCameraBase.LiveChildOrSelf
    CinemachineVirtualCameraBase.ParentCamera
    CinemachineVirtualCameraBase.IsLiveChild(ICinemachineCamera)
    CinemachineVirtualCameraBase.PreviousStateIsValid
    CinemachineVirtualCameraBase.UpdateCameraState(Vector3, Single)
    CinemachineVirtualCameraBase.OnTransitionFromCamera(ICinemachineCamera, Vector3, Single)
    CinemachineVirtualCameraBase.Start()
    CinemachineVirtualCameraBase.OnDestroy()
    CinemachineVirtualCameraBase.OnValidate()
    CinemachineVirtualCameraBase.OnEnable()
    CinemachineVirtualCameraBase.OnDisable()
    CinemachineVirtualCameraBase.Update()
    CinemachineVirtualCameraBase.OnTransformParentChanged()
    CinemachineVirtualCameraBase.ResolveLookAt(Transform)
    CinemachineVirtualCameraBase.ResolveFollow(Transform)
    CinemachineVirtualCameraBase.MoveToTopOfPrioritySubqueue()
    CinemachineVirtualCameraBase.OnTargetObjectWarped(Transform, Vector3)
    Namespace: Cinemachine
    Syntax
    [DocumentationSorting(DocumentationSortingAttribute.Level.UserRef)]
    public class CinemachineExternalCamera : CinemachineVirtualCameraBase, ICinemachineCamera

    Fields

    m_LookAt

    The object that the camera is looking at.

    Declaration
    public Transform m_LookAt
    Field Value
    Type Description
    Transform

    m_PositionBlending

    Hint for blending positions to and from this virtual camera

    Declaration
    public CinemachineVirtualCameraBase.PositionBlendMethod m_PositionBlending
    Field Value
    Type Description
    CinemachineVirtualCameraBase.PositionBlendMethod

    Properties

    Follow

    This vcam defines no targets

    Declaration
    public override Transform Follow { get; set; }
    Property Value
    Type Description
    Transform
    Overrides
    CinemachineVirtualCameraBase.Follow

    LookAt

    The object that the camera is looking at

    Declaration
    public override Transform LookAt { get; set; }
    Property Value
    Type Description
    Transform
    Overrides
    CinemachineVirtualCameraBase.LookAt

    State

    Get the CameraState, as we are able to construct one from the Unity Camera

    Declaration
    public override CameraState State { get; }
    Property Value
    Type Description
    CameraState
    Overrides
    CinemachineVirtualCameraBase.State

    Methods

    InternalUpdateCameraState(Vector3, Single)

    Internal use only. Do not call this method

    Declaration
    public override void InternalUpdateCameraState(Vector3 worldUp, float deltaTime)
    Parameters
    Type Name Description
    Vector3 worldUp
    System.Single deltaTime
    Overrides
    CinemachineVirtualCameraBase.InternalUpdateCameraState(Vector3, 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