Add dimension property to mesh types

Author: aaronfranke

addons/nd/doc_classes/ArrayCellMeshND.xml

@@ -30,6 +30,9 @@
 		<member name="cell_indices" type="PackedInt32Array" setter="set_cell_indices" getter="get_cell_indices" default="PackedInt32Array()">
 			The indices of the cell cells. Every 4 integers defines a cell 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.
 		</member>
+		<member name="dimension" type="int" setter="set_dimension" getter="get_dimension" default="0">
+			The dimension of the mesh. This is calculated as the length of the first vertex. Setting this will resize all vertices to the new dimension, either truncating them or padding them with zeros as necessary. The amount of indices making up a simplex cell is equal to the dimension.
+		</member>
 		<member name="vertices" type="PackedFloat64Array[]" setter="set_vertices" getter="get_vertices" default="[]">
 			The vertices of the cell mesh. Each vertex is a VectorN ([PackedFloat64Array]) with a length equal to the number of dimensions. Indices of cells and edges refer to the items in this array. The vertices array must be kept consistent with the cell indices array, such that each cell index points to a valid vertex index, or else the mesh is invalid.
 		</member>

addons/nd/doc_classes/ArrayWireMeshND.xml

@@ -44,6 +44,9 @@
 		</method>
 	</methods>
 	<members>
+		<member name="dimension" type="int" setter="set_dimension" getter="get_dimension" default="0">
+			The dimension of the mesh. This is calculated as the length of the first vertex. Setting this will resize all vertices to the new dimension, either truncating them or padding them with zeros as necessary.
+		</member>
 		<member name="edge_indices" type="PackedInt32Array" setter="set_edge_indices" getter="get_edge_indices" default="PackedInt32Array()">
 			The indices of the edges. Every 2 integers defines an edge. 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.
 		</member>

addons/nd/doc_classes/BoxCellMeshND.xml

@@ -24,6 +24,9 @@
 		</method>
 	</methods>
 	<members>
+		<member name="dimension" type="int" setter="set_dimension" getter="get_dimension" default="0">
+			The dimension of the box. This is calculated as the length of [member size]. Setting this will resize [member size] to the new dimension.
+		</member>
 		<member name="half_extents" type="PackedFloat64Array" setter="set_half_extents" getter="get_half_extents">
 			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.
 		</member>

addons/nd/doc_classes/BoxWireMeshND.xml

@@ -9,6 +9,9 @@
 	<tutorials>
 	</tutorials>
 	<members>
+		<member name="dimension" type="int" setter="set_dimension" getter="get_dimension" default="0">
+			The dimension of the box. This is calculated as the length of [member size]. Setting this will resize [member size] to the new dimension.
+		</member>
 		<member name="half_extents" type="PackedFloat64Array" setter="set_half_extents" getter="get_half_extents">
 			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.
 		</member>

addons/nd/doc_classes/CellMeshND.xml

@@ -43,7 +43,7 @@
 				Gets the cell indices of the cell mesh. Each set of [method get_indices_per_cell] integers represents the indices of the vertices that make up a cell, for a total of [method get_cell_count] cells. The vertices can be obtained using [method MeshND.get_vertices]. Integers in this array should not exceed the length of the vertices array.
 			</description>
 		</method>
-		<method name="get_indices_per_cell" qualifiers="const">
+		<method name="get_indices_per_cell">
 			<return type="int" />
 			<description>
 				Gets the number of indices per cell. This is the number of vertices that make up a cell. For example, a triangle has 3 vertices, so the number of indices per cell is 3. The total number of indices in the [method get_cell_indices] array is equal to this value multiplied by [method get_cell_count].
@@ -56,9 +56,4 @@
 			</description>
 		</method>
 	</methods>
-	<members>
-		<member name="dimension" type="int" setter="set_dimension" getter="get_dimension" default="0">
-			The dimension of the mesh. The amount of indices making up a simplex cell is usually equal to the dimension.
-		</member>
-	</members>
 </class>

addons/nd/doc_classes/MeshND.xml

@@ -42,6 +42,12 @@
 				[b]Note[/b]: This only looks at edge indices. It does not remove duplicate vertices, nor does it have access to the vertices array.
 			</description>
 		</method>
+		<method name="get_dimension">
+			<return type="int" />
+			<description>
+				Returns the dimension of the mesh. This is calculated as the length of the first vertex. Setting this will resize all vertices to the new dimension, either truncating them or padding them with zeros as necessary. For [CellMeshND], the amount of indices making up a simplex cell is usually equal to the dimension.
+			</description>
+		</method>
 		<method name="get_edge_indices">
 			<return type="PackedInt32Array" />
 			<description>

addons/nd/doc_classes/OrthoplexCellMeshND.xml

@@ -28,6 +28,9 @@
 		</method>
 	</methods>
 	<members>
+		<member name="dimension" type="int" setter="set_dimension" getter="get_dimension" default="0">
+			The dimension of the orthoplex. This is calculated as the length of [member size]. Setting this will resize [member size] to the new dimension.
+		</member>
 		<member name="half_extents" type="PackedFloat64Array" setter="set_half_extents" getter="get_half_extents">
 			The half-extents of the orthoplex in meters, also known as just "extents". This is the "radius" of the orthoplex, the distance between each vertex and the center. This is a wrapper around [member size] for situations where you want to use the extents instead of size.
 		</member>

addons/nd/doc_classes/OrthoplexWireMeshND.xml

@@ -13,6 +13,9 @@
 		<link title="Wikipedia 16-cell / 4D Orthoplex">https://en.wikipedia.org/wiki/16-cell</link>
 	</tutorials>
 	<members>
