CinemachineVirtualCamera Methods

Cinemachine

CinemachineVirtualCamera Methods

The CinemachineVirtualCamera type exposes the following members.

Methods
  NameDescription
Public methodAddCinemachineComponentT
Add a component to the cinemachine pipeline.
Public methodAddPostPipelineStageHook
A delegate to hook into the state calculation pipeline. This will be called after each pipeline stage, to allow others to hook into the pipeline. See CinemachineCore.Stage.
(Inherited from CinemachineVirtualCameraBase.)
Public methodDestroyCinemachineComponentT
Remove a component from the cinemachine pipeline.
Public methodGetCinemachineComponent(CinemachineCoreStage)
Get the component set for a specific stage.
Public methodGetCinemachineComponentT
Get an existing component of a specific type from the cinemachine pipeline.
Public methodGetComponentOwner
Get the hidden CinemachinePipeline child object.
Public methodGetComponentPipeline
Get the component pipeline owned by the hidden child pipline container. For most purposes, it is preferable to use the GetCinemachineComponent method.
Public methodInvalidateComponentPipeline
Editor API: Call this when changing the pipeline from the editor. Will force a rebuild of the pipeline cache.
Protected methodInvokePostPipelineStageCallback
Invokes the PostPipelineStageDelegate for this camera, and up the hierarchy for all parent cameras (if any).
(Inherited from CinemachineVirtualCameraBase.)
Public methodIsLiveChild
Check whether the vcam a live child of this camera. This base class implementation always returns false.
(Inherited from CinemachineVirtualCameraBase.)
Public methodMoveToTopOfPrioritySubqueue
When multiple virtual cameras have the highest priority, there is sometimes the need to push one to the top, making it the current Live camera if it shares the highest priority in the queue with its peers. This happens automatically when a new vcam is enabled: the most recent one goes to the top of the priority subqueue. Use this method to push a vcam to the top of its priority peers. If it and its peers share the highest priority, then this vcam will become Live.
(Inherited from CinemachineVirtualCameraBase.)
Protected methodOnDestroy
Calls the DestroyPipelineDelegate for destroying the hidden child object, to support undo.
(Overrides CinemachineVirtualCameraBaseOnDestroy.)
Protected methodOnDisable
Base class implementation makes sure the priority queue remains up-to-date.
(Inherited from CinemachineVirtualCameraBase.)
Protected methodOnEnable
Make sure that the pipeline cache is up-to-date.
(Overrides CinemachineVirtualCameraBaseOnEnable.)
Public methodOnPositionDragged
API for the editor, to process a position drag from the user.
Protected methodOnTransformParentChanged
Base class implementation makes sure the priority queue remains up-to-date.
(Inherited from CinemachineVirtualCameraBase.)
Public methodOnTransitionFromCamera
Notification that this virtual camera is going live. Base class implementationmust be called by any overridden method.
(Inherited from CinemachineVirtualCameraBase.)
Protected methodOnValidate
Enforce bounds for fields, when changed in inspector.
(Overrides CinemachineVirtualCameraBaseOnValidate.)
Public methodPreUpdateChildCameras
This is called prior to the updating of the vcam's child cameras, in order to allow the parent to prepare its children. If the children are updating on FixedUpdate, then this will not necessarily be called prior to every FixedUpdate, but it might be called on LateUpdate instead. Base class implementation does nothing.
(Inherited from CinemachineVirtualCameraBase.)
Public methodRemovePostPipelineStageHook
Remove a Pipeline stage hook callback.
(Inherited from CinemachineVirtualCameraBase.)
Protected methodResolveFollow
Returns this vcam's Follow target, or if that is null, will retrun the parent vcam's Follow target.
(Inherited from CinemachineVirtualCameraBase.)
Protected methodResolveLookAt
Returns this vcam's LookAt target, or if that is null, will retrun the parent vcam's LookAt target.
(Inherited from CinemachineVirtualCameraBase.)
Protected methodStart
Base class implementation does nothing.
(Inherited from CinemachineVirtualCameraBase.)
Protected methodUpdate
Base class implementation makes sure the priority queue remains up-to-date.
(Inherited from CinemachineVirtualCameraBase.)
Public methodUpdateCameraState
Called by CinemachineCore at LateUpdate time so the vcam can position itself and track its targets. This class will invoke its pipeline and generate a CameraState for this frame.
(Overrides CinemachineVirtualCameraBaseUpdateCameraState(Vector3, Single).)
Top
See Also