QueryIndices
Retrieve the indices of spheres that have particular visibility and/or distance states.
Read time 3 minutesLast updated 6 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
QueryIndices(bool, int[], int)
Retrieve the indices of spheres that have particular visibility and/or distance states.
public int QueryIndices(bool visible, int[] result, int firstIndex)
Parameters
Returns
Type | Description |
|---|---|
| int | The number of sphere indices found and written into the result array. |
Remarks
Use the overload that corresponds to the state properties you are interested in. For example, if you want to retrieve visible spheres in any distance band, use the overload that takes a 'visible' parameter but does not have a 'distanceIndex' parameter.
The length of the result array is used to limit the number of spheres checked. If you provide a result array of length 20, and a firstIndex of 10, then the query will only examine spheres 10 through 30 to see if they meet the given visibility and/or distance constraints.
QueryIndices(int, int[], int)
Retrieve the indices of spheres that have particular visibility and/or distance states.
public int QueryIndices(int distanceIndex, int[] result, int firstIndex)
Parameters
Returns
Type | Description |
|---|---|
| int | The number of sphere indices found and written into the result array. |
Remarks
Use the overload that corresponds to the state properties you are interested in. For example, if you want to retrieve visible spheres in any distance band, use the overload that takes a 'visible' parameter but does not have a 'distanceIndex' parameter.
The length of the result array is used to limit the number of spheres checked. If you provide a result array of length 20, and a firstIndex of 10, then the query will only examine spheres 10 through 30 to see if they meet the given visibility and/or distance constraints.
QueryIndices(bool, int, int[], int)
Retrieve the indices of spheres that have particular visibility and/or distance states.
public int QueryIndices(bool visible, int distanceIndex, int[] result, int firstIndex)
Parameters
True if only visible spheres should be retrieved; false if only invisible spheres should be retrieved.
The distance band that retrieved spheres must be in.
An array that will be filled with the retrieved sphere indices.
The index of the sphere to begin searching at.
Returns
Type | Description |
|---|---|
| int | The number of sphere indices found and written into the result array. |
Remarks
Use the overload that corresponds to the state properties you are interested in. For example, if you want to retrieve visible spheres in any distance band, use the overload that takes a 'visible' parameter but does not have a 'distanceIndex' parameter.
The length of the result array is used to limit the number of spheres checked. If you provide a result array of length 20, and a firstIndex of 10, then the query will only examine spheres 10 through 30 to see if they meet the given visibility and/or distance constraints.