Class CinemachineConfiner
An add-on module for Cinemachine Virtual Camera that post-processes the final position of the virtual camera. It will confine the virtual camera's position to the volume specified in the Bounding Volume field.
Inheritance
Inherited Members
Namespace: Cinemachine
Assembly: Cinemachine.dll
Syntax
[DocumentationSorting(DocumentationSortingAttribute.Level.UserRef)]
[AddComponentMenu("")]
[ExecuteAlways]
[DisallowMultipleComponent]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.cinemachine@2.9/manual/CinemachineConfiner.html")]
public class CinemachineConfiner : CinemachineExtensionFields
m_BoundingShape2D
The 2D shape within which the camera is to be contained.
Declaration
[Tooltip("The 2D shape within which the camera is to be contained")]
public Collider2D m_BoundingShape2DField Value
| Type | Description |
|---|---|
| Collider2D |
m_BoundingVolume
The volume within which the camera is to be contained.
Declaration
[Tooltip("The volume within which the camera is to be contained")]
public Collider m_BoundingVolumeField Value
| Type | Description |
|---|---|
| Collider |
m_ConfineMode
The confiner can operate using a 2D bounding shape or a 3D bounding volume
Declaration
[Tooltip("The confiner can operate using a 2D bounding shape or a 3D bounding volume")]
public CinemachineConfiner.Mode m_ConfineModeField Value
| Type | Description |
|---|---|
| Cinemachine |
m_ConfineScreenEdges
If camera is orthographic, screen edges will be confined to the volume.
Declaration
[Tooltip("If camera is orthographic, screen edges will be confined to the volume. If not checked, then only the camera center will be confined")]
public bool m_ConfineScreenEdgesField Value
| Type | Description |
|---|---|
| bool |
m_Damping
How gradually to return the camera to the bounding volume if it goes beyond the borders
Declaration
[Tooltip("How gradually to return the camera to the bounding volume if it goes beyond the borders. Higher numbers are more gradual.")]
[Range(0, 10)]
public float m_DampingField Value
| Type | Description |
|---|---|
| float |
Properties
IsValid
Check if the bounding volume is defined
Declaration
public bool IsValid { get; }Property Value
| Type | Description |
|---|---|
| bool |
Methods
CameraWasDisplaced(CinemachineVirtualCameraBase)
See whether the virtual camera has been moved by the confiner
Declaration
public bool CameraWasDisplaced(CinemachineVirtualCameraBase vcam)Parameters
| Type | Name | Description |
|---|---|---|
| Cinemachine |
vcam | The virtual camera in question. This might be different from the virtual camera that owns the confiner, in the event that the camera has children |
Returns
| Type | Description |
|---|---|
| bool | True if the virtual camera has been repositioned |
ConnectToVcam(bool)
Called when connecting to a virtual camera
Declaration
protected override void ConnectToVcam(bool connect)Parameters
| Type | Name | Description |
|---|---|---|
| bool | connect | True if connecting, false if disconnecting |
Overrides
GetCameraDisplacementDistance(CinemachineVirtualCameraBase)
See how far virtual camera has been moved by the confiner
Declaration
public float GetCameraDisplacementDistance(CinemachineVirtualCameraBase vcam)Parameters
| Type | Name | Description |
|---|---|---|
| Cinemachine |
vcam | The virtual camera in question. This might be different from the virtual camera that owns the confiner, in the event that the camera has children |
Returns
| Type | Description |
|---|---|
| float | True if the virtual camera has been repositioned |
GetMaxDampTime()
Report maximum damping time needed for this component.
Declaration
public override float GetMaxDampTime()Returns
| Type | Description |
|---|---|
| float | Highest damping setting in this component |
Overrides
InvalidatePathCache()
Call this if the bounding shape's points change at runtime
Declaration
public void InvalidatePathCache()PostPipelineStageCallback(CinemachineVirtualCameraBase, Stage, ref CameraState, float)
Callback to do the camera confining
Declaration
protected override void PostPipelineStageCallback(CinemachineVirtualCameraBase vcam, CinemachineCore.Stage stage, ref CameraState state, float deltaTime)Parameters
| Type | Name | Description |
|---|---|---|
| Cinemachine |
vcam | The virtual camera being processed |
| Cinemachine |
stage | The current pipeline stage |
| Camera |
state | The current virtual camera state |
| float | deltaTime | The current applicable deltaTime |