Interface ICinemachineTargetGroup

Interface representing something that can be used as a vcam target.
It has a transform, a bounding box, and a bounding sphere.

Namespace: Unity.Cinemachine

Assembly: Unity.Cinemachine.dll

Syntax

public interface ICinemachineTargetGroup

Properties

BoundingBox

The axis-aligned bounding box of the group, computed using the targets positions and radii

Declaration

Bounds BoundingBox { get; }

Property Value

Type	Description
Bounds

IsEmpty

Returns true if the group has no non-zero-weight members

Declaration

bool IsEmpty { get; }

Property Value

Type	Description
bool

IsValid

Returns true if object has not been deleted.

Declaration

bool IsValid { get; }

Property Value

Type	Description
bool

Sphere

The bounding sphere of the group, computed using the targets positions and radii

Declaration

BoundingSphere Sphere { get; }

Property Value

Type	Description
BoundingSphere

Transform

Get the MonoBehaviour's Transform

Declaration

Transform Transform { get; }

Property Value

Type	Description
Transform

Methods

GetViewSpaceAngularBounds(Matrix4x4, out Vector2, out Vector2, out Vector2)

Get the local-space angular bounds of the group, from a specific point of view. Also returns the z depth range of the members. Members behind the observer (negative z) will be ignored.

Declaration

void GetViewSpaceAngularBounds(Matrix4x4 observer, out Vector2 minAngles, out Vector2 maxAngles, out Vector2 zRange)

Parameters

Type	Name	Description
Matrix4x4	observer	Point of view from which to calculate, and in whose space the return values are
Vector2	minAngles	The lower bound of the screen angles of the members (degrees)
Vector2	maxAngles	The upper bound of the screen angles of the members (degrees)
Vector2	zRange	The min and max depth values of the members, relative to the observer

GetViewSpaceBoundingBox(Matrix4x4, bool)

The axis-aligned bounding box of the group, in a specific reference frame

Declaration

Bounds GetViewSpaceBoundingBox(Matrix4x4 observer, bool includeBehind)

Parameters

Type	Name	Description
Matrix4x4	observer	The frame of reference in which to compute the bounding box
bool	includeBehind	If true, members behind the observer (negative z) will be included

Returns

Type	Description
Bounds	The axis-aligned bounding box of the group, in the desired frame of reference