Struct AnyHitCollector<T>
A collector which exits the query as soon as any hit is detected.
Implements
ICollector<T>
Inherited Members
Namespace: Unity.Physics
Assembly: Unity.Physics.dll
Syntax
public struct AnyHitCollector<T> : ICollector<T> where T : struct, IQueryResult
Type Parameters
Name | Description |
---|---|
T | Generic type parameter. |
Constructors
AnyHitCollector(float)
Constructor.
Declaration
public AnyHitCollector(float maxFraction)
Parameters
Type | Name | Description |
---|---|---|
float | maxFraction | The maximum fraction. |
Properties
EarlyOutOnFirstHit
Gets a value indicating whether the early out on first hit.
Declaration
public bool EarlyOutOnFirstHit { get; }
Property Value
Type | Description |
---|---|
bool | True. |
MaxFraction
Gets the maximum fraction.
Declaration
public readonly float MaxFraction { get; }
Property Value
Type | Description |
---|---|
float | The maximum fraction. |
NumHits
Gets the number of hits.
Declaration
public int NumHits { get; }
Property Value
Type | Description |
---|---|
int | The total number of hits. |
Methods
AddHit(T)
Adds a hit.
Declaration
public bool AddHit(T hit)
Parameters
Type | Name | Description |
---|---|---|
T | hit | The hit. |
Returns
Type | Description |
---|---|
bool | True. |