diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2023-01-16 09:20:30 +0100 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2023-01-16 09:20:30 +0100 |
| commit | 88c81bfbe55f927d45c1d4cef19396621f9c69f5 (patch) | |
| tree | c43f17c08abb20a6764e01a51b1788d41087a00e /doc | |
| parent | 94312ab9439b7493d7bfa46247917a9192aa94e8 (diff) | |
| parent | 7a19c87c7e2e0590f34a12214739d0c4588c31eb (diff) | |
Merge pull request #71456 from raulsntos/dotnet/sync-plane
C#: Sync `Plane` with Core
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/Plane.xml | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/classes/Plane.xml b/doc/classes/Plane.xml index 2d4910916b..aa09081e3e 100644 --- a/doc/classes/Plane.xml +++ b/doc/classes/Plane.xml @@ -38,6 +38,7 @@ <param index="0" name="normal" type="Vector3" /> <description> Creates a plane from the normal vector. The plane will intersect the origin. + The [param normal] of the plane must be a unit vector. </description> </constructor> <constructor name="Plane"> @@ -46,6 +47,7 @@ <param index="1" name="d" type="float" /> <description> Creates a plane from the normal vector and the plane's distance from the origin. + The [param normal] of the plane must be a unit vector. </description> </constructor> <constructor name="Plane"> @@ -54,6 +56,7 @@ <param index="1" name="point" type="Vector3" /> <description> Creates a plane from the normal vector and a point on the plane. + The [param normal] of the plane must be a unit vector. </description> </constructor> <constructor name="Plane"> @@ -152,7 +155,7 @@ In the scalar equation of the plane [code]ax + by + cz = d[/code], this is [code]d[/code], while the [code](a, b, c)[/code] coordinates are represented by the [member normal] property. </member> <member name="normal" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)"> - The normal of the plane, which must be normalized. + The normal of the plane, which must be a unit vector. In the scalar equation of the plane [code]ax + by + cz = d[/code], this is the vector [code](a, b, c)[/code], where [code]d[/code] is the [member d] property. </member> <member name="x" type="float" setter="" getter="" default="0.0"> |