Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

HandleUtility.FindNearestVertex

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

Submission failed

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

Close

Cancel

Declaration

public static bool FindNearestVertex(Vector2 guiPoint, out Vector3 vertex);

Declaration

public static bool FindNearestVertex(Vector2 guiPoint, Transform[] objectsToSearch, out Vector3 vertex);

Declaration

public static bool FindNearestVertex(Vector2 guiPoint, Transform[] objectsToSearch, Transform[] objectsToIgnore, out Vector3 vertex);

Declaration

public static bool FindNearestVertex(Vector2 guiPoint, out Vector3 vertex, out GameObject gameObject);

Declaration

public static bool FindNearestVertex(Vector2 guiPoint, Transform[] objectsToSearch, out Vector3 vertex, out GameObject gameObject);

Declaration

public static bool FindNearestVertex(Vector2 guiPoint, Transform[] objectsToSearch, Transform[] objectsToIgnore, out Vector3 vertex, out GameObject gameObject);

Parameters

guiPoint A point in GUI space.
vertex The nearest vertex position to guiPoint, or a default value if no vertex is within the minimum picking distance.
objectsToSearch An array of Transform to consider when picking the nearest vertex. If null, all active objects in open scenes are considered.
objectsToIgnore An array of Transform to exclude from consideration when picking nearest vertex.
gameObject The GameObject that contains the nearest vertex found by this function. Null if no vertex was found.

Returns

bool Returns true if a vertex within 50 pixels of the guiPoint was found, false if no vertex found within the minimum picking radius.

Description

Returns the nearest vertex to a guiPoint within a maximum radius of 50 pixels.