Cinemachine
CinemachineFreeLook Methods |
The CinemachineFreeLook 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.
(Inherited from CinemachineVirtualCameraBase.) | |
GetLocalPositionForCameraFromInput |
Returns the local position of the camera along the spline used to connect the
three camera rigs. Does not take into account the current heading of the
camera (or its target)
| |
GetRig | Get a child rig | |
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.
Returns true if the child is currently contributing actively to the camera state. (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 | Makes sure that the child rigs get destroyed in an undo-firndly manner.
Invalidates the rig cache. (Overrides CinemachineVirtualCameraBaseOnDestroy.) | |
OnDisable | Base class implementation makes sure the priority queue remains up-to-date. (Inherited from CinemachineVirtualCameraBase.) | |
OnEnable | Updates the child rig cache (Overrides CinemachineVirtualCameraBaseOnEnable.) | |
OnTransformParentChanged | Base class implementation makes sure the priority queue remains up-to-date. (Inherited from CinemachineVirtualCameraBase.) | |
OnTransitionFromCamera | If we are transitioning from another FreeLook, grab the axis values from it. (Overrides CinemachineVirtualCameraBaseOnTransitionFromCamera(ICinemachineCamera).) | |
OnValidate | Enforce bounds for fields, when changed in inspector. (Overrides CinemachineVirtualCameraBaseOnValidate.) | |
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 might be called on LateUpdate.
This implementation pushes the axis values to the rigs.
(Overrides CinemachineVirtualCameraBasePreUpdateChildCameras(Vector3, Single).) | |
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. All 3 child rigs are updated,
and a blend calculated, depending on the value of the Y axis. (Overrides CinemachineVirtualCameraBaseUpdateCameraState(Vector3, Single).) |
See Also