Cinemachine

https://docs.unity3d.com/Packages/com.unity.cinemachine@3.1/
Admin
Cinemachine is a suite of procedural modules for controlling the Unity camera that automates...
Tokens:297,239
Snippets:3,432
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### TrackerSettings.Default

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.TargetTracking.TrackerSettings.html

Gets the default tracking settings.

```APIDOC
## TrackerSettings.Default

### Description
Get the default tracking settings.

### Property
public static TrackerSettings Default { get; }

### Property Value
- **TrackerSettings** - The default tracking settings.

```

--------------------------------

### InstallHandlers(ICinemachineMixer)

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineMixerEventsBase.html

Installs the event handlers for the specified mixer. Call this from OnEnable().

```APIDOC
## InstallHandlers(ICinemachineMixer)

### Description
Installs the event handlers. Call this from OnEnable().

### Declaration
```csharp
protected void InstallHandlers(ICinemachineMixer mixer)
```

### Parameters
| Type | Name | Description |
| --- | --- | --- |
| ICinemachineMixer | mixer | The mixer object to monitor. |

```

--------------------------------

### GetValueAt(float)

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineImpulseManager.EnvelopeDefinition.html

Gets the value of the envelope at a given time relative to the envelope start.

```APIDOC
## GetValueAt(float)

### Description
Gets the value of the envelope at a given time relative to the envelope start.

### Method
GetValueAt

### Parameters
#### Parameters
- **offset** (float) - Required - Time in seconds from the envelope start

### Returns
- **float** - Envelope amplitude. This will range from 0...1

### Declaration
```csharp
public readonly float GetValueAt(float offset)
```
```

--------------------------------

### Methods

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineSplineDolly.html

Methods of CinemachineSplineDolly for component lifecycle and camera state mutation.

```APIDOC
## Methods

### GetMaxDampTime()

Reports the maximum damping time needed for this component.

**Declaration**
csharp
public override float GetMaxDampTime()


**Returns**
| Type | Description |
|------|-------------|
| float | Highest damping setting in this component. |

**Overrides**
CinemachineComponentBase.GetMaxDampTime()

### MutateCameraState(ref CameraState, float)

Positions the virtual camera according to the transposer rules.

**Declaration**
csharp
public override void MutateCameraState(ref CameraState curState, float deltaTime)


**Parameters**
| Type | Name | Description |
|------|------|-------------|
| CameraState | curState | The current camera state. |
| float | deltaTime | Used for damping. If less than 0, no damping is done. |

**Overrides**
CinemachineComponentBase.MutateCameraState(ref CameraState, float)

### OnDisable()

Standard OnDisable call. Derived classes should call the base class implementation. Handles pipeline validation.

**Declaration**
csharp
protected override void OnDisable()


**Overrides**
CinemachineComponentBase.OnDisable()

### OnEnable()

Standard OnEnable call. Derived classes should call the base class implementation. Handles pipeline validation.

**Declaration**
csharp
protected override void OnEnable()


**Overrides**
CinemachineComponentBase.OnEnable()
```

--------------------------------

### SignalSourceAsset.GetSignal(float, out Vector3, out Quaternion)

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.SignalSourceAsset.html

Gets the signal value at a given time relative to signal start. This method is abstract and must be implemented by derived classes to provide the position and rotation components of the signal.

```APIDOC
## SignalSourceAsset.GetSignal(float, out Vector3, out Quaternion)

### Description
Gets the signal value at a given time relative to signal start. This method is abstract and must be implemented by derived classes to provide the position and rotation components of the signal.

### Declaration
csharp
public abstract void GetSignal(float timeSinceSignalStart, out Vector3 pos, out Quaternion rot)


### Parameters
| Type | Name | Description |
|------|------|-------------|
| float | timeSinceSignalStart | Time since signal start. Always >= 0. |
| Vector3 | pos | Output for position component of the signal. |
| Quaternion | rot | Output for rotation component of the signal. Use Quaternion.identity if none. |

```

--------------------------------

### Cinemachine3OrbitRig.Settings

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.Cinemachine3OrbitRig.Settings.html

Documentation for the Cinemachine3OrbitRig.Settings struct, including its fields and properties.

