Class CinemachineGroupComposer

This is a CinemachineComponent in the Aim section of the component pipeline. Its job is to aim the camera at a target object, with configurable offsets, damping, and composition rules.

In addition, if the target is a CinemachineTargetGroup, the behaviour will adjust the FOV and the camera distance to ensure that the entire group of targets is framed properly.

Inheritance
MonoBehaviour
CinemachineComponentBase
CinemachineComposer
CinemachineGroupComposer
Inherited Members
Namespace: Cinemachine
Syntax
[DocumentationSorting(DocumentationSortingAttribute.Level.UserRef)]
public class CinemachineGroupComposer : CinemachineComposer

Fields

m_AdjustmentMode

How to adjust the camera to get the desired framing

Declaration
public CinemachineGroupComposer.AdjustmentMode m_AdjustmentMode
Field Value
Type Description
CinemachineGroupComposer.AdjustmentMode

m_FrameDamping

How aggressively the camera tries to frame the group. Small numbers are more responsive

Declaration
public float m_FrameDamping
Field Value
Type Description
System.Single

m_FramingMode

What screen dimensions to consider when framing

Declaration
public CinemachineGroupComposer.FramingMode m_FramingMode
Field Value
Type Description
CinemachineGroupComposer.FramingMode

m_GroupFramingSize

How much of the screen to fill with the bounding box of the targets.

Declaration
public float m_GroupFramingSize
Field Value
Type Description
System.Single

m_MaxDollyIn

How much closer to the target can the camera go?

Declaration
public float m_MaxDollyIn
Field Value
Type Description
System.Single

m_MaxDollyOut

How much farther from the target can the camera go?

Declaration
public float m_MaxDollyOut
Field Value
Type Description
System.Single

m_MaximumDistance

Set this to limit how far from the taregt the camera can get

Declaration
public float m_MaximumDistance
Field Value
Type Description
System.Single

m_MaximumFOV

If adjusting FOV, will not set the FOV higher than this

Declaration
public float m_MaximumFOV
Field Value
Type Description
System.Single

m_MaximumOrthoSize

If adjusting Orthographic Size, will not set it higher than this

Declaration
public float m_MaximumOrthoSize
Field Value
Type Description
System.Single

m_MinimumDistance

Set this to limit how close to the target the camera can get

Declaration
public float m_MinimumDistance
Field Value
Type Description
System.Single

m_MinimumFOV

If adjusting FOV, will not set the FOV lower than this

Declaration
public float m_MinimumFOV
Field Value
Type Description
System.Single

m_MinimumOrthoSize

If adjusting Orthographic Size, will not set it lower than this

Declaration
public float m_MinimumOrthoSize
Field Value
Type Description
System.Single

Properties

m_LastBounds

For editor visulaization of the calculated bounding box of the group

Declaration
public Bounds m_LastBounds { get; }
Property Value
Type Description
Bounds

m_lastBoundsMatrix

For editor visualization of the calculated bounding box of the group

Declaration
public Matrix4x4 m_lastBoundsMatrix { get; }
Property Value
Type Description
Matrix4x4

TargetGroup

Get LookAt target as CinemachineTargetGroup, or null if target is not a group

Declaration
public CinemachineTargetGroup TargetGroup { get; }
Property Value
Type Description
CinemachineTargetGroup

Methods

MutateCameraState(ref CameraState, Single)

Applies the composer rules and orients the camera accordingly

Declaration
public override void MutateCameraState(ref CameraState curState, float deltaTime)
Parameters
Type Name Description
CameraState curState

The current camera state
System.Single deltaTime

Used for calculating damping. If less than zero, then target will snap to the center of the dead zone.
Overrides