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 ICinemachineTargetGroup, the behaviour will adjust the FOV and the camera distance to ensure that the entire group of targets is framed properly.
Inherited Members
Namespace: Cinemachine
Syntax
public class CinemachineGroupComposer : CinemachineComposerFields
m_AdjustmentMode
How to adjust the camera to get the desired framing
Declaration
public CinemachineGroupComposer.AdjustmentMode m_AdjustmentModeField 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_FrameDampingField Value
| Type | Description |
|---|---|
| Single |
m_FramingMode
What screen dimensions to consider when framing
Declaration
public CinemachineGroupComposer.FramingMode m_FramingModeField 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_GroupFramingSizeField Value
| Type | Description |
|---|---|
| Single |
m_MaxDollyIn
How much closer to the target can the camera go?
Declaration
public float m_MaxDollyInField Value
| Type | Description |
|---|---|
| Single |
m_MaxDollyOut
How much farther from the target can the camera go?
Declaration
public float m_MaxDollyOutField Value
| Type | Description |
|---|---|
| Single |
m_MaximumDistance
Set this to limit how far from the taregt the camera can get
Declaration
public float m_MaximumDistanceField Value
| Type | Description |
|---|---|
| Single |
m_MaximumFOV
If adjusting FOV, will not set the FOV higher than this
Declaration
public float m_MaximumFOVField Value
| Type | Description |
|---|---|
| Single |
m_MaximumOrthoSize
If adjusting Orthographic Size, will not set it higher than this
Declaration
public float m_MaximumOrthoSizeField Value
| Type | Description |
|---|---|
| Single |
m_MinimumDistance
Set this to limit how close to the target the camera can get
Declaration
public float m_MinimumDistanceField Value
| Type | Description |
|---|---|
| Single |
m_MinimumFOV
If adjusting FOV, will not set the FOV lower than this
Declaration
public float m_MinimumFOVField Value
| Type | Description |
|---|---|
| Single |
m_MinimumOrthoSize
If adjusting Orthographic Size, will not set it lower than this
Declaration
public float m_MinimumOrthoSizeField Value
| Type | Description |
|---|---|
| Single |
Properties
LastBounds
For editor visulaization of the calculated bounding box of the group
Declaration
public Bounds LastBounds { get; }Property Value
| Type | Description |
|---|---|
| Bounds |
LastBoundsMatrix
For editor visualization of the calculated bounding box of the group
Declaration
public Matrix4x4 LastBoundsMatrix { get; }Property Value
| Type | Description |
|---|---|
| Matrix4x4 |
Methods
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
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 |
| Single | deltaTime | Used for calculating damping. If less than zero, then target will snap to the center of the dead zone. |