```APIDOC
## Struct Cinemachine3OrbitRig.Settings

### Description
Settings to define the 3-orbit FreeLook rig using OrbitalFollow.

### Namespace
Unity.Cinemachine

### Assembly
Unity.Cinemachine.dll

### Syntax
```csharp
[Serializable]
public struct Cinemachine3OrbitRig.Settings
```

### Fields

#### Bottom
Value to take at the bottom of the axis range.

```csharp
[Tooltip("Value to take at the bottom of the axis range")]
public Cinemachine3OrbitRig.Orbit Bottom;
```

**Field Value**
- Type: Cinemachine3OrbitRig.Orbit

#### Center
Value to take at the center of the axis range.

```csharp
[Tooltip("Value to take at the center of the axis range")]
public Cinemachine3OrbitRig.Orbit Center;
```

**Field Value**
- Type: Cinemachine3OrbitRig.Orbit

#### SplineCurvature
Controls how taut is the line that connects the rigs' orbits, which determines final placement on the Y axis.

```csharp
[Tooltip("Controls how taut is the line that connects the rigs' orbits, which determines final placement on the Y axis")]
[Range(0, 1)]
public float SplineCurvature;
```

**Field Value**
- Type: float

#### Top
Value to take at the top of the axis range.

```csharp
[Tooltip("Value to take at the top of the axis range")]
public Cinemachine3OrbitRig.Orbit Top;
```

**Field Value**
- Type: Cinemachine3OrbitRig.Orbit

### Properties

#### Default
Default orbit rig.

```csharp
public static Cinemachine3OrbitRig.Settings Default { get; }
```

**Property Value**
- Type: Cinemachine3OrbitRig.Settings
```

--------------------------------

### TrackerSettings

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineTransposer.html

Get the damping settings.

```APIDOC
## TrackerSettings

### Description
Get the damping settings.

### Declaration
```csharp
protected TrackerSettings TrackerSettings { get; }
```

### Property Value
| Type | Description |
|------|-------------|
| TrackerSettings | The damping settings. |
```

--------------------------------

### NewImpulseEvent()

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineImpulseManager.html

Gets a new ImpulseEvent.

```APIDOC
## NewImpulseEvent()

### Description
Gets a new ImpulseEvent.

### Method
NewImpulseEvent

### Returns
- **CinemachineImpulseManager.ImpulseEvent** - A newly-created impulse event. May be recycled from expired events.

### Declaration
```csharp
public CinemachineImpulseManager.ImpulseEvent NewImpulseEvent()
```
```

--------------------------------

### GetPresetIndex(string)

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.Editor.CinemachineLensPalette.html

Gets the index of the first preset that matches the preset name.

```APIDOC
## GetPresetIndex(string)

### Description
Gets the index of the first preset that matches the preset name.

### Method
GetPresetIndex

### Parameters
- **presetName** (string) - Required - Name of the preset

### Returns
- **int** - the preset index, or -1 if no matching preset

### Declaration
```
public int GetPresetIndex(string presetName)
```
```

--------------------------------

### BeforePipeline(CinemachineVirtualCameraBase, ref CameraState, float, float)

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineFreeLookModifier.PositionDampingModifier.html

Called from extension's PrePipelineMutateCameraState(). Perform any necessary actions to modify relevant camera settings. Original camera settings should be restored in AfterPipeline(CinemachineVirtualCameraBase, ref CameraState, float, float).

```APIDOC
## BeforePipeline(CinemachineVirtualCameraBase, ref CameraState, float, float)

### Description
Called from extension's PrePipelineMutateCameraState(). Perform any necessary actions to modify relevant camera settings. Original camera settings should be restored in AfterPipeline(CinemachineVirtualCameraBase, ref CameraState, float, float).

### Declaration
```
public override void BeforePipeline(CinemachineVirtualCameraBase vcam, ref CameraState state, float deltaTime, float modifierValue)
```

### Parameters
- **vcam** (CinemachineVirtualCameraBase) - vcam owner
- **state** (CameraState) - current vcam state. May be modified in this function
- **deltaTime** (float) - current applicable deltaTime
- **modifierValue** (float) - The normalized value of the modifier variable. This is the FreeLook's vertical axis. Ranges from -1 to 1, where 0 is center rig.

### Overrides
CinemachineFreeLookModifier.Modifier.BeforePipeline(CinemachineVirtualCameraBase, ref CameraState, float, float)
```

