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

Object

CinemachineExtension

CinemachineConfiner

Inherited Members

CinemachineExtension.Epsilon

CinemachineExtension.VirtualCamera

CinemachineExtension.Awake()

CinemachineExtension.OnEnable()

CinemachineExtension.OnDestroy()

CinemachineExtension.PrePipelineMutateCameraStateCallback(CinemachineVirtualCameraBase, CameraState, Single)

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

CinemachineExtension.OnTargetObjectWarped(Transform, Vector3)

CinemachineExtension.ForceCameraPosition(Vector3, Quaternion)

CinemachineExtension.OnTransitionFromCamera(ICinemachineCamera, Vector3, Single)

CinemachineExtension.GetExtraState<T>(ICinemachineCamera)

CinemachineExtension.GetAllExtraStates<T>()

Namespace: Cinemachine

Syntax

public class CinemachineConfiner : CinemachineExtension

Fields

m_BoundingShape2D

The 2D shape within which the camera is to be contained.

Declaration

public Collider2D m_BoundingShape2D

Field Value

Type	Description
Collider2D

m_BoundingVolume

The volume within which the camera is to be contained.

Declaration

public Collider m_BoundingVolume

Field Value

Type	Description
Collider

m_ConfineMode

The confiner can operate using a 2D bounding shape or a 3D bounding volume

Declaration

public CinemachineConfiner.Mode m_ConfineMode

Field Value

Type	Description
CinemachineConfiner.Mode

m_ConfineScreenEdges

If camera is orthographic, screen edges will be confined to the volume.

Declaration

public bool m_ConfineScreenEdges

Field Value

Type	Description
Boolean

m_Damping

How gradually to return the camera to the bounding volume if it goes beyond the borders

Declaration

public float m_Damping

Field Value

Type	Description
Single

Properties

IsValid

Check if the bounding volume is defined

Declaration

public bool IsValid { get; }

Property Value

Type	Description
Boolean

Methods

CameraWasDisplaced(CinemachineVirtualCameraBase)

See whether the virtual camera has been moved by the confiner

Declaration

public bool CameraWasDisplaced(CinemachineVirtualCameraBase vcam)

Parameters

Type	Name	Description
CinemachineVirtualCameraBase	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
Boolean	True if the virtual camera has been repositioned

ConnectToVcam(Boolean)

Called when connecting to a virtual camera

Declaration

protected override void ConnectToVcam(bool connect)

Parameters

Type	Name	Description
Boolean	connect	True if connecting, false if disconnecting

Overrides

CinemachineExtension.ConnectToVcam(Boolean)

GetCameraDisplacementDistance(CinemachineVirtualCameraBase)

See how far virtual camera has been moved by the confiner

Declaration

public float GetCameraDisplacementDistance(CinemachineVirtualCameraBase vcam)

Parameters

Type	Name	Description
CinemachineVirtualCameraBase	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
Single	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
Single	Highest damping setting in this component

Overrides

CinemachineExtension.GetMaxDampTime()

InvalidatePathCache()

Call this if the bounding shape's points change at runtime

Declaration

public void InvalidatePathCache()

PostPipelineStageCallback(CinemachineVirtualCameraBase, CinemachineCore.Stage, ref CameraState, Single)

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
CinemachineVirtualCameraBase	vcam	The virtual camera being processed
CinemachineCore.Stage	stage	The current pipeline stage
CameraState	state	The current virtual camera state
Single	deltaTime	The current applicable deltaTime

Overrides

CinemachineExtension.PostPipelineStageCallback(CinemachineVirtualCameraBase, CinemachineCore.Stage, ref CameraState, Single)