Mesh

class compas.datastructures.Mesh(name=None, default_vertex_attributes=None, default_edge_attributes=None, default_face_attributes=None)[source]

Bases: compas.datastructures.halfedge.halfedge.HalfEdge

Geometric implementation of a half edge data structure for polygon meshses.

Parameters

• name (str, optional) – The name of the graph. Defaults to “Graph”.

• default_vertex_attributes (dict, optional) – Default values for vertex attributes.

• default_edge_attributes (dict, optional) – Default values for edge attributes.

• default_face_attributes (dict, optional) – Default values for face attributes.

Attributes

• attributes (dict) – A dictionary of general mesh attributes: {'name': "Mesh"}.

• default_vertex_attributes (dict) – The names of pre-assigned vertex attributes and their default values: {'x': 0.0, 'y': 0.0, 'z': 0.0}

• default_edge_attributes (dict) – The default data attributes assigned to every new edge.

• default_face_attributes (dict) – The default data attributes assigned to every new face.

• name (str) – The name of the mesh. Shorthand for mesh.attributes['name']

• adjacency (dict, read-only) – The vertex adjacency dictionary.

Examples

>>> from compas.datastructures import Mesh
>>> mesh = Mesh.from_polyhedron(6)
>>> V = mesh.number_of_vertices()
>>> E = mesh.number_of_edges()
>>> F = mesh.number_of_faces()
>>> mesh.euler() == V - E + F
True

Inherited Attributes

DATASCHEMA	The schema of the data of this object.
JSONSCHEMA	The schema of the JSON representation of the data of this object.
JSONSCHEMANAME
adjacency
data	A data dict representing the mesh data structure for serialization.
dtype	The type of the object in the form of a '2-level' import and a class name.
guid	The globally unique identifier of the object.
jsondefinitions	Reusable schema definitions.
jsonstring	The representation of the object data in JSON format.
jsonvalidator	JSON schema validator for draft 7.
name	The name of the data structure.

Methods