--------------------------------

### GetClampedValue()

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.InputAxis.html

Gets the clamped axis value.

```APIDOC
## GetClampedValue()

### Description
Get the clamped axis value.

### Method
GetClampedValue

### Declaration
```csharp
public float GetClampedValue()
```

### Parameters
None.

### Returns
- **float** - The axis value, clamped to the axis range.
```

--------------------------------

### Prioritize()

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineVirtualCameraBase.html

Pushes this camera to the top of its priority peers, making it the current Live camera if it shares the highest priority.

```APIDOC
## Prioritize()

### Description
When multiple Cm Cameras have the highest priority, there is sometimes the need to push one to the top, making it the current Live camera if it shares the highest priority in the queue with its peers. This happens automatically when a new CinemachineCamera is enabled: the most recent one goes to the top of the priority sub-queue. Use this method to push a camera to the top of its priority peers. If it and its peers share the highest priority, then this vcam will become Live.

### Method
Prioritize

### Declaration
```csharp
public void Prioritize()
```
```

--------------------------------

### CinemachinePhysicalLensPalette.Preset.Name

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.Editor.CinemachinePhysicalLensPalette.Preset.html

Gets or sets the name of the preset.

```APIDOC
## Field: Name

### Description
The name of the preset.

### Declaration
```csharp
[Tooltip("Lens Name")]
[FormerlySerializedAs("m_Name")]
public string Name;
```

### Field Value
- **Type**: `string`
- **Description**: The name of the preset.
```

--------------------------------

### CinemachineConfiner2D.OversizeWindowSettings

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineConfiner2D.OversizeWindowSettings.html

Documentation for the CinemachineConfiner2D.OversizeWindowSettings struct, including its fields and their descriptions.

```APIDOC
## Struct CinemachineConfiner2D.OversizeWindowSettings

### Description
Settings to optimize computation and memory costs in the event that the window size is expected to be larger than will fit inside the confining shape.

### Namespace
Unity.Cinemachine

### Assembly
Unity.Cinemachine.dll

### Syntax
```csharp
[Serializable]
public struct CinemachineConfiner2D.OversizeWindowSettings
```

### Fields

#### Enabled
Enable optimizing of computation and memory costs in the event that the window size is expected to be larger than will fit inside the confining shape. Enable only if needed, because it's costly.

**Declaration**
```csharp
[Tooltip("Enable optimizing of computation and memory costs in the event that the window size is expected to be larger than will fit inside the confining shape.\nEnable only if needed, because it's costly")]
public bool Enabled
```

**Field Value**
| Type | Description |
| --- | --- |
| bool | |

#### MaxWindowSize
To optimize computation and memory costs, set this to the largest view size that the camera is expected to have. The confiner will not compute a polygon cache for frustum sizes larger than this. This refers to the size in world units of the frustum at the confiner plane (for orthographic cameras, this is just the orthographic size). If set to 0, then this parameter is ignored and a polygon cache will be calculated for all potential window sizes.

**Declaration**
```csharp
[Tooltip("To optimize computation and memory costs, set this to the largest view size that the camera is expected to have.  The confiner will not compute a polygon cache for frustum sizes larger than this.  This refers to the size in world units of the frustum at the confiner plane (for orthographic cameras, this is just the orthographic size).  If set to 0, then this parameter is ignored and a polygon cache will be calculated for all potential window sizes.")]
public float MaxWindowSize
```

**Field Value**
| Type | Description |
| --- | --- |
| float | |

#### Padding
For large window sizes, the confiner will potentially generate polygons with zero area. The padding may be used to add a small amount of area to these polygons, to prevent them from being a series of disconnected dots.

**Declaration**
```csharp
[Tooltip("For large window sizes, the confiner will potentially generate polygons with zero area.  The padding may be used to add a small amount of area to these polygons, to prevent them from being a series of disconnected dots.")]
[Range(0, 100)]
public float Padding
```

**Field Value**
| Type | Description |
| --- | --- |
| float | |
```

