Skip to content

Commit 90f31d1

Browse files
committed
Rename simplex "cells" to "simplexes"
1 parent fda5623 commit 90f31d1

32 files changed

+422
-379
lines changed

addons/4d/doc_classes/ArrayTetraMesh4D.xml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -76,20 +76,20 @@
7676
</method>
7777
</methods>
7878
<members>
79-
<member name="cell_boundary_normals" type="PackedVector4Array" setter="set_cell_boundary_normals" getter="get_cell_boundary_normals" default="PackedVector4Array()">
80-
The normals of the tetrahedral cells. Boundary normals define which side of the cell is the front side, and therefore should be drawn. Boundary normals can also be used to calculate vertex normals to determine how lighting angles are calculated for the cell. Each Vector4 in this array is for one cell, and should be normalized. This array should either be one-fourth as long as the [member cell_indices] array, or empty for no normals, or else the mesh is invalid.
79+
<member name="simplex_cell_boundary_normals" type="PackedVector4Array" setter="set_simplex_cell_boundary_normals" getter="get_simplex_cell_boundary_normals" default="PackedVector4Array()">
80+
The normals of the tetrahedral cells. Boundary normals define which side of the cell is the front side, and therefore should be drawn. Boundary normals can also be used to calculate vertex normals to determine how lighting angles are calculated for the cell. Each Vector4 in this array is for one cell, and should be normalized. This array should either be one-fourth as long as the [member simplex_cell_indices] array, or empty for no normals, or else the mesh is invalid.
8181
</member>
82-
<member name="cell_indices" type="PackedInt32Array" setter="set_cell_indices" getter="get_cell_indices" default="PackedInt32Array()">
82+
<member name="simplex_cell_indices" type="PackedInt32Array" setter="set_simplex_cell_indices" getter="get_simplex_cell_indices" default="PackedInt32Array()">
8383
The indices of the tetrahedral cells. Every 4 integers defines a tetrahedral cell. Each integer is an index to the [member vertices] array. Integers in this array should not exceed the length of the vertices array, or else the mesh is invalid.
8484
</member>
85-
<member name="cell_uvw_map" type="PackedVector3Array" setter="set_cell_uvw_map" getter="get_cell_uvw_map" default="PackedVector3Array()">
86-
The UVW mapping of the tetrahedral cells. Each Vector3 in this array is the texture space mapping for the cell vertex in the [member cell_indices] array with the same index. This array should either be the same length as the [member cell_indices] array, or empty for no UVW mapping, or else the mesh is invalid.
85+
<member name="simplex_cell_texture_map" type="PackedVector3Array" setter="set_simplex_cell_texture_map" getter="get_simplex_cell_texture_map" default="PackedVector3Array()">
86+
The UVW texture mapping of the tetrahedral cells. Each Vector3 in this array is the texture space mapping for the cell vertex in the [member simplex_cell_indices] array with the same index. This array should either be the same length as the [member simplex_cell_indices] array, or empty for no UVW mapping, or else the mesh is invalid.
8787
</member>
88-
<member name="cell_vertex_normals" type="PackedVector4Array" setter="set_cell_vertex_normals" getter="get_cell_vertex_normals" default="PackedVector4Array()">
89-
The normals of the vertex indices of tetrahedral cells. Vertex normals define how lighting angles are calculated for the cell. Each Vector4 in this array is for one vertex instance in a tetrahedral cell, meaning 4 per cell, and each should be normalized. This array should either be the same length as the [member cell_indices] array, or empty for no normals, or else the mesh is invalid.
88+
<member name="simplex_cell_vertex_normals" type="PackedVector4Array" setter="set_simplex_cell_vertex_normals" getter="get_simplex_cell_vertex_normals" default="PackedVector4Array()">
89+
The normals of the vertex indices of tetrahedral cells. Vertex normals define how lighting angles are calculated for the cell. Each Vector4 in this array is for one vertex instance in a tetrahedral cell, meaning 4 per cell, and each should be normalized. This array should either be the same length as the [member simplex_cell_indices] array, or empty for no normals, or else the mesh is invalid.
9090
</member>
9191
<member name="vertices" type="PackedVector4Array" setter="set_vertices" getter="get_vertices" default="PackedVector4Array()">
92-
The vertices of the tetrahedral mesh. Each Vector4 in this array is a vertex defined as a position in meters in 4D space. The items in this array are referenced by the [member cell_indices] array.
92+
The vertices of the tetrahedral mesh. Each Vector4 in this array is a vertex defined as a position in meters in 4D space. The items in this array are referenced by the [member simplex_cell_indices] array.
9393
</member>
9494
</members>
9595
</class>