area	Calculate the total mesh area.
bounding_box	Compute the (axis aligned) bounding box of a mesh.
bounding_box_xy	Compute the (axis aligned) bounding box of a projection of the mesh in the XY plane.
centroid	Calculate the mesh centroid.
collapse_edge	Collapse an edge to its first or second vertex, or to an intermediate point.
connected_components
dual	Construct the dual of a mesh.
edge_coordinates	Return the coordinates of the start and end point of an edge.
edge_direction	Return the direction vector of an edge.
edge_length	Return the length of an edge.
edge_midpoint	Return the location of the midpoint of an edge.
edge_point	Return the location of a point along an edge.
edge_vector	Return the vector of an edge.
edges_on_boundaries	Find the edges on all boundaries of the mesh.
edges_on_boundary	Find the edges on the longest boundary.
face_adjacency	Build a face adjacency dict.
face_area	Compute the area of a face.
face_aspect_ratio	Face aspect ratio as the ratio between the lengths of the maximum and minimum face edges.
face_center	Compute the location of the center of mass of a face.
face_centroid	Compute the location of the centroid of a face.
face_coordinates	Compute the coordinates of the vertices of a face.
face_curvature	Dimensionless face curvature as the maximum face vertex deviation from the best-fit plane of the face vertices divided by the average lengths of the face vertices to the face centroid.
face_flatness	Compute the flatness of the mesh face.
face_normal	Compute the normal of a face.
face_plane	A plane defined by the centroid and the normal of the face.
face_skewness	Face skewness as the maximum absolute angular deviation from the ideal polygon angle.
faces_on_boundaries	Find the faces on all boundaries of the mesh.
faces_on_boundary	Find the faces on the longest boundary.
flip_cycles	Flip the cycle directions of all faces.
from_lines	Construct a mesh object from a list of lines described by start and end point coordinates.
from_meshgrid	Create a mesh from faces and vertices on a regular grid.
from_obj	Construct a mesh object from the data described in an OBJ file.
from_off	Construct a mesh object from the data described in a OFF file.
from_ply	Construct a mesh object from the data described in a PLY file.
from_points	Construct a mesh from a delaunay triangulation of a set of points.
from_polygons	Construct a mesh from a series of polygons.
from_polyhedron	Construct a mesh from a platonic solid.
from_polylines	Construct mesh from polylines.
from_shape	Construct a mesh from a primitive shape.
from_stl	Construct a mesh object from the data described in a STL file.
from_vertices_and_faces	Construct a mesh object from a list of vertices and faces.
gkey_key	Returns a dictionary that maps geometric keys of a certain precision to the keys of the corresponding vertices.
gkey_vertex	Returns a dictionary that maps geometric keys of a certain precision to the keys of the corresponding vertices.
insert_vertex	Insert a vertex in the specified face.
is_connected	Verify that the mesh is connected.
join	Add the vertices and faces of another mesh to the current mesh.
key_gkey	Returns a dictionary that maps vertex dictionary keys to the corresponding geometric key up to a certain precision.
merge_faces	Merge two faces of a mesh over their shared edge.
mesh_oriented_bounding_box_numpy	Compute the (axis aligned) bounding box of a mesh.
mesh_oriented_bounding_box_xy_numpy	Compute the (axis aligned) bounding box of a projection of the mesh in the XY plane.
normal	Calculate the average mesh normal.
obb_numpy	Compute the (axis aligned) bounding box of a mesh.
obb_xy_numpy	Compute the (axis aligned) bounding box of a projection of the mesh in the XY plane.
quads_to_triangles
slice_plane	Slice a mesh with a plane and construct the resulting submeshes.
smooth_area	Smooth a mesh by moving each vertex to the barycenter of the centroids of the surrounding faces, weighted by area.
smooth_centroid	Smooth a mesh by moving every free vertex to the centroid of its neighbors.
split_edge	Split and edge by inserting a vertex along its length.
split_face	Split a face by inserting an edge between two specified vertices.
split_strip	Split the srip of faces corresponding to a given edge.
subdivide	Subdivide the input mesh.
to_lines
to_obj	Write the mesh to an OBJ file.
to_off	Write a mesh object to an OFF file.
to_ply	Write a mesh object to a PLY file.
to_points
to_polygons
to_polylines
to_stl	Write a mesh to an STL file.
to_vertices_and_faces	Return the vertices and faces of a mesh.
transform	Transform a mesh.
transformed	Transform a copy of mesh.
unify_cycles	Unify the cycle directions of all faces.
vertex_area	Compute the tributary area of a vertex.
vertex_coordinates	Return the coordinates of a vertex.
vertex_curvature	Dimensionless vertex curvature.
vertex_gkey	Returns a dictionary that maps vertex dictionary keys to the corresponding geometric key up to a certain precision.
vertex_laplacian	Compute the vector from a vertex to the centroid of its neighbors.
vertex_neighborhood_centroid	Compute the centroid of the neighbors of a vertex.
vertex_normal	Return the normal vector at the vertex as the weighted average of the normals of the neighboring faces.
vertices_on_boundaries	Find the vertices on all boundaries of the mesh.
vertices_on_boundary	Find the vertices on the longest boundary.

Inherited Methods

add_face	Add a face to the mesh object.
add_vertex	Add a vertex to the mesh object.
clear	Clear all the mesh data.
copy	Make an independent copy of the data object.
cull_vertices	Remove all unused vertices from the mesh object.
delete_face	Delete a face from the mesh object.
delete_vertex	Delete a vertex from the mesh and everything that is attached to it.
edge_attribute	Get or set an attribute of an edge.
edge_attributes	Get or set multiple attributes of an edge.
edge_faces	Find the two faces adjacent to an edge.
edge_loop	Find all edges on the same loop as a given edge.
edge_sample	A random sample of the edges.
edge_strip	Find all edges on the same strip as a given edge.
edges	Iterate over the edges of the mesh.
edges_attribute	Get or set an attribute of multiple edges.
edges_attributes	Get or set multiple attributes of multiple edges.
edges_where	Get edges for which a certain condition or set of conditions is true.
edges_where_predicate	Get edges for which a certain condition or set of conditions is true using a lambda function.
euler	Calculate the Euler characteristic.
face_adjacency_halfedge	Find one half-edge over which two faces are adjacent.
face_adjacency_vertices	Find all vertices over which two faces are adjacent.
face_attribute	Get or set an attribute of a face.
face_attributes	Get or set multiple attributes of a face.
face_corners	Return triplets of face vertices forming the corners of the face.
face_degree	Count the neighbors of a face.
face_halfedges	The halfedges of a face.
face_max_degree	Compute the maximum degree of all faces.
face_min_degree	Compute the minimum degree of all faces.
face_neighborhood	Return the faces in the neighborhood of a face.
face_neighbors	Return the neighbors of a face across its edges.
face_sample	A random sample of the faces.
face_vertex_after	Return the n-th vertex after the specified vertex in a specific face.
face_vertex_ancestor	Return the n-th vertex before the specified vertex in a specific face.
face_vertex_before	Return the n-th vertex before the specified vertex in a specific face.
face_vertex_descendant	Return the n-th vertex after the specified vertex in a specific face.
face_vertices	The vertices of a face.
faces	Iterate over the faces of the mesh.
faces_attribute	Get or set an attribute of multiple faces.
faces_attributes	Get or set multiple attributes of multiple faces.
faces_where	Get faces for which a certain condition or set of conditions is true.
faces_where_predicate	Get faces for which a certain condition or set of conditions is true using a lambda function.
from_data	Construct an object of this type from the provided data.
from_json	Construct an object from serialized data contained in a JSON file.
from_jsonstring	Construct an object from serialized data contained in a JSON string.
genus	Calculate the genus.
get_any_face	Get the identifier of a random face.
get_any_face_vertex	Get the identifier of a random vertex of a specific face.
get_any_vertex	Get the identifier of a random vertex.
get_any_vertices	Get a list of identifiers of a random set of n vertices.
halfedge_after
halfedge_before
halfedge_face	Find the face corresponding to a halfedge.
halfedge_loop	Find all edges on the same loop as the halfedge, in the direction of the halfedge.
halfedge_strip	Find all edges on the same strip as a given halfedge.
has_edge	Verify that the mesh contains a specific edge.
has_face	Verify that a face is part of the mesh.
has_halfedge	Verify that a halfedge is part of the mesh.
has_vertex	Verify that a vertex is in the mesh.
index_key	Returns a dictionary that maps the indices of a vertex list to keys in a vertex dictionary.
index_vertex	Returns a dictionary that maps the indices of a vertex list to keys in a vertex dictionary.
is_closed	Verify that the mesh is closed.
is_edge_on_boundary	Verify that an edge is on the boundary.
is_empty	Verify that the mesh is empty.
is_face_on_boundary	Verify that a face is on a boundary.
is_manifold	Verify that the mesh is manifold.
is_orientable	Verify that the mesh is orientable.
is_quadmesh	Verify that the mesh consists of only quads.
is_regular	Verify that the mesh is regular.
is_trimesh	Verify that the mesh consists of only triangles.
is_valid	Verify that the mesh is valid.
is_vertex_connected	Verify that a vertex is connected.
is_vertex_on_boundary	Verify that a vertex is on a boundary.
key_index	Returns a dictionary that maps vertex dictionary keys to the corresponding index in a vertex list or array.
number_of_edges	Count the number of edges in the mesh.
number_of_faces	Count the number of faces in the mesh.
number_of_vertices	Count the number of vertices in the mesh.
remove_unused_vertices	Remove all unused vertices from the mesh object.
summary	Print a summary of the mesh.
to_data	Convert an object to its native data representation.
to_json	Serialize the data representation of an object to a JSON file.
to_jsonstring	Serialize the data representation of an object to a JSON string.
unset_edge_attribute	Unset the attribute of an edge.
unset_face_attribute	Unset the attribute of a face.
unset_vertex_attribute	Unset the attribute of a vertex.
update_default_edge_attributes	Update the default edge attributes.
update_default_face_attributes	Update the default face attributes.
update_default_vertex_attributes	Update the default vertex attributes.
validate_data	Validate the object's data against its data schema (self.DATASCHEMA).
validate_json	Validate the object's data against its json schema (self.JSONSCHEMA).
vertex_attribute	Get or set an attribute of a vertex.
vertex_attributes	Get or set multiple attributes of a vertex.
vertex_degree	Count the neighbors of a vertex.
vertex_edges
vertex_faces	The faces connected to a vertex.
vertex_index	Returns a dictionary that maps vertex dictionary keys to the corresponding index in a vertex list or array.
vertex_max_degree	Compute the maximum degree of all vertices.
vertex_min_degree	Compute the minimum degree of all vertices.
vertex_neighborhood	Return the vertices in the neighborhood of a vertex.
vertex_neighbors	Return the neighbors of a vertex.
vertex_sample	A random sample of the vertices.
vertices	Iterate over the vertices of the mesh.
vertices_attribute	Get or set an attribute of multiple vertices.
vertices_attributes	Get or set multiple attributes of multiple vertices.
vertices_where	Get vertices for which a certain condition or set of conditions is true.
vertices_where_predicate	Get vertices for which a certain condition or set of conditions is true using a lambda function.