Interface ICollector<T>
Interface for collecting hits during a collision query.
Namespace: Unity.Physics
Assembly: Unity.Physics.dll
Syntax
public interface ICollector<T> where T : struct, IQueryResultType Parameters
| Name | Description |
|---|---|
| T | Generic type parameter. |
Properties
EarlyOutOnFirstHit
Whether to exit the query as soon as any hit has been accepted.
Declaration
bool EarlyOutOnFirstHit { get; }Property Value
| Type | Description |
|---|---|
| bool | True if early out on first hit, false if not. |
MaxFraction
The maximum fraction of the query within which to check for hits For casts, this is a fraction along the ray For distance queries, this is a distance from the query object.
Declaration
float MaxFraction { get; }Property Value
| Type | Description |
|---|---|
| float | The maximum fraction. |
NumHits
The number of hits that have been collected.
Declaration
int NumHits { get; }Property Value
| Type | Description |
|---|---|
| int | The total number of hits. |
Methods
AddHit(T)
Called when the query hits something.
Declaration
bool AddHit(T hit)Parameters
| Type | Name | Description |
|---|---|---|
| T | hit | The hit. |
Returns
| Type | Description |
|---|---|
| bool | True to accept the hit, or false to ignore it. |