Struct CinemachineBlendDefinition
Definition of a Camera blend. This struct holds the information necessary to generate a suitable AnimationCurve for a Cinemachine Blend.
Namespace: Cinemachine
Syntax
[Serializable]
[DocumentationSorting(DocumentationSortingAttribute.Level.UserRef)]
public struct CinemachineBlendDefinition
Constructors
CinemachineBlendDefinition(CinemachineBlendDefinition.Style, Single)
Constructor
Declaration
public CinemachineBlendDefinition(CinemachineBlendDefinition.Style style, float time)
Parameters
Type | Name | Description |
---|---|---|
CinemachineBlendDefinition.Style | style | The shape of the blend curve. |
Single | time | The duration (in seconds) of the blend |
Fields
m_CustomCurve
A user-defined AnimationCurve, used only if style is Custom. Curve MUST be normalized, i.e. time range [0...1], value range [0...1].
Declaration
public AnimationCurve m_CustomCurve
Field Value
Type | Description |
---|---|
AnimationCurve |
m_Style
The shape of the blend curve.
Declaration
[Tooltip("Shape of the blend curve")]
public CinemachineBlendDefinition.Style m_Style
Field Value
Type | Description |
---|---|
CinemachineBlendDefinition.Style |
m_Time
The duration (in seconds) of the blend, if not a cut.
If style is a cut, then this value is ignored.
Declaration
[Tooltip("Duration of the blend, in seconds")]
public float m_Time
Field Value
Type | Description |
---|---|
Single |
Properties
BlendCurve
A normalized AnimationCurve specifying the interpolation curve for this camera blend. Y-axis values must be in range [0,1] (internally clamped within Blender) and time must be in range of [0, 1].
Declaration
public readonly AnimationCurve BlendCurve { get; }
Property Value
Type | Description |
---|---|
AnimationCurve |
BlendTime
Get the duration of the blend, in seconds. Will return 0 if blend style is a cut.
Declaration
public readonly float BlendTime { get; }
Property Value
Type | Description |
---|---|
Single |