CinemachineClearShot Methods

Cinemachine

CinemachineClearShot Methods

The CinemachineClearShot 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.
(Inherited from CinemachineVirtualCameraBase.)
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.
(Overrides CinemachineVirtualCameraBaseIsLiveChild(ICinemachineCamera).)
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
Base class implementation removes the virtual camera from the priority queue.
(Inherited from CinemachineVirtualCameraBase.)
Protected methodOnDisable
Base class implementation makes sure the priority queue remains up-to-date.
(Inherited from CinemachineVirtualCameraBase.)
Protected methodOnEnable
Makes sure the internal child cache is up to date
(Overrides CinemachineVirtualCameraBaseOnEnable.)
Public methodOnTransformChildrenChanged
Makes sure the internal child cache is up to date
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. This implementation resets the child randomization.
(Overrides CinemachineVirtualCameraBaseOnTransitionFromCamera(ICinemachineCamera).)
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.
(Inherited from CinemachineVirtualCameraBase.)
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. Make sure it is removed from all the children.
(Overrides CinemachineVirtualCameraBaseRemovePostPipelineStageHook(CinemachineVirtualCameraBaseOnPostPipelineStageDelegate).)
Public methodResetRandomization
If RandomizeChoice is enabled, call this to re-randomize the children next frame. This is useful if you want to freshen up the shot.
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 designated update time so the vcam can position itself and track its targets. This implementation updates all the children, chooses the best one, and implements any required blending.
(Overrides CinemachineVirtualCameraBaseUpdateCameraState(Vector3, Single).)
Top
See Also