Class CinemachineExtension

Base class for a Cinemachine Virtual Camera extension module. Hooks into the Cinemachine Pipeline.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

CinemachineExtension

Cinemachine3rdPersonAim

CinemachineCollider

CinemachineConfiner

CinemachineFollowZoom

CinemachineImpulseListener

CinemachineStoryboard

CinemachinePostProcessing

CinemachineCameraOffset

CinemachineRecomposer

Inherited Members

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

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.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.Instantiate(Object, Vector3, Quaternion)

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

Object.Instantiate(Object)

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.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectOfType<T>()

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

object.MemberwiseClone()

Namespace: Cinemachine

Assembly: solution.dll

Syntax

[DocumentationSorting(DocumentationSortingAttribute.Level.API)]
public abstract class CinemachineExtension : MonoBehaviour

Fields

Name	Description
Epsilon	Useful constant for very small floats

Properties

Name	Description
VirtualCamera	Get the associated CinemachineVirtualCameraBase

Methods

Name	Description
Awake()	Connect to virtual camera pipeline. Override implementations must call this base implementation
ConnectToVcam(bool)	Connect to virtual camera. Implementation must be safe to be called redundantly. Override implementations must call this base implementation
ForceCameraPosition(Vector3, Quaternion)	Force the virtual camera to assume a given position and orientation
GetAllExtraStates<T>()	Ineffeicient method to get all extra state infor for all vcams. Intended for Editor use only, not runtime!
GetExtraState<T>(ICinemachineCamera)	Because extensions can be placed on manager cams and will in that case be called for all the vcam children, vcam-specific state information should be stored here. Just define a class to hold your state info and use it exclusively when calling this.
GetMaxDampTime()	Report maximum damping time needed for this extension. Only used in editor for timeline scrubbing.
InvokePostPipelineStageCallback(CinemachineVirtualCameraBase, Stage, ref CameraState, float)	Legacy support. This is only here to avoid changing the API to make PostPipelineStageCallback() public
OnDestroy()	Disconnect from virtual camera pipeline. Override implementations must call this base implementation
OnEnable()	Does nothing. For the little checkbox in the inspector.
OnTargetObjectWarped(Transform, Vector3)	This is called to notify the extension that a target got warped, so that the extension can update its internal state to make the camera also warp seamlessy. Base class implementation does nothing.
OnTransitionFromCamera(ICinemachineCamera, Vector3, float)	Notification that this virtual camera is going live. Base class implementation must be called by any overridden method.
PostPipelineStageCallback(CinemachineVirtualCameraBase, Stage, ref CameraState, float)	This callback will be called after the virtual camera has implemented each stage in the pipeline. This method may modify the referenced state. If deltaTime less than 0, reset all state info and perform no damping.
PrePipelineMutateCameraStateCallback(CinemachineVirtualCameraBase, ref CameraState, float)	Override this to do such things as offset the RefereceLookAt. Base class implementation does nothing.