Class CinemachineBlendListCamera
This is a virtual camera "manager" that owns and manages a collection of child Virtual Cameras. When the camera goes live, these child vcams are enabled, one after another, holding each camera for a designated time. Blends between cameras are specified. The last camera is held indefinitely.
Inheritance
Inherited Members
Namespace: Cinemachine
Assembly: Cinemachine.dll
Syntax
[DocumentationSorting(DocumentationSortingAttribute.Level.UserRef)]
[DisallowMultipleComponent]
[ExecuteAlways]
[ExcludeFromPreset]
[AddComponentMenu("Cinemachine/CinemachineBlendListCamera")]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.cinemachine@2.9/manual/CinemachineBlendListCamera.html")]
public class CinemachineBlendListCamera : CinemachineVirtualCameraBase, ICinemachineCamera, ISerializationCallbackReceiverFields
m_Follow
Default object for the camera children wants to move with (the body target), if not specified in a child rig. May be empty
Declaration
[Tooltip("Default object for the camera children wants to move with (the body target), if not specified in a child camera. May be empty if all of the children define targets of their own.")]
public Transform m_FollowField Value
| Type | Description |
|---|---|
| Transform |
m_Instructions
The set of instructions associating virtual cameras with states. The set of instructions for enabling child cameras
Declaration
[Tooltip("The set of instructions for enabling child cameras.")]
public CinemachineBlendListCamera.Instruction[] m_InstructionsField Value
| Type | Description |
|---|---|
| Instruction[] |
m_LookAt
Default object for the camera children to look at (the aim target), if not specified in a child rig. May be empty
Declaration
[Tooltip("Default object for the camera children to look at (the aim target), if not specified in a child camera. May be empty if all of the children define targets of their own.")]
public Transform m_LookAtField Value
| Type | Description |
|---|---|
| Transform |
m_Loop
When enabled, the child vcams will cycle indefinitely instead of just stopping at the last one
Declaration
[Tooltip("When enabled, the child vcams will cycle indefinitely instead of just stopping at the last one")]
public bool m_LoopField Value
| Type | Description |
|---|---|
| bool |
m_ShowDebugText
When enabled, the current camera and blend will be indicated in the game window, for debugging
Declaration
[Tooltip("When enabled, the current child camera and blend will be indicated in the game window, for debugging")]
public bool m_ShowDebugTextField Value
| Type | Description |
|---|---|
| bool |
Properties
ChildCameras
The list of child cameras. These are just the immediate children in the hierarchy.
Declaration
public CinemachineVirtualCameraBase[] ChildCameras { get; }Property Value
| Type | Description |
|---|---|
| CinemachineVirtualCameraBase[] |
Description
Gets a brief debug description of this virtual camera, for use when displayiong debug info
Declaration
public override string Description { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
Follow
Get the current Follow target. Returns parent's Follow if parent is non-null and no specific Follow defined for this camera
Declaration
public override Transform Follow { get; set; }Property Value
| Type | Description |
|---|---|
| Transform |
Overrides
IsBlending
Is there a blend in progress?
Declaration
public bool IsBlending { get; }Property Value
| Type | Description |
|---|---|
| bool |
LiveChild
Get the current "best" child virtual camera, that would be chosen if the State Driven Camera were active.
Declaration
public ICinemachineCamera LiveChild { get; set; }Property Value
| Type | Description |
|---|---|
| ICinemachineCamera |
LookAt
Get the current LookAt target. Returns parent's LookAt if parent is non-null and no specific LookAt defined for this camera
Declaration
public override Transform LookAt { get; set; }Property Value
| Type | Description |
|---|---|
| Transform |
Overrides
State
The State of the current live child
Declaration
public override CameraState State { get; }Property Value
| Type | Description |
|---|---|
| CameraState |
Overrides
Methods
ForceCameraPosition(Vector3, Quaternion)
Force the virtual camera to assume a given position and orientation
Declaration
public override void ForceCameraPosition(Vector3 pos, Quaternion rot)Parameters
| Type | Name | Description |
|---|---|---|
| Vector3 | pos | Worldspace pposition to take |
| Quaternion | rot | Worldspace orientation to take |
Overrides
InternalUpdateCameraState(Vector3, float)
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.
Declaration
public override void InternalUpdateCameraState(Vector3 worldUp, float deltaTime)Parameters
| Type | Name | Description |
|---|---|---|
| Vector3 | worldUp | Default world Up, set by the CinemachineBrain |
| float | deltaTime | Delta time for time-based effects (ignore if less than or equal to 0) |
Overrides
IsLiveChild(ICinemachineCamera, bool)
Check whether the vcam a live child of this camera.
Declaration
public override bool IsLiveChild(ICinemachineCamera vcam, bool dominantChildOnly = false)Parameters
| Type | Name | Description |
|---|---|---|
| ICinemachineCamera | vcam | The Virtual Camera to check |
| bool | dominantChildOnly | If truw, will only return true if this vcam is the dominat live child |
Returns
| Type | Description |
|---|---|
| bool | True if the vcam is currently actively influencing the state of this vcam |
Overrides
OnDisable()
Uninstall the GUI handler
Declaration
protected override void OnDisable()Overrides
OnEnable()
Makes sure the internal child cache is up to date
Declaration
protected override void OnEnable()Overrides
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 seamlessy.
Declaration
public override void OnTargetObjectWarped(Transform target, Vector3 positionDelta)Parameters
| Type | Name | Description |
|---|---|---|
| Transform | target | The object that was warped |
| Vector3 | positionDelta | The amount the target's position changed |
Overrides
OnTransitionFromCamera(ICinemachineCamera, Vector3, float)
Notification that this virtual camera is going live.
Declaration
public override void OnTransitionFromCamera(ICinemachineCamera fromCam, Vector3 worldUp, float deltaTime)Parameters
| Type | Name | Description |
|---|---|---|
| ICinemachineCamera | fromCam | The camera being deactivated. May be null. |
| Vector3 | worldUp | Default world Up, set by the CinemachineBrain |
| float | deltaTime | Delta time for time-based effects (ignore if less than or equal to 0) |