Cinemachine
![]() | CinemachineStateDrivenCamera Methods |
The CinemachineStateDrivenCamera type exposes the following members.

Name | Description | |
---|---|---|
![]() | AddPostPipelineStageHook |
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.) |
![]() ![]() | CreateFakeHashName | API for the inspector editor. Animation module does not have hashes
for state parents, so we have to invent them in order to implement nested state
handling |
![]() | InvokePostPipelineStageCallback |
Invokes the PostPipelineStageDelegate for this camera, and up the hierarchy for all
parent cameras (if any).
(Inherited from CinemachineVirtualCameraBase.) |
![]() | IsLiveChild | Check whether the vcam a live child of this camera. (Overrides CinemachineVirtualCameraBaseIsLiveChild(ICinemachineCamera).) |
![]() | MoveToTopOfPrioritySubqueue | 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.) |
![]() | OnDestroy | Base class implementation removes the virtual camera from the priority queue. (Inherited from CinemachineVirtualCameraBase.) |
![]() | OnDisable | Base class implementation makes sure the priority queue remains up-to-date. (Inherited from CinemachineVirtualCameraBase.) |
![]() | OnEnable | Makes sure the internal child cache is up to date (Overrides CinemachineVirtualCameraBaseOnEnable.) |
![]() | OnTransformChildrenChanged | Makes sure the internal child cache is up to date |
![]() | OnTransformParentChanged | Base class implementation makes sure the priority queue remains up-to-date. (Inherited from CinemachineVirtualCameraBase.) |
![]() | OnTransitionFromCamera | Notification that this virtual camera is going live.
Base class implementationmust be called by any overridden method. (Inherited from CinemachineVirtualCameraBase.) |
![]() | OnValidate | 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.) |
![]() | PreUpdateChildCameras |
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.) |
![]() | RemovePostPipelineStageHook | Remove a Pipeline stage hook callback.
Make sure it is removed from all the children. (Overrides CinemachineVirtualCameraBaseRemovePostPipelineStageHook(CinemachineVirtualCameraBaseOnPostPipelineStageDelegate).) |
![]() | ResolveFollow | Returns this vcam's Follow target, or if that is null, will retrun
the parent vcam's Follow target. (Inherited from CinemachineVirtualCameraBase.) |
![]() | ResolveLookAt | Returns this vcam's LookAt target, or if that is null, will retrun
the parent vcam's LookAt target. (Inherited from CinemachineVirtualCameraBase.) |
![]() | Start | Base class implementation does nothing. (Inherited from CinemachineVirtualCameraBase.) |
![]() | Update | Base class implementation makes sure the priority queue remains up-to-date. (Inherited from CinemachineVirtualCameraBase.) |
![]() | UpdateCameraState | 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).) |
![]() | ValidateInstructions | Internal API for the inspector editor. |