+		<member name="dimension" type="int" setter="set_dimension" getter="get_dimension" default="0">
+			The dimension of the orthoplex. This is calculated as the length of [member size]. Setting this will resize [member size] to the new dimension.
+		</member>
 		<member name="half_extents" type="PackedFloat64Array" setter="set_half_extents" getter="get_half_extents">
 			The half-extents of the orthoplex in meters, also known as just "extents". This is the "radius" of the orthoplex, the distance between each vertex and the center. This is a wrapper around [member size] for situations where you want to use the extents instead of size.
 		</member>

model/cell/array_cell_mesh_nd.cpp

@@ -9,12 +9,13 @@ void ArrayCellMeshND::_clear_cache() {
 
 bool ArrayCellMeshND::validate_mesh_data() {
 	const int64_t cell_indices_count = _cell_indices.size();
-	if (cell_indices_count % _dimension != 0) {
+	const int dimension = get_dimension();
+	if (cell_indices_count % dimension != 0) {
 		return false; // Must be a multiple of _dimension.
 	}
 	const int64_t cell_normals_count = _cell_normals.size();
-	if (cell_normals_count > 0 && cell_normals_count * _dimension != cell_indices_count) {
-		return false; // Must be have one normal per cell (_dimension indices).
+	if (cell_normals_count > 0 && cell_normals_count * dimension != cell_indices_count) {
+		return false; // Must be have one normal per cell (dimension indices).
 	}
 	const int64_t vertex_count = _vertices.size();
 	for (int32_t cell_index : _cell_indices) {
@@ -57,6 +58,7 @@ void ArrayCellMeshND::merge_with(const Ref<ArrayCellMeshND> &p_other, const Ref<
 	const int64_t other_vertex_count = p_other->_vertices.size();
 	const int64_t end_cell_index_count = start_cell_index_count + other_cell_index_count;
 	const int64_t end_vertex_count = start_vertex_count + other_vertex_count;
+	const int dimension = get_dimension();
 	_cell_indices.resize(end_cell_index_count);
 	_vertices.resize(end_vertex_count);
 	// Copy in the cell indices and vertices from the other mesh.
@@ -68,17 +70,17 @@ void ArrayCellMeshND::merge_with(const Ref<ArrayCellMeshND> &p_other, const Ref<
 	}
 	// Can't simply add these together in case the first mesh has no normals.
 	if (start_cell_normal_count > 0 || other_cell_normal_count > 0) {
-		const int64_t end_cell_normal_count = end_cell_index_count / _dimension;
+		const int64_t end_cell_normal_count = end_cell_index_count / dimension;
 		_cell_normals.resize(end_cell_normal_count);
-		const int64_t start_normal_count = start_cell_index_count / _dimension;
+		const int64_t start_normal_count = start_cell_index_count / dimension;
 		// Initialize the mesh's normals to zero if it has none.
 		if (start_cell_normal_count == 0) {
 			for (int64_t i = 0; i < start_normal_count; i++) {
 				_cell_normals.set(i, VectorN());
 			}
 		}
 		if (other_cell_normal_count == 0) {
-			for (int64_t i = 0; i < other_cell_index_count / _dimension; i++) {
+			for (int64_t i = 0; i < other_cell_index_count / dimension; i++) {
 				_cell_normals.set(start_normal_count + i, VectorN());
 			}
 		}
@@ -131,6 +133,16 @@ void ArrayCellMeshND::set_vertices_bind(const TypedArray<VectorN> &p_vertices) {
 	reset_mesh_data_validation();
 }
 
+void ArrayCellMeshND::set_dimension(int p_dimension) {
+	ERR_FAIL_COND_MSG(p_dimension < 0, "ArrayCellMeshND: Dimension must not be negative.");
+	ERR_FAIL_COND_MSG(p_dimension > 1000, "ArrayCellMeshND: Too many dimensions for cell mesh.");
+	for (int i = 0; i < _vertices.size(); i++) {
+		_vertices.set(i, VectorND::with_dimension(_vertices[i], p_dimension));
+	}
+	_clear_cache();
+	reset_mesh_data_validation();
+}
+
 void ArrayCellMeshND::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("append_vertex", "vertex", "deduplicate_vertices"), &ArrayCellMeshND::append_vertex, DEFVAL(true));
 
@@ -139,6 +151,8 @@ void ArrayCellMeshND::_bind_methods() {
 	// Only bind the setters here because the getters are already bound in CellMeshND.
 	ClassDB::bind_method(D_METHOD("set_cell_indices", "cell_indices"), &ArrayCellMeshND::set_cell_indices);
 	ClassDB::bind_method(D_METHOD("set_vertices", "vertices"), &ArrayCellMeshND::set_vertices_bind);
+	ClassDB::bind_method(D_METHOD("set_dimension", "dimension"), &ArrayCellMeshND::set_dimension);
 	ADD_PROPERTY(PropertyInfo(Variant::PACKED_INT32_ARRAY, "cell_indices"), "set_cell_indices", "get_cell_indices");
 	ADD_PROPERTY(PropertyInfo(Variant::ARRAY, "vertices", PROPERTY_HINT_ARRAY_TYPE, "PackedFloat64Array"), "set_vertices", "get_vertices");
+	ADD_PROPERTY(PropertyInfo(Variant::INT, "dimension", PROPERTY_HINT_RANGE, "0,1000,1", PROPERTY_USAGE_EDITOR), "set_dimension", "get_dimension");
 }

model/cell/array_cell_mesh_nd.h

@@ -31,4 +31,5 @@ class ArrayCellMeshND : public CellMeshND {
 	virtual Vector<VectorN> get_vertices() override;
 	void set_vertices(const Vector<VectorN> &p_vertices);
 	void set_vertices_bind(const TypedArray<VectorN> &p_vertices);
+	void set_dimension(int p_dimension);
 };