Class CinemachineCameraManagerBase
This is a virtual camera "manager" that owns and manages a collection of child Cm Cameras.
Inheritance
Inherited Members
Namespace: Unity.Cinemachine
Assembly: solution.dll
Syntax
public abstract class CinemachineCameraManagerBase : CinemachineVirtualCameraBase, ICinemachineMixer, ICinemachineCameraFields
| Name | Description |
|---|---|
| CustomBlends | This is the asset which contains custom settings for specific child blends. |
| DefaultBlend | The blend which is used if you don't explicitly define a blend between two Virtual Camera children. |
| DefaultTarget | If enabled, a default target will be available. It will be used if a child rig needs a target and doesn't specify one itself. |
Properties
| Name | Description |
|---|---|
| ActiveBlend | Get the current blend in progress. Returns null if none. It is also possible to set the current blend, but this is not a recommended usage unless it is to set the active blend to null, which will force completion of the blend. |
| ChildCameras | The list of child cameras. These are just the immediate children in the hierarchy. |
| Description | Gets a brief debug description of this virtual camera, for use when displaying debug info |
| Follow | Get the current Follow target. Returns parent's Follow if parent is non-null and no specific Follow defined for this camera |
| IsBlending | Is there a blend in progress? |
| LiveChild | Get the current active camera. Will return null if no camera is active. |
| LookAt | Get the current LookAt target. Returns parent's LookAt if parent is non-null and no specific LookAt defined for this camera |
| PreviousStateIsValid | Set this to force the next update to ignore state from the previous frame. |
| State | The CameraState object holds all of the information necessary to position the Unity camera. It is the output of this class. |
Methods
| Name | Description |
|---|---|
| ChooseCurrentCamera(Vector3, float) | Choose the appropriate current camera from among the ChildCameras, based on current state. If the returned camera is different from the current camera, an appropriate transition will be made. |
| FinalizeCameraState(float) | At the end of InternalUpdateCameraState, call this to finalize the state |
| ForceCameraPosition(Vector3, Quaternion) | Force the virtual camera to assume a given position and orientation |
| InternalUpdateCameraState(Vector3, float) | Internal use only. Do not call this method. 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. |
| InvalidateCameraCache() | Force a rebuild of the child camera cache. |
| IsLiveChild(ICinemachineCamera, bool) | Check whether the cam is a live child of this camera. |
| LookupBlend(ICinemachineCamera, ICinemachineCamera) | Find a blend curve for blending from one child camera to another. |
| OnDisable() | Standard MonoBehaviour OnDisable. Derived classes must call base class implementation. |
| OnEnable() | Standard MonoBehaviour OnEnable. Derived classes must call base class implementation. |
| OnTargetObjectWarped(Transform, Vector3) | This is called to notify the vcam that a target got warped, so that the vcam can update its internal state to make the camera also warp seamlessly. |
| OnTransformChildrenChanged() | Makes sure the internal child cache is up to date |
| OnTransitionFromCamera(ICinemachineCamera, Vector3, float) | Notification that this virtual camera is going live. |
| Reset() | Reset the component to default values. |
| ResetLiveChild() | Cancel current active camera and all blends |
| SetLiveChild(ICinemachineCamera, Vector3, float) | Set the current active camera. All necessary blends will be created, and events generated. |
| UpdateCameraCache() | Rebuild the camera cache if it's been invalidated |