Merge pull request #111459 from paul-marechal/mesh_data_tool_tangent_doc

Add note for some usages of Plane in APIs
This commit is contained in:
Thaddeus Crews
2025-10-20 18:09:53 -05:00
3 changed files with 3 additions and 0 deletions

View File

@ -83,6 +83,7 @@
<param index="0" name="tangent" type="Plane" />
<description>
Set the tangent attribute that will be pushed with the next vertex.
[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].
</description>
</method>
<method name="surface_set_uv">

View File

@ -318,6 +318,7 @@
<param index="1" name="tangent" type="Plane" />
<description>
Sets the tangent of the given vertex.
[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].
</description>
</method>
<method name="set_vertex_uv">

View File

@ -258,6 +258,7 @@
<param index="0" name="tangent" type="Plane" />
<description>
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.
[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].
</description>
</method>
<method name="set_uv">