CinemachineGroupComposer Class

Cinemachine

previous page next page

Cinemachine

CinemachineGroupComposer Class

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 Hierarchy

SystemObject  Object
    Component
      Behaviour
        MonoBehaviour
          CinemachineCinemachineComponentBase
            CinemachineCinemachineComposer
              CinemachineCinemachineGroupComposer

Namespace: Cinemachine
Assembly: Cinemachine (in Cinemachine.dll) Version: 2.0.0.0 (2.0.0.0)

Syntax

JavaScript

Copy

[DocumentationSortingAttribute(4f, DocumentationSortingAttributeLevel.UserRef)]
[ExecuteInEditMode]
[AddComponentMenu("")]
[RequireComponent(typeof(CinemachinePipeline))]
[SaveDuringPlayAttribute]
public class CinemachineGroupComposer : CinemachineComposer

Cinemachine.CinemachineGroupComposer = function();

Type.createClass(
	'Cinemachine.CinemachineGroupComposer',
	Cinemachine.CinemachineComposer);

The CinemachineGroupComposer type exposes the following members.

Constructors

	Name	Description
	CinemachineGroupComposer

Top

Properties

	Name	Description
	FollowTarget	Returns the owner vcam's Follow target. (Inherited from CinemachineComponentBase.)
	HardGuideRect	Internal API for the inspector editor (Inherited from CinemachineComposer.)
	IsValid	True if component is enabled and has a LookAt defined (Inherited from CinemachineComposer.)
	LookAtTarget	Returns the owner vcam's LookAt target. (Inherited from CinemachineComponentBase.)
	m_LastBounds	For editor visulaization of the calculated bounding box of the group
	m_lastBoundsMatrix	For editor visualization of the calculated bounding box of the group
	SoftGuideRect	Internal API for the inspector editor (Inherited from CinemachineComposer.)
	Stage	Get the Cinemachine Pipeline stage that this component implements. Always returns the Aim stage (Inherited from CinemachineComposer.)
	TargetGroup	Get LookAt target as CinemachineTargetGroup, or null if target is not a group
	VcamState	Returns the owner vcam's CameraState. (Inherited from CinemachineComponentBase.)
	VirtualCamera	Get the associated CinemachineVirtualCameraBase (Inherited from CinemachineComponentBase.)

Top

Methods

	Name	Description
	GetTrackedPoint	Apply the target offsets to the target location. (Inherited from CinemachineComposer.)
	MutateCameraState	Applies the composer rules and orients the camera accordingly (Overrides CinemachineComposerMutateCameraState(CameraState, Single).)
	OnPositionDragged	API for the editor, to process a position drag from the user. Base class implementation does nothing. (Inherited from CinemachineComponentBase.)

Top

Fields

	Name	Description
	m_AdjustmentMode	How to adjust the camera to get the desired framing
	m_BiasX	A non-zero bias will move the targt position away from the center of the soft zone (Inherited from CinemachineComposer.)
	m_BiasY	A non-zero bias will move the targt position away from the center of the soft zone (Inherited from CinemachineComposer.)
	m_DeadZoneHeight	Camera will not rotate vertically if the target is within this range of the position (Inherited from CinemachineComposer.)
	m_DeadZoneWidth	Camera will not rotate horizontally if the target is within this range of the position (Inherited from CinemachineComposer.)
	m_FrameDamping	How aggressively the camera tries to frame the group. Small numbers are more responsive
	m_FramingMode	What screen dimensions to consider when framing
	m_GroupFramingSize	How much of the screen to fill with the bounding box of the targets.
	m_HorizontalDamping	How aggressively the camera tries to follow the target in the screen-horizontal direction. Small numbers are more responsive, rapidly orienting the camera to keep the target in the dead zone. Larger numbers give a more heavy slowly responding camera. Using different vertical and horizontal settings can yield a wide range of camera behaviors. (Inherited from CinemachineComposer.)
	m_LookaheadSmoothing	Controls the smoothness of the lookahead algorithm. Larger values smooth out jittery predictions and also increase prediction lag (Inherited from CinemachineComposer.)
	m_LookaheadTime	This setting will instruct the composer to adjust its target offset based on the motion of the target. The composer will look at a point where it estimates the target will be this many seconds into the future. Note that this setting is sensitive to noisy animation, and can amplify the noise, resulting in undesirable camera jitter. If the camera jitters unacceptably when the target is in motion, turn down this setting, or animate the target more smoothly. (Inherited from CinemachineComposer.)
	m_MaxDollyIn	How much closer to the target can the camera go?
	m_MaxDollyOut	How much farther from the target can the camera go?
	m_MaximumDistance	Set this to limit how far from the taregt the camera can get
	m_MaximumFOV	If adjusting FOV, will not set the FOV higher than this
	m_MaximumOrthoSize	If adjusting Orthographic Size, will not set it higher than this
	m_MinimumDistance	Set this to limit how close to the target the camera can get
	m_MinimumFOV	If adjusting FOV, will not set the FOV lower than this
	m_MinimumOrthoSize	If adjusting Orthographic Size, will not set it lower than this
	m_ScreenX	Horizontal screen position for target. The camera will rotate to the position the tracked object here (Inherited from CinemachineComposer.)
	m_ScreenY	Vertical screen position for target, The camera will rotate to to position the tracked object here (Inherited from CinemachineComposer.)
	m_SoftZoneHeight	When target is within this region, camera will gradually move to re-align towards the desired position, depending onm the damping speed (Inherited from CinemachineComposer.)
	m_SoftZoneWidth	When target is within this region, camera will gradually move to re-align towards the desired position, depending onm the damping speed (Inherited from CinemachineComposer.)
	m_TrackedObjectOffset	Target offset from the object's center in LOCAL space which the Composer tracks. Use this to fine-tune the tracking target position when the desired area is not in the tracked object's center (Inherited from CinemachineComposer.)
	m_VerticalDamping	How aggressively the camera tries to follow the target in the screen-vertical direction. Small numbers are more responsive, rapidly orienting the camera to keep the target in the dead zone. Larger numbers give a more heavy slowly responding camera. Using different vertical and horizontal settings can yield a wide range of camera behaviors. (Inherited from CinemachineComposer.)
	OnGUICallback	Used by the Inspector Editor to display on-screen guides. (Inherited from CinemachineComposer.)

Top

Reference

Cinemachine Namespace

Visit the Cinemachine Forum

https://unity3d.com/legal/terms-of-service

previous page start next page