--------------------------------

### CinemachineExtension.Awake()

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineExtension.html

Connects to the virtual camera pipeline. Override implementations must call this base implementation.

```APIDOC
## Awake()

### Description
Connect to virtual camera pipeline. Override implementations must call this base implementation.

### Method
Awake

### Returns
void
```

--------------------------------

### EffectiveOffset

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineTransposer.html

Get the target offset, with sanitization.

```APIDOC
## EffectiveOffset

### Description
Get the target offset, with sanitization.

### Declaration
```csharp
public Vector3 EffectiveOffset { get; }
```

### Property Value
| Type | Description |
|------|-------------|
| Vector3 | The effective target offset. |
```

--------------------------------

### GetPresetIndex(string)

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.Editor.CinemachinePhysicalLensPalette.html

Returns the index of the first physical preset that matches the given preset name.

```APIDOC
## GetPresetIndex(string)

### Description
Get the index of the first physical preset that matches the preset name.

### Method
GetPresetIndex

### Parameters
- **presetName** (string) - Required - Name of the preset.

### Returns
- **int** - The preset index, or -1 if no matching preset.
```

--------------------------------

### CinemachineBrain.DefaultWorldUp

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineBrain.html

Gets the default world up for the CinemachineCameras.

```APIDOC
## CinemachineBrain.DefaultWorldUp

### Description
Gets the default world up for the CinemachineCameras.

### Declaration
```csharp
public Vector3 DefaultWorldUp { get; }
```

### Property Value
| Type | Description |
| --- | --- |
| Vector3 | The default world up vector. |
```

--------------------------------

### InvokeOnTransitionInExtensions(ICinemachineCamera, Vector3, float)

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineVirtualCameraBase.html

Invokes transition callbacks for all extensions on this camera.

```APIDOC
## InvokeOnTransitionInExtensions(ICinemachineCamera, Vector3, float)

### Description
Invokes the OnTransitionFromCamera for all extensions on this camera.

### Method
InvokeOnTransitionInExtensions

### Parameters
- **fromCam** (ICinemachineCamera) - The camera being deactivated. May be null.
- **worldUp** (Vector3) - Default world Up, set by the CinemachineBrain
- **deltaTime** (float) - Delta time for time-based effects (ignore if less than or equal to 0)

### Returns
- **bool** - True to request a vcam update of internal state
```

--------------------------------

### CinemachineBrain.ActiveVirtualCamera

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineBrain.html

Gets the current active CinemachineCamera.

```APIDOC
## CinemachineBrain.ActiveVirtualCamera

### Description
Gets the current active CinemachineCamera.

### Declaration
```csharp
public ICinemachineCamera ActiveVirtualCamera { get; }
```

### Property Value
| Type | Description |
| --- | --- |
| ICinemachineCamera | The current active CinemachineCamera. |
```

--------------------------------

### GetReliableHeading()

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.HeadingTracker.html

Gets the filtered heading direction of motion.

```APIDOC
## GetReliableHeading()

### Description
Get the filtered heading.

### Method
`public Vector3 GetReliableHeading()`

### Returns
- **Vector3** - The filtered direction of motion.

```

--------------------------------

### CinemachineDeoccluder.ObstacleAvoidance.FollowTargetSettings

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineDeoccluder.ObstacleAvoidance.FollowTargetSettings.html

Settings for resolving towards Follow target instead of LookAt. Contains fields Enabled and YOffset.

```APIDOC
## Struct CinemachineDeoccluder.ObstacleAvoidance.FollowTargetSettings

### Description
Settings for resolving towards Follow target instead of LookAt.

### Namespace
Unity.Cinemachine

### Assembly
Unity.Cinemachine.dll

### Syntax
```csharp
[Serializable]
public struct CinemachineDeoccluder.ObstacleAvoidance.FollowTargetSettings
```

### Fields

#### Enabled
Use the Follow target when resolving occlusions, instead of the LookAt target.

**Declaration**
```csharp
[Tooltip("Use the Follow target when resolving occlusions, instead of the LookAt target.")]
public bool Enabled
```

**Field Value**
- Type: bool
- Description: (none)

#### YOffset
Vertical offset from the Follow target's root, in target local space.

**Declaration**
```csharp
[Tooltip("Vertical offset from the Follow target's root, in target local space")]
public float YOffset
```

**Field Value**
- Type: float
- Description: (none)

```