addons/4d/doc_classes/BoxPolyMesh4D.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
The half-extents of the box mesh in meters, also known as just "extents". This is the "radius" of the box. This is a wrapper around [member size] for situations where you want to use the extents instead of size. Since the box is centered at the origin, one vertex is located at the half-extents, and the rest have some of the components negated.
4444
</member>
4545
<member name="poly_texture_map" type="int" setter="set_poly_texture_map" getter="get_poly_texture_map" enum="BoxPolyMesh4D.BoxPolyTextureMap" default="0">
46-
The type of texture map used for the cell UVW texture space of the box mesh cells. This determines the cell UVW texture map returned by [method get_cell_uvw_map]. Different options have different impacts on texture density, visual intuitiveness, and texture bleeding. See [enum BoxPolyTextureMap] for possible values.
46+
The type of texture map used for the cell UVW texture space of the box mesh cells. This determines the cell UVW texture map returned by [method get_poly_cell_texture_map] and therefore [method get_simplex_cell_texture_map]. Different options have different impacts on texture density, visual intuitiveness, and texture bleeding. See [enum BoxPolyTextureMap] for possible values.
4747
</member>
4848
<member name="size" type="Vector4" setter="set_size" getter="get_size" default="Vector4(1, 1, 1, 1)">
4949
The size of the box mesh in meters. This is the "diameter" size of the box in 4D space, where each component is the size of the box in one of the 4 dimensions. This is the value that is stored internally.

addons/4d/doc_classes/BoxTetraMesh4D.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
</methods>
2828
<members>
2929
<member name="cell_texture_map" type="int" setter="set_cell_texture_map" getter="get_cell_texture_map" enum="BoxTetraMesh4D.BoxCellTextureMap" default="0">
30-
The type of texture map used for the cell UVW texture space of the box mesh cells. Along with [member tetra_decomp], this determines the cell UVW texture map returned by [method get_cell_uvw_map]. Different options have different impacts on texture density, visual intuitiveness, and texture bleeding. See [enum BoxCellTextureMap] for possible values.
30+
The type of texture map used for the cell UVW texture space of the box mesh cells. Along with [member tetra_decomp], this determines the cell UVW texture map returned by [method get_simplex_cell_texture_map]. Different options have different impacts on texture density, visual intuitiveness, and texture bleeding. See [enum BoxCellTextureMap] for possible values.
3131
</member>
3232
<member name="half_extents" type="Vector4" setter="set_half_extents" getter="get_half_extents">
3333
The half-extents of the box mesh in meters, also known as just "extents". This is the "radius" of the box. This is a wrapper around [member size] for situations where you want to use the extents instead of size. Since the box is centered at the origin, one vertex is located at the half-extents, and the rest have some of the components negated.

addons/4d/doc_classes/ConcaveMeshShape4D.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@
1919
</method>
2020
</methods>
2121
<members>
22-
<member name="cells" type="PackedVector4Array" setter="set_cells" getter="get_cells" default="PackedVector4Array()">
23-
The cells that define the concave mesh shape. Every vector defines the position of a vertex, and every 4 vertices defines a tetrahedral cell, similar to how in 3D every 3 vertices define a triangular face. The size of this array MUST be a multiple of 4. Unlike the data in a [TetraMesh4D], the vertices are not deduplicated, so if multiple cells share a vertex, the vertex is repeated in the array.
22+
<member name="simplex_cells" type="PackedVector4Array" setter="set_simplex_cells" getter="get_simplex_cells" default="PackedVector4Array()">
23+
The simplex cells that define the concave mesh shape. Every vector defines the position of a vertex, and every 4 vertices defines a tetrahedral simplex cell, similar to how in 3D every 3 vertices define a triangular simplex face. The size of this array MUST be a multiple of 4. Unlike the data in a [TetraMesh4D], the vertices are not deduplicated, so if multiple simplex cells share a vertex, the vertex is repeated in the array.
2424
</member>
2525
</members>
2626
</class>

addons/4d/doc_classes/G4MFBufferView4D.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
</method>
4545
</methods>
4646
<members>
47-
<member name="buffer_index" type="int" setter="set_buffer_index" getter="get_buffer_index" default="-1">
47+
<member name="buffer_index" type="int" setter="set_buffer_index" getter="get_buffer_index" default="0">
4848
The index of the buffer this buffer view points to. This is the index of the buffer in the G4MF buffers array.
4949
</member>
5050
<member name="byte_length" type="int" setter="set_byte_length" getter="get_byte_length" default="0">

