Class CinemachineStateDrivenCamera

This is a virtual camera "manager" that owns and manages a collection of child Virtual Cameras. These child vcams are mapped to individual states in an animation state machine, allowing you to associate specific vcams to specific animation states. When that state is active in the state machine, then the associated camera will be activated.

You can define custom blends and transitions between child cameras.

In order to use this behaviour, you must have an animated target (i.e. an object animated with a state machine) to drive the behaviour.

Inheritance
Object
Object
Component
Behaviour
MonoBehaviour
CinemachineVirtualCameraBase
CinemachineStateDrivenCamera
Inherited Members
Namespace: Cinemachine
Syntax
[DocumentationSorting(DocumentationSortingAttribute.Level.UserRef)]
[DisallowMultipleComponent]
[ExecuteAlways]
[ExcludeFromPreset]
[AddComponentMenu("Cinemachine/CinemachineStateDrivenCamera")]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.cinemachine@2.9/manual/CinemachineStateDrivenCamera.html")]
public class CinemachineStateDrivenCamera : CinemachineVirtualCameraBase, ICinemachineCamera, ISerializationCallbackReceiver

Fields

m_AnimatedTarget

The state machine whose state changes will drive this camera's choice of active child

Declaration
[Space]
[Tooltip("The state machine whose state changes will drive this camera's choice of active child")]
public Animator m_AnimatedTarget
Field Value
Type Description
Animator

m_CustomBlends

This is the asset which contains custom settings for specific child blends.

Declaration
[Tooltip("This is the asset which contains custom settings for specific child blends")]
public CinemachineBlenderSettings m_CustomBlends
Field Value
Type Description
CinemachineBlenderSettings

m_DefaultBlend

The blend which is used if you don't explicitly define a blend between two Virtual Camera children.

Declaration
[Tooltip("The blend which is used if you don't explicitly define a blend between two Virtual Camera children")]
public CinemachineBlendDefinition m_DefaultBlend
Field Value
Type Description
CinemachineBlendDefinition

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_Follow
Field Value
Type Description
Transform

m_Instructions

The set of instructions associating virtual cameras with states. These instructions are used to choose the live child at any given moment

Declaration
[Tooltip("The set of instructions associating virtual cameras with states.  These instructions are used to choose the live child at any given moment")]
public CinemachineStateDrivenCamera.Instruction[] m_Instructions
Field Value
Type Description
CinemachineStateDrivenCamera.Instruction[]

m_LayerIndex

Which layer in the target FSM to observe

Declaration
[Tooltip("Which layer in the target state machine to observe")]
public int m_LayerIndex
Field Value
Type Description
Int32

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_LookAt
Field Value
Type Description
Transform

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_ShowDebugText
Field Value
Type Description
Boolean

Properties

ActiveBlend

Get the current active blend in progress. Will return null if no blend is in progress.

Declaration
public CinemachineBlend ActiveBlend { get; }
Property Value
Type Description
CinemachineBlend

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
Boolean

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

CreateFakeHash(Int32, AnimationClip)

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

Declaration
public static int CreateFakeHash(int parentHash, AnimationClip clip)
Parameters
Type Name Description
Int32 parentHash

Parent state's hash
AnimationClip clip

The clip to create the fake hash for
Returns
Type Description
Int32

The fake hash

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, Single)

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.

Declaration
public override void InternalUpdateCameraState(Vector3 worldUp, float deltaTime)
Parameters
Type Name Description
Vector3 worldUp

Default world Up, set by the CinemachineBrain
Single deltaTime

Delta time for time-based effects (ignore if less than or equal to 0)
Overrides

IsLiveChild(ICinemachineCamera, Boolean)

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
Boolean dominantChildOnly

If true, will only return true if this vcam is the dominat live child
Returns
Type Description
Boolean

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 seamlessly.

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

OnTransformChildrenChanged()

Makes sure the internal child cache is up to date

Declaration
public void OnTransformChildrenChanged()

OnTransitionFromCamera(ICinemachineCamera, Vector3, Single)

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
Single deltaTime

Delta time for time-based effects (ignore if less than or equal to 0)
Overrides