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

object

Object

Component

Behaviour

MonoBehaviour

CinemachineVirtualCameraBase

CinemachineExternalCamera

Implements

ICinemachineCamera

Inherited Members

CinemachineVirtualCameraBase.Priority

CinemachineVirtualCameraBase.OutputChannel

CinemachineVirtualCameraBase.IsDprecated

CinemachineVirtualCameraBase.FollowTargetAttachment

CinemachineVirtualCameraBase.LookAtTargetAttachment

CinemachineVirtualCameraBase.StandbyUpdate

CinemachineVirtualCameraBase.PerformLegacyUpgrade(int)

CinemachineVirtualCameraBase.GetMaxDampTime()

CinemachineVirtualCameraBase.DetachedFollowTargetDamp(float, float, float)

CinemachineVirtualCameraBase.DetachedFollowTargetDamp(Vector3, Vector3, float)

CinemachineVirtualCameraBase.DetachedFollowTargetDamp(Vector3, float, float)

CinemachineVirtualCameraBase.DetachedLookAtTargetDamp(float, float, float)

CinemachineVirtualCameraBase.DetachedLookAtTargetDamp(Vector3, Vector3, float)

CinemachineVirtualCameraBase.DetachedLookAtTargetDamp(Vector3, float, float)

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

CinemachineVirtualCameraBase.InvokePrePipelineMutateCameraStateCallback(CinemachineVirtualCameraBase, ref CameraState, float)

CinemachineVirtualCameraBase.InvokeOnTransitionInExtensions(ICinemachineCamera, Vector3, float)

CinemachineVirtualCameraBase.Name

CinemachineVirtualCameraBase.Description

CinemachineVirtualCameraBase.IsValid

CinemachineVirtualCameraBase.ParentCamera

CinemachineVirtualCameraBase.PreviousStateIsValid

CinemachineVirtualCameraBase.UpdateCameraState(Vector3, float)

CinemachineVirtualCameraBase.OnCameraActivated(ICinemachineCamera.ActivationEventParams)

CinemachineVirtualCameraBase.OnTransitionFromCamera(ICinemachineCamera, Vector3, float)

CinemachineVirtualCameraBase.OnTransformParentChanged()

CinemachineVirtualCameraBase.OnDestroy()

CinemachineVirtualCameraBase.Start()

CinemachineVirtualCameraBase.OnEnable()

CinemachineVirtualCameraBase.OnDisable()

CinemachineVirtualCameraBase.Update()

CinemachineVirtualCameraBase.ResolveLookAt(Transform)

CinemachineVirtualCameraBase.ResolveFollow(Transform)

CinemachineVirtualCameraBase.MoveToTopOfPrioritySubqueue()

CinemachineVirtualCameraBase.Prioritize()

CinemachineVirtualCameraBase.OnTargetObjectWarped(Transform, Vector3)

CinemachineVirtualCameraBase.ForceCameraPosition(Vector3, Quaternion)

CinemachineVirtualCameraBase.PullStateFromVirtualCamera(Vector3, ref LensSettings)

CinemachineVirtualCameraBase.FollowTargetChanged

CinemachineVirtualCameraBase.LookAtTargetChanged

CinemachineVirtualCameraBase.UpdateTargetCache()

CinemachineVirtualCameraBase.FollowTargetAsGroup

CinemachineVirtualCameraBase.FollowTargetAsVcam

CinemachineVirtualCameraBase.LookAtTargetAsGroup

CinemachineVirtualCameraBase.LookAtTargetAsVcam

CinemachineVirtualCameraBase.GetCinemachineComponent(CinemachineCore.Stage)

CinemachineVirtualCameraBase.IsLive

CinemachineVirtualCameraBase.IsParticipatingInBlend()

CinemachineVirtualCameraBase.CancelDamping(bool)

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.InstantiateAsync<T>(T, InstantiateParameters)

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

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

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

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

Object.Instantiate(Object, Vector3, Quaternion)

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

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

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

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

[RequireComponent(typeof(Camera))]
[DisallowMultipleComponent]
[AddComponentMenu("Cinemachine/Cinemachine External Camera")]
[ExecuteAlways]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.cinemachine@3.1/manual/CinemachineExternalCamera.html")]
public class CinemachineExternalCamera : CinemachineVirtualCameraBase, ICinemachineCamera

Fields

BlendHint

Hint for transitioning to and from this virtual camera

Declaration

[Tooltip("Hint for transitioning to and from this virtual camera")]
[FormerlySerializedAs("m_PositionBlending")]
[FormerlySerializedAs("m_BlendHint")]
public CinemachineCore.BlendHints BlendHint

Field Value

Type	Description
CinemachineCore.BlendHints

LookAtTarget

The object that the camera is looking at. Setting this may improve the quality of the blends to and from this camera

Declaration

[Tooltip("The object that the camera is looking at.  Setting this may improve the quality of the blends to and from this camera")]
[FormerlySerializedAs("m_LookAt")]
public Transform LookAtTarget

Field Value

Type	Description
Transform

Properties

Follow

This vcam defines no targets

Declaration

[HideInInspector]
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, float)

Internal use only. Do not call this method

Declaration

public override void InternalUpdateCameraState(Vector3 worldUp, float deltaTime)

Parameters

Type	Name	Description
Vector3	worldUp	Effective world up
float	deltaTime	Effective deltaTime

Overrides

CinemachineVirtualCameraBase.InternalUpdateCameraState(Vector3, float)

Implements

ICinemachineCamera

Extension Methods

CinemachineInputProviderExtensions.GetInputAxisProvider(CinemachineVirtualCameraBase)