Version: 2017.3 (switch to 2017.4)
LanguageEnglish
  • C#
  • JS

Script language

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

GeometryUtility.TryCreatePlaneFromPolygon

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

public static method TryCreatePlaneFromPolygon(vertices: Vector3[], out plane: Plane): bool;
public static bool TryCreatePlaneFromPolygon(Vector3[] vertices, out Plane plane);

Parameters

vertices An array of vertex positions that define the shape of a polygon.
plane If successful, a valid plane that goes through all the vertices.

Returns

bool Returns true on success, false if the algorithm failed to create a plane from the given vertices.

Description

Creates a plane from a given list of vertices. Works for concave polygons and polygons that have multiple aligned vertices.

Does not work for self intersecting polygons since the direction of the plane would be ambigious. Must have at least 3 vertices and non zero area to work.

Did you find this page useful? Please give it a rating: