LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

CullingGroup.QueryIndices

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public function QueryIndices(visible: bool, result: int[], firstIndex: int): int;
public int QueryIndices(bool visible, int[] result, int firstIndex);
public function QueryIndices(distanceIndex: int, result: int[], firstIndex: int): int;
public int QueryIndices(int distanceIndex, int[] result, int firstIndex);
public function QueryIndices(visible: bool, distanceIndex: int, result: int[], firstIndex: int): int;
public int QueryIndices(bool visible, int distanceIndex, int[] result, int firstIndex);

Parameters

visible True if only visible spheres should be retrieved; false if only invisible spheres should be retrieved.
distanceIndex The distance band that retrieved spheres must be in.
result An array that will be filled with the retrieved sphere indices.
firstIndex The index of the sphere to begin searching at.

Returns

int The number of sphere indices found and written into the result array.

Description

Retrieve the indices of spheres that have particular visibility and/or distance states.

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.

Copyright © 2015 Unity Technologies
Learn Community Asset Store Buy Download