CinemachineTargetGroup Class

Cinemachine

CinemachineTargetGroup Class

Defines a group of target objects, each with a radius and a weight. The weight is used when calculating the average position of the target group. Higher-weighted members of the group will count more. The bounding box is calculated by taking the member positions, weight, and radii into account.
Inheritance Hierarchy
SystemObject  Object
    Component
      Behaviour
        MonoBehaviour
          CinemachineCinemachineTargetGroup

Namespace:  Cinemachine
Assembly:  Cinemachine (in Cinemachine.dll) Version: 2.0.0.0 (2.0.0.0)
Syntax
[DocumentationSortingAttribute(19f, DocumentationSortingAttributeLevel.UserRef)]
[AddComponentMenu("Cinemachine/CinemachineTargetGroup")]
[SaveDuringPlayAttribute]
[ExecuteInEditMode]
public class CinemachineTargetGroup : MonoBehaviour
Cinemachine.CinemachineTargetGroup = function();

Type.createClass(
	'Cinemachine.CinemachineTargetGroup',
	UnityEngine.MonoBehaviour);

The CinemachineTargetGroup type exposes the following members.

Constructors
  NameDescription
Public methodCinemachineTargetGroup
Top
Properties
  NameDescription
Public propertyBoundingBox
The axis-aligned bounding box of the group, computed using the targets positions and radii
Public propertyIsEmpty
Return true if there are no members with weight > 0
Top
Methods
  NameDescription
Public methodGetViewSpaceBoundingBox
The axis-aligned bounding box of the group, in a specific reference frame
Top
Fields
  NameDescription
Public fieldm_PositionMode
How the group's position is calculated
Public fieldm_RotationMode
How the group's orientation is calculated
Public fieldm_Targets
The target objects, together with their weights and radii, that will contribute to the group's average position, orientation, and size
Public fieldm_UpdateMethod
When to update the group's transform based on the position of the group members
Top
See Also