Skip to content

Commit 076445b

Browse files
committed
Merge pull request godotengine#111459 from paul-marechal/mesh_data_tool_tangent_doc
Add note for some usages of Plane in APIs
2 parents bb63baa + 509cf61 commit 076445b

File tree

3 files changed

+3
-0
lines changed

3 files changed

+3
-0
lines changed

doc/classes/ImmediateMesh.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@
8383
<param index="0" name="tangent" type="Plane" />
8484
<description>
8585
Set the tangent attribute that will be pushed with the next vertex.
86+
[b]Note:[/b] Even though [param tangent] is a [Plane], it does not directly represent the tangent plane. Its [member Plane.x], [member Plane.y], and [member Plane.z] represent the tangent vector and [member Plane.d] should be either [code]-1[/code] or [code]1[/code]. See also [constant Mesh.ARRAY_TANGENT].
8687
</description>
8788
</method>
8889
<method name="surface_set_uv">

doc/classes/MeshDataTool.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -318,6 +318,7 @@
318318
<param index="1" name="tangent" type="Plane" />
319319
<description>
320320
Sets the tangent of the given vertex.
321+
[b]Note:[/b] Even though [param tangent] is a [Plane], it does not directly represent the tangent plane. Its [member Plane.x], [member Plane.y], and [member Plane.z] represent the tangent vector and [member Plane.d] should be either [code]-1[/code] or [code]1[/code]. See also [constant Mesh.ARRAY_TANGENT].
321322
</description>
322323
</method>
323324
<method name="set_vertex_uv">

doc/classes/SurfaceTool.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,7 @@
258258
<param index="0" name="tangent" type="Plane" />
259259
<description>
260260
Specifies a tangent to use for the [i]next[/i] vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all.
261+
[b]Note:[/b] Even though [param tangent] is a [Plane], it does not directly represent the tangent plane. Its [member Plane.x], [member Plane.y], and [member Plane.z] represent the tangent vector and [member Plane.d] should be either [code]-1[/code] or [code]1[/code]. See also [constant Mesh.ARRAY_TANGENT].
261262
</description>
262263
</method>
263264
<method name="set_uv">

0 commit comments

Comments
 (0)