addons/4d/doc_classes/G4MFMaterialChannel4D.xml

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -25,25 +25,25 @@
2525
Checks if the [G4MFMaterialChannel4D] is equal to another [G4MFMaterialChannel4D] exactly by checking if the properties are equal and all accessor indices refer to the same accessors. If a material channel refers to a different accessor, even if the data is the same, this will return [code]false[/code]. The name of the material channel is not checked, and any metadata is ignored.
2626
</description>
2727
</method>
28-
<method name="load_cell_colors" qualifiers="const">
28+
<method name="load_edge_colors" qualifiers="const">
2929
<return type="PackedColorArray" />
3030
<param index="0" name="g4mf_state" type="G4MFState4D" />
3131
<description>
32-
Loads the cell colors from the [G4MFAccessor4D] at [member cell_colors_accessor_index] in the [G4MFState4D]'s accessors array. This is a low-level function that will fail if the index does not refer to a valid [G4MFAccessor4D] or if the accessor does not contain valid color data.
32+
Loads the edge colors from the [G4MFAccessor4D] at [member per_edge_accessor_index] in the [G4MFState4D]'s accessors array. This is a low-level function that will fail if the index does not refer to a valid [G4MFAccessor4D] or if the accessor does not contain valid color data.
3333
</description>
3434
</method>
35-
<method name="load_edge_colors" qualifiers="const">
35+
<method name="load_simplex_colors" qualifiers="const">
3636
<return type="PackedColorArray" />
3737
<param index="0" name="g4mf_state" type="G4MFState4D" />
3838
<description>
39-
Loads the edge colors from the [G4MFAccessor4D] at [member edge_colors_accessor_index] in the [G4MFState4D]'s accessors array. This is a low-level function that will fail if the index does not refer to a valid [G4MFAccessor4D] or if the accessor does not contain valid color data.
39+
Loads the simplex cell colors from the [G4MFAccessor4D] at [member per_simplex_accessor_index] in the [G4MFState4D]'s accessors array. This is a low-level function that will fail if the index does not refer to a valid [G4MFAccessor4D] or if the accessor does not contain valid color data.
4040
</description>
4141
</method>
4242
<method name="load_vertex_colors" qualifiers="const">
4343
<return type="PackedColorArray" />
4444
<param index="0" name="g4mf_state" type="G4MFState4D" />
4545
<description>
46-
Loads the vertex colors from the [G4MFAccessor4D] at [member vertex_colors_accessor_index] in the [G4MFState4D]'s accessors array. This is a low-level function that will fail if the index does not refer to a valid [G4MFAccessor4D] or if the accessor does not contain valid color data.
46+
Loads the vertex colors from the [G4MFAccessor4D] at [member per_vertex_accessor_index] in the [G4MFState4D]'s accessors array. This is a low-level function that will fail if the index does not refer to a valid [G4MFAccessor4D] or if the accessor does not contain valid color data.
4747
</description>
4848
</method>
4949
<method name="to_dictionary" qualifiers="const">
@@ -54,26 +54,30 @@
5454
</method>
5555
</methods>
5656
<members>
57-
<member name="cell_texture_index" type="int" setter="set_cell_texture_index" getter="get_cell_texture_index" default="-1">
58-
The index of the [G4MFTexture4D] in the [G4MFState4D]'s textures array that contains the texture for this surface. This is per-component multiplied with the [member single_color] and the cell colors to get the final color of the cells. If not defined, the surface does not have a texture.
59-
[b]Note:[/b] This property is currently not used when generating a [Material4D] from a [G4MFMaterial4D].
60-
</member>
61-
<member name="cell_texture_map_accessor_index" type="int" setter="set_cell_texture_map_accessor_index" getter="get_cell_texture_map_accessor_index" default="-1">
62-
The index of the [G4MFAccessor4D] in the [G4MFState4D]'s accessors array that contains the per-cell texture map data for this surface, also known as a UV map or UVW map. This is used to map the texture to the surface cells. If not defined (set to a negative index), the surface does not have a texture map. If defined, the amount of texture map data MUST match or exceed the amount of cells in the surface.
63-
[b]Note:[/b] This property is currently not used when generating a [Material4D] from a [G4MFMaterial4D].
64-
</member>
6557
<member name="factor" type="Color" setter="set_factor" getter="get_factor" default="Color(-1, -1, -1, -1)">
6658
The modulate factor of the surface, also known as the value or single base color. If non-negative, this is per-component multiplied with other properties to get the final color of the cells and edges, or if no other properties are defined, this is the only color used.
6759
</member>
68-
<member name="per_cell_accessor_index" type="int" setter="set_per_cell_accessor_index" getter="get_per_cell_accessor_index" default="-1">
69-
The index of the [G4MFAccessor4D] in the [G4MFState4D]'s accessors array that contains the per-cell color data for this surface. These may be per-component multiplied with the [member single_color] to get the final color of the cells. If not defined, the surface does not have per-cell colors. If defined (set to a valid index), the amount of cell colors MUST match or exceed the amount of cells in the surface.
70-
</member>
7160
<member name="per_edge_accessor_index" type="int" setter="set_edge_colors_accessor_index" getter="get_per_edge_accessor_index" default="-1">
7261
The index of the [G4MFAccessor4D] in the [G4MFState4D]'s accessors array that contains the per-edge color data for this surface. These may be per-component multiplied with the [member single_color] to get the final color of the edges. If not defined, the surface does not have per-edge colors. If defined (set to a valid index), the amount of edge colors MUST match or exceed the amount of edges in the surface.
7362
</member>
63+
<member name="per_simplex_accessor_index" type="int" setter="set_per_simplex_accessor_index" getter="get_per_simplex_accessor_index" default="-1">
64+
The index of the [G4MFAccessor4D] in the [G4MFState4D]'s accessors array that contains the per-simplex color data for this surface. These may be per-component multiplied with the [member single_color] to get the final color of the simplex cells. If not defined, the surface does not have per-simplex colors. If defined (set to a valid index), the amount of simplex colors MUST match or exceed the amount of simplex cells in the surface.
65+
</member>
7466
<member name="per_vertex_accessor_index" type="int" setter="set_per_vertex_accessor_index" getter="get_per_vertex_accessor_index" default="-1">
7567
The index of the [G4MFAccessor4D] in the [G4MFState4D]'s accessors array that contains the per-vertex color data for this surface. These may be per-component multiplied with the [member single_color] to get the final color of the vertices. If not defined, the surface does not have per-vertex colors. If defined (set to a valid index), the amount of vertex colors MUST match or exceed the amount of vertices in the surface.
7668
[b]Note:[/b] This property is currently not used when generating a [Material4D] from a [G4MFMaterial4D].
7769
</member>
70+
<member name="texture_index" type="int" setter="set_texture_index" getter="get_texture_index" default="-1">
71+
The index of the [G4MFTexture4D] in the [G4MFState4D]'s textures array that contains the texture for this surface. This is per-component multiplied with the [member single_color] and the cell colors to get the final color of the cells. If not defined, the surface does not have a texture.
72+
[b]Note:[/b] This property is currently not used when generating a [Material4D] from a [G4MFMaterial4D].
73+
</member>
74+
<member name="texture_map_accessor_index" type="int" setter="set_texture_map_accessor_index" getter="get_texture_map_accessor_index" default="-1">
75+
The index of the [G4MFAccessor4D] in the [G4MFState4D]'s accessors array that contains the per-vertex-instance texture map data for this surface, also known as a UV map or UVW map. This is used to map the texture to the surface vertex instances, such as simplex cells or edges. If not defined (set to a negative index), the surface does not have a texture map. If defined, the amount of texture map data MUST match or exceed the amount of vertex instances in the surface.
76+
[b]Note:[/b] This property is currently not used when generating a [Material4D] from a [G4MFMaterial4D].
77+
</member>
78+
<member name="topology_texture_map_accessor_index" type="int" setter="set_topology_texture_map_accessor_index" getter="get_topology_texture_map_accessor_index" default="-1">
79+
The index of the [G4MFAccessor4D] in the [G4MFState4D]'s accessors array that contains the per-topology-vertex-instance texture map data for this surface, also known as a UV map or UVW map. This is used to map the texture to the surface topology vertex instances, such as polytope cells. If not defined (set to a negative index), the surface does not have a texture map. If defined, the amount of texture map data MUST match or exceed the amount of topology vertex instances in the surface.
80+
[b]Note:[/b] This property is currently not used when generating a [Material4D] from a [G4MFMaterial4D].
81+
</member>
7882
</members>
7983
</class>

0 commit comments

Comments
 (0)