Class CinemachineBlenderSettings

Asset that defines the rules for blending between Virtual Cameras.

Inheritance

object

Object

ScriptableObject

CinemachineBlenderSettings

Inherited Members

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Unity.Cinemachine

Assembly: Unity.Cinemachine.dll

Syntax

[Serializable]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.cinemachine@3.1/manual/CinemachineBlending.html")]
public sealed class CinemachineBlenderSettings : ScriptableObject

Fields

CustomBlends

The array containing explicitly defined blends between two Virtual Cameras

Declaration

[Tooltip("The array containing explicitly defined blends between two Virtual Cameras")]
[FormerlySerializedAs("m_CustomBlends")]
public CinemachineBlenderSettings.CustomBlend[] CustomBlends

Field Value

Type	Description
CustomBlend[]

Methods

GetBlendForVirtualCameras(string, string, CinemachineBlendDefinition)

Attempts to find a blend definition which matches the to and from cameras as specified. If no match is found, the function returns the supplied default blend.

Declaration

public CinemachineBlendDefinition GetBlendForVirtualCameras(string fromCameraName, string toCameraName, CinemachineBlendDefinition defaultBlend)

Parameters

Type	Name	Description
string	fromCameraName	The game object name of the from camera
string	toCameraName	The game object name of the to camera
CinemachineBlendDefinition	defaultBlend	Blend to return if no custom blend found.

Returns

Type	Description
CinemachineBlendDefinition	The blend definition to use for the blend.

LookupBlend(ICinemachineCamera, ICinemachineCamera, CinemachineBlendDefinition, CinemachineBlenderSettings, Object)

Find a blend curve for blending from one ICinemachineCamera to another. If there is a specific blend defined for these cameras it will be used, otherwise a default blend will be created, which could be a cut.

CinemachineCore.GetBlendOverride will be called at the end, so that the client may override the choice of blend.

Declaration

public static CinemachineBlendDefinition LookupBlend(ICinemachineCamera outgoing, ICinemachineCamera incoming, CinemachineBlendDefinition defaultBlend, CinemachineBlenderSettings customBlends, Object owner)

Parameters

Type	Name	Description
ICinemachineCamera	outgoing	The camera we're blending from.
ICinemachineCamera	incoming	The camera we're blending to.
CinemachineBlendDefinition	defaultBlend	Blend to return if no custom blend found.
CinemachineBlenderSettings	customBlends	The custom blends asset to search, or null.
Object	owner	The object that is requesting the blend, for GetBlendOverride callback context.

Returns

Type	Description
CinemachineBlendDefinition	The blend to use for this camera transition.