CinemachineVirtualCameraBase Methods

Cinemachine

CinemachineVirtualCameraBase Methods

The CinemachineVirtualCameraBase type exposes the following members.

Methods
  NameDescription
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.
Protected methodInvokePostPipelineStageCallback
Invokes the PostPipelineStageDelegate for this camera, and up the hierarchy for all parent cameras (if any).
Public methodIsLiveChild
Check whether the vcam a live child of this camera. This base class implementation always returns false.
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.
Protected methodOnDestroy
Base class implementation removes the virtual camera from the priority queue.
Protected methodOnDisable
Base class implementation makes sure the priority queue remains up-to-date.
Protected methodOnEnable
Base class implementation adds the virtual camera from the priority queue.
Protected methodOnTransformParentChanged
Base class implementation makes sure the priority queue remains up-to-date.
Public methodOnTransitionFromCamera
Notification that this virtual camera is going live. Base class implementationmust be called by any overridden method.
Protected methodOnValidate
Enforce bounds for fields, when changed in inspector. Call base class implementation at the beginning of overridden method. After base method is called, ValidatingStreamVersion will be valid.
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.
Public methodRemovePostPipelineStageHook
Remove a Pipeline stage hook callback.
Protected methodResolveFollow
Returns this vcam's Follow target, or if that is null, will retrun the parent vcam's Follow target.
Protected methodResolveLookAt
Returns this vcam's LookAt target, or if that is null, will retrun the parent vcam's LookAt target.
Protected methodStart
Base class implementation does nothing.
Protected methodUpdate
Base class implementation makes sure the priority queue remains up-to-date.
Public methodUpdateCameraState
Called by CinemachineCore at designated update time so the vcam can position itself and track its targets. Do not call this method. Let the framework do it at the appropriate time
Top
See Also