--------------------------------

### OnTransitionFromCamera(ICinemachineCamera, Vector3, float)

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineFramingTransposer.html

Notification that this virtual camera is going live. Base class implementation does nothing.

```APIDOC
## OnTransitionFromCamera(ICinemachineCamera, Vector3, float)

### Description
Notification that this virtual camera is going live. Base class implementation does nothing.

### Declaration
```csharp
public override bool OnTransitionFromCamera(ICinemachineCamera fromCam, Vector3 worldUp, float deltaTime)
```

### Parameters
- **fromCam** (ICinemachineCamera) - The camera being deactivated. May be null.
- **worldUp** (Vector3) - Default world Up, set by the CinemachineBrain
- **deltaTime** (float) - Delta time for time-based effects (ignore if less than or equal to 0)

### Returns
- **bool** - True if the vcam should do an internal update as a result of this call

### Overrides
CinemachineComponentBase.OnTransitionFromCamera(ICinemachineCamera, Vector3, float)
```

--------------------------------

### FilterSize

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.HeadingTracker.html

Gets the current filter size of the HeadingTracker.

```APIDOC
## FilterSize

### Description
Get the current filter size.

### Property
`public int FilterSize { get; }`

### Property Value
- **int** - The current filter size.

```

--------------------------------

### CinemachineSequencerCamera.Instruction

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineSequencerCamera.Instruction.html

Documentation for the CinemachineSequencerCamera.Instruction struct, including its fields and methods.

```APIDOC
## Struct CinemachineSequencerCamera.Instruction

### Description
Represents a single entry in the instruction list of the BlendListCamera.

### Namespace
Unity.Cinemachine

### Assembly
Unity.Cinemachine.dll

### Syntax
```csharp
[Serializable]
public struct CinemachineSequencerCamera.Instruction
```

### Fields

#### Blend
How to blend to the next camera in the list (if any).

```csharp
[Tooltip("How to blend to the next camera in the list (if any)")]
[FormerlySerializedAs("m_Blend")]
public CinemachineBlendDefinition Blend;
```

**Field Value**

| Type | Description |
| --- | --- |
| CinemachineBlendDefinition | The blend definition. |

#### Camera
The camera to activate when this instruction becomes active.

```csharp
[Tooltip("The camera to activate when this instruction becomes active")]
[FormerlySerializedAs("m_VirtualCamera")]
public CinemachineVirtualCameraBase Camera;
```

**Field Value**

| Type | Description |
| --- | --- |
| CinemachineVirtualCameraBase | The camera to activate. |

#### Hold
How long to wait (in seconds) before activating the next camera in the list (if any).

```csharp
[Tooltip("How long to wait (in seconds) before activating the next camera in the list (if any)")]
[FormerlySerializedAs("m_Hold")]
public float Hold;
```

**Field Value**

| Type | Description |
| --- | --- |
| float | The hold duration in seconds. |

### Methods

#### Validate()
Clamps the settings to sensible values.

```csharp
public void Validate()
```
```

--------------------------------

### CinemachinePhysicalLensPalette.Preset.PhysicalProperties

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.Editor.CinemachinePhysicalLensPalette.Preset.html

Gets or sets the physical lens settings.

```APIDOC
## Field: PhysicalProperties

### Description
Physical lens settings.

### Declaration
```csharp
[Tooltip("Physical lens settings")]
public LensSettings.PhysicalSettings PhysicalProperties;
```

### Field Value
- **Type**: `LensSettings.PhysicalSettings`
- **Description**: The physical lens settings.
```

--------------------------------

### GetComponentOwner()

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineVirtualCamera.html

Gets the hidden CinemachinePipeline child object.

```APIDOC
## GetComponentOwner()

### Description
Gets the hidden CinemachinePipeline child object.

### Method
GetComponentOwner()

### Declaration
```
public Transform GetComponentOwner()
```

### Returns
- **Transform** - The hidden CinemachinePipeline child object

```

--------------------------------

### BeforePipeline(CinemachineVirtualCameraBase, ref CameraState, float, float)

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineFreeLookModifier.DistanceModifier.html

Called from extension's PrePipelineMutateCameraState(). Perform any necessary actions to modify relevant camera settings. Original camera settings should be restored in AfterPipeline.

```APIDOC
## BeforePipeline(CinemachineVirtualCameraBase, ref CameraState, float, float)

### Description
Called from extension's PrePipelineMutateCameraState(). Perform any necessary actions to modify relevant camera settings. Original camera settings should be restored in AfterPipeline(CinemachineVirtualCameraBase, ref CameraState, float, float).

### Declaration
csharp
public override void BeforePipeline(CinemachineVirtualCameraBase vcam, ref CameraState state, float deltaTime, float modifierValue)


### Parameters
- **vcam** (CinemachineVirtualCameraBase) - vcam owner
- **state** (CameraState) - current vcam state. May be modified in this function
- **deltaTime** (float) - current applicable deltaTime
- **modifierValue** (float) - The normalized value of the modifier variable. This is the FreeLook's vertical axis. Ranges from -1 to 1, where 0 is center rig.

### Overrides
CinemachineFreeLookModifier.Modifier.BeforePipeline(CinemachineVirtualCameraBase, ref CameraState, float, float)
```

--------------------------------

### GetMixer()

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineMixerEventsBase.html

Gets the object being monitored, which is the source of the events.

```APIDOC
## GetMixer()

### Description
Gets the object being monitored. This is the object that will generate the events.

### Declaration
```csharp
protected abstract ICinemachineMixer GetMixer()
```

### Returns
| Type | Description |
| --- | --- |
| ICinemachineMixer | The ICinemachineMixer object that is the origin of the events. |

```

--------------------------------

### BeforePipeline(CinemachineVirtualCameraBase, ref CameraState, float, float)

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineFreeLookModifier.Modifier.html

Called from extension's PrePipelineMutateCameraState(). Perform any necessary actions to modify relevant camera settings. Original camera settings should be restored in AfterPipeline.

```APIDOC
## BeforePipeline(CinemachineVirtualCameraBase, ref CameraState, float, float)

### Description
Called from extension's PrePipelineMutateCameraState(). Perform any necessary actions to modify relevant camera settings. Original camera settings should be restored in AfterPipeline.

### Method
BeforePipeline

### Parameters
- **vcam** (CinemachineVirtualCameraBase) - vcam owner
- **state** (CameraState) - current vcam state. May be modified in this function
- **deltaTime** (float) - current applicable deltaTime
- **modifierValue** (float) - The normalized value of the modifier variable. This is the FreeLook's vertical axis. Ranges from -1 to 1, where 0 is center rig.

### Declaration
```
public virtual void BeforePipeline(CinemachineVirtualCameraBase vcam, ref CameraState state, float deltaTime, float modifierValue)
```
```

--------------------------------

### BeforePipeline(CinemachineVirtualCameraBase, ref CameraState, float, float)

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineFreeLookModifier.CompositionModifier.html

Called from extension's PrePipelineMutateCameraState(). Perform any necessary actions to modify relevant camera settings. Original camera settings should be restored in AfterPipeline.

```APIDOC
## BeforePipeline(CinemachineVirtualCameraBase, ref CameraState, float, float)

### Description
Called from extension's PrePipelineMutateCameraState(). Perform any necessary actions to modify relevant camera settings. Original camera settings should be restored in AfterPipeline(CinemachineVirtualCameraBase, ref CameraState, float, float).

### Method
BeforePipeline

### Parameters
- **vcam** (CinemachineVirtualCameraBase) - Required - vcam owner
- **state** (CameraState) - Required - current vcam state. May be modified in this function
- **deltaTime** (float) - Required - current applicable deltaTime
- **modifierValue** (float) - Required - The normalized value of the modifier variable. This is the FreeLook's vertical axis. Ranges from -1 to 1, where 0 is center rig.

### Overrides
CinemachineFreeLookModifier.Modifier.BeforePipeline(CinemachineVirtualCameraBase, ref CameraState, float, float)
```

--------------------------------

### CinemachineFreeLook.RigNames

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineFreeLook.html

Gets the names of the 3 child rigs.

```APIDOC
## Property: RigNames

### Description
Gets the names of the 3 child rigs.

### Declaration
```csharp
public static string[] RigNames { get; }
```

### Property Value
| Type | Description |
|------|-------------|
| string[] | An array of rig names. |
```

--------------------------------

### ToLensSettings()

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.LegacyLensSettings.html

Converts the LegacyLensSettings object to a LensSettings representation.

```APIDOC
## ToLensSettings()

### Description
Converts this LegacyLensSettings object to a LensSettings representation.

### Method
ToLensSettings

### Returns
- **LensSettings** - Lens Settings representation of the LegacyLensSettings object

### Declaration
```csharp
public LensSettings ToLensSettings()
```
```

--------------------------------

### CinemachineCore.DeltaTime

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineCore.html

Gets the delta time, which can be overridden by UniformDeltaTimeOverride.

```APIDOC
## CinemachineCore.DeltaTime

### Description
Replacement for Time.deltaTime, taking UniformDeltaTimeOverride into account.

### Declaration
```csharp
public static float DeltaTime { get; }
```

### Property Value
| Type | Description |
|------|-------------|
| float | The delta time value. |
```

--------------------------------

### CinemachineCore.CurrentTime

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineCore.html

Gets the current time, which can be overridden by CurrentTimeTimeOverride.

```APIDOC
## CinemachineCore.CurrentTime

### Description
Replacement for Time.time, taking CurrentTimeTimeOverride into account.

### Declaration
```csharp
public static float CurrentTime { get; }
```

### Property Value
| Type | Description |
|------|-------------|
| float | The current time value. |
```

--------------------------------

### ActionSettings(ActionModes)

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineTriggerAction.ActionSettings.html

Standard constructor for ActionSettings that sets the action mode.

```APIDOC
## ActionSettings(ActionModes)

### Description
Standard Constructor for ActionSettings.

### Declaration
```csharp
public ActionSettings(CinemachineTriggerAction.ActionSettings.ActionModes action)
```

### Parameters
- **action** (CinemachineTriggerAction.ActionSettings.ActionModes) - Action to set

```

--------------------------------

### CinemachineBrain.ActiveBrainCount

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineBrain.html

Gets the number of active CinemachineBrains in the Scene.

```APIDOC
## CinemachineBrain.ActiveBrainCount

### Description
Access the array of active CinemachineBrains in the Scene.

### Declaration
```csharp
public static int ActiveBrainCount { get; }
```

### Property Value
| Type | Description |
| --- | --- |
| int | The number of active CinemachineBrains in the Scene. |
```

--------------------------------

### PostPipelineStageCallback(CinemachineVirtualCameraBase, CinemachineCore.Stage, ref CameraState, float)

Source: https://docs.unity3d.com/Packages/com.unity.cinemachine%403.1/api/Unity.Cinemachine.CinemachineCameraOffset.html

Documentation for the PostPipelineStageCallback method of the CinemachineCameraOffset class.

```APIDOC
## PostPipelineStageCallback(CinemachineVirtualCameraBase, CinemachineCore.Stage, ref CameraState, float)

### Description
Applies the specified offset to the camera state.

### Method
protected override void PostPipelineStageCallback(CinemachineVirtualCameraBase vcam, CinemachineCore.Stage stage, ref CameraState state, float deltaTime)

### Parameters
- **vcam** (CinemachineVirtualCameraBase) - The virtual camera being processed.
- **stage** (CinemachineCore.Stage) - The current pipeline stage.
- **state** (CameraState) - The current virtual camera state.
- **deltaTime** (float) - The current applicable deltaTime.

### Overrides
CinemachineExtension.PostPipelineStageCallback(CinemachineVirtualCameraBase, CinemachineCore.Stage, ref CameraState, float)
```
Tokens:
Raw