Cinemachine
CinemachineVirtualCameraBase Methods |
The CinemachineVirtualCameraBase type exposes the following members.
Methods
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.
| |
InvokePostPipelineStageCallback |
Invokes the PostPipelineStageDelegate for this camera, and up the hierarchy for all
parent cameras (if any).
| |
IsLiveChild | Check whether the vcam a live child of this camera.
This base class implementation always returns false. | |
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. | |
OnDestroy | Base class implementation removes the virtual camera from the priority queue. | |
OnDisable | Base class implementation makes sure the priority queue remains up-to-date. | |
OnEnable | Base class implementation adds the virtual camera from the priority queue. | |
OnTransformParentChanged | Base class implementation makes sure the priority queue remains up-to-date. | |
OnTransitionFromCamera | Notification that this virtual camera is going live.
Base class implementationmust be called by any overridden method. | |
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. | |
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.
| |
RemovePostPipelineStageHook | Remove a Pipeline stage hook callback. | |
ResolveFollow | Returns this vcam's Follow target, or if that is null, will retrun
the parent vcam's Follow target. | |
ResolveLookAt | Returns this vcam's LookAt target, or if that is null, will retrun
the parent vcam's LookAt target. | |
Start | Base class implementation does nothing. | |
Update | Base class implementation makes sure the priority queue remains up-to-date. | |
UpdateCameraState | 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 |
See Also