Class CinemachineMixingCamera

CinemachineMixingCamera is a "manager camera" that takes on the state of the weighted average of the states of its child virtual cameras.

A fixed number of slots are made available for cameras, rather than a dynamic array. We do it this way in order to support weight animation from the Timeline. Timeline cannot animate array elements.

Inheritance

System.Object

CinemachineVirtualCameraBase

CinemachineMixingCamera

Inherited Members

CinemachineVirtualCameraBase.m_ExcludedPropertiesInInspector

CinemachineVirtualCameraBase.m_LockStageInInspector

CinemachineVirtualCameraBase.ValidatingStreamVersion

CinemachineVirtualCameraBase.m_Priority

CinemachineVirtualCameraBase.m_StandbyUpdate

CinemachineVirtualCameraBase.AddExtension(CinemachineExtension)

CinemachineVirtualCameraBase.RemoveExtension(CinemachineExtension)

CinemachineVirtualCameraBase.InvokePostPipelineStageCallback(CinemachineVirtualCameraBase, CinemachineCore.Stage, CameraState, Single)

CinemachineVirtualCameraBase.InvokeOnTransitionInExtensions(ICinemachineCamera, Vector3, Single)

CinemachineVirtualCameraBase.Name

CinemachineVirtualCameraBase.Description

CinemachineVirtualCameraBase.Priority

CinemachineVirtualCameraBase.ApplyPositionBlendMethod(CameraState, CinemachineVirtualCameraBase.BlendHint)

CinemachineVirtualCameraBase.VirtualCameraGameObject

CinemachineVirtualCameraBase.IsValid

CinemachineVirtualCameraBase.ParentCamera

CinemachineVirtualCameraBase.PreviousStateIsValid

CinemachineVirtualCameraBase.UpdateCameraState(Vector3, Single)

CinemachineVirtualCameraBase.OnDestroy()

CinemachineVirtualCameraBase.OnTransformParentChanged()

CinemachineVirtualCameraBase.Start()

CinemachineVirtualCameraBase.OnDisable()

CinemachineVirtualCameraBase.Update()

CinemachineVirtualCameraBase.ResolveLookAt(Transform)

CinemachineVirtualCameraBase.ResolveFollow(Transform)

CinemachineVirtualCameraBase.MoveToTopOfPrioritySubqueue()

CinemachineVirtualCameraBase.CreateBlend(ICinemachineCamera, ICinemachineCamera, CinemachineBlendDefinition, CinemachineBlend)

CinemachineVirtualCameraBase.PullStateFromVirtualCamera(Vector3, LensSettings)

Namespace: Cinemachine

Syntax

[DocumentationSorting(DocumentationSortingAttribute.Level.UserRef)]
public class CinemachineMixingCamera : CinemachineVirtualCameraBase, ICinemachineCamera

Fields

m_Weight0

Weight of the first tracked camera

Declaration

public float m_Weight0

Field Value

Type	Description
System.Single

m_Weight1

Weight of the second tracked camera

Declaration

public float m_Weight1

Field Value

Type	Description
System.Single

m_Weight2

Weight of the third tracked camera

Declaration

public float m_Weight2

Field Value

Type	Description
System.Single

m_Weight3

Weight of the fourth tracked camera

Declaration

public float m_Weight3

Field Value

Type	Description
System.Single

m_Weight4

Weight of the fifth tracked camera

Declaration

public float m_Weight4

Field Value

Type	Description
System.Single

m_Weight5

Weight of the sixth tracked camera

Declaration

public float m_Weight5

Field Value

Type	Description
System.Single

m_Weight6

Weight of the seventh tracked camera

Declaration

public float m_Weight6

Field Value

Type	Description
System.Single

m_Weight7

Weight of the eighth tracked camera

Declaration

public float m_Weight7

Field Value

Type	Description
System.Single

MaxCameras

The maximum number of tracked cameras. If you want to add more cameras, do it here in the source code, and be sure to add the extra member variables and to make the appropriate changes in GetWeight() and SetWeight(). The inspector will figure itself out based on this value.

Declaration

public const int MaxCameras = 8

Field Value

Type	Description
System.Int32

Properties

ChildCameras

Get the cached list of child cameras. These are just the immediate children in the hierarchy. Note: only the first entries of this list participate in the final blend, up to MaxCameras

Declaration

public CinemachineVirtualCameraBase[] ChildCameras { get; }

Property Value

Type	Description
CinemachineVirtualCameraBase[]

Follow

Not used

Declaration

public override Transform Follow { get; set; }

Property Value

Type	Description
Transform

Overrides

CinemachineVirtualCameraBase.Follow

LookAt

Not used

Declaration

public override Transform LookAt { get; set; }

Property Value

Type	Description
Transform

Overrides

CinemachineVirtualCameraBase.LookAt

State

The blended CameraState

Declaration

public override CameraState State { get; }

Property Value

Type	Description
CameraState

Overrides

CinemachineVirtualCameraBase.State

Methods

GetWeight(CinemachineVirtualCameraBase)

Get the weight of the child CinemachineVirtualCameraBase.

Declaration

public float GetWeight(CinemachineVirtualCameraBase vcam)

Parameters

Type	Name	Description
CinemachineVirtualCameraBase	vcam	The child camera.

Returns

Type	Description
System.Single	The weight of the camera. Valid only if camera is active and enabled.

GetWeight(Int32)

Get the weight of the child at an index.

Declaration

public float GetWeight(int index)

Parameters

Type	Name	Description
System.Int32	index	The child index. Only immediate CinemachineVirtualCameraBase children are counted.

Returns

Type	Description
System.Single	The weight of the camera. Valid only if camera is active and enabled.

InternalUpdateCameraState(Vector3, Single)

Internal use only. Do not call this methid. Called by CinemachineCore at designated update time so the vcam can position itself and track its targets. This implementation computes and caches the weighted blend of the tracked cameras.

Declaration

public override void InternalUpdateCameraState(Vector3 worldUp, float deltaTime)

Parameters

Type	Name	Description
Vector3	worldUp	Default world Up, set by the CinemachineBrain
System.Single	deltaTime	Delta time for time-based effects (ignore if less than 0)

Overrides

CinemachineVirtualCameraBase.InternalUpdateCameraState(Vector3, Single)

InvalidateListOfChildren()

Invalidate the cached list of child cameras.

Declaration

protected void InvalidateListOfChildren()

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
System.Boolean	dominantChildOnly	If truw, will only return true if this vcam is the dominat live child

Returns

Type	Description
System.Boolean	True if the vcam is currently actively influencing the state of this vcam

Overrides

CinemachineVirtualCameraBase.IsLiveChild(ICinemachineCamera, Boolean)

OnEnable()

Makes sure the internal child cache is up to date

Declaration

protected override void OnEnable()

Overrides

CinemachineVirtualCameraBase.OnEnable()

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

CinemachineVirtualCameraBase.OnTargetObjectWarped(Transform, Vector3)

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
System.Single	deltaTime	Delta time for time-based effects (ignore if less than or equal to 0)

Overrides

CinemachineVirtualCameraBase.OnTransitionFromCamera(ICinemachineCamera, Vector3, Single)

OnValidate()

Makes sure the weights are non-negative

Declaration

protected override void OnValidate()

Overrides

CinemachineVirtualCameraBase.OnValidate()

SetWeight(CinemachineVirtualCameraBase, Single)

Set the weight of the child CinemachineVirtualCameraBase.

Declaration

public void SetWeight(CinemachineVirtualCameraBase vcam, float w)

Parameters

Type	Name	Description
CinemachineVirtualCameraBase	vcam	The child camera.
System.Single	w	The weight to set. Can be any non-negative number.

SetWeight(Int32, Single)

Set the weight of the child at an index.

Declaration

public void SetWeight(int index, float w)

Parameters

Type	Name	Description
System.Int32	index	The child index. Only immediate CinemachineVirtualCameraBase children are counted.
System.Single	w	The weight to set. Can be any non-negative number.

ValidateListOfChildren()

Rebuild the cached list of child cameras.

Declaration

protected void ValidateListOfChildren()