compas_3gs.diagrams.FormVolMesh

class compas_3gs.diagrams.FormVolMesh

Bases: compas_3gs.datastructures.volmesh3gs.VolMesh3gs

A polyhedral form diagram, represented as a volmesh object.

__init__()[source]

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__()

Initialize self.

add_cell(halffaces[, ckey])

add_halfface(vertices[, fkey])

add_vertex([vkey, attr_dict])

cell_adjacency()

cell_center(ckey)

cell_centroid(ckey)

cell_edges(ckey)

cell_halffaces(ckey)

cell_mesh(ckey)

cell_neighbors(ckey)

cell_tree(root)

cell_vertex_delete(vkey)

This removes the vertex, and everything that is attached to the vertex EXCEPT the cell itself.

cell_vertex_neighbors(ckey)

cell_vertices(ckey)

cell_vertices_and_halffaces(ckey)

cells([data])

clean()

clear()

clear_edges(**kwattr)

clear_faces(**kwattr)

copy()

delete_cell(ckey)

delete_halfface(hfkey)

draw(**kwattr)

draw_edge_labels(**kwattr)

draw_edges(**kwattr)

draw_face_labels(**kwattr)

draw_faces(**kwattr)

draw_vertex_labels(**kwattr)

draw_vertices(**kwattr)

edge_coordinates(u, v[, axes])

Return the coordinates of the start and end point of an edge.

edge_direction(u, v)

Return the direction vector of an edge.

edge_label_name(u, v)

Get the name of an edge label.

edge_length(u, v)

Return the length of an edge.

edge_midpoint(u, v)

Return the location of the midpoint of an edge.

edge_name(u, v)

Get the name of an edge.

edge_point(u, v[, t])

Return the location of a point along an edge.

edge_vector(u, v[, unitized])

Return the vector of an edge.

edges([data])

face_coordinates(fkey[, axes])

face_label_name(fkey)

Get the name of a face label.

face_name(fkey)

Get the name of a face.

faces()

from_data(data)

Construct a datastructure from structured data.

from_json(filepath)

Construct a datastructure from structured data contained in a json file.

from_obj(filepath)

from_vertices_and_cells(vertices, cells)

from_vertices_and_edges(vertices, edges)

get_any_edge()

Get the identifier of a random edge.

get_any_face()

Get the identifier of a random face.

get_any_face_vertex(fkey)

Get the identifier of a random vertex of a specific face.

get_any_vertex()

Get the identifier of a random vertex.

get_any_vertices(n[, exclude_leaves])

Get a list of identifiers of a random set of n vertices.

get_edge_attribute(key, name[, value])

Get the value of a named attribute of one edge.

get_edge_attributes(key, names[, values])

Get the value of a named attribute of one edge.

get_edges_attribute(name[, value, keys])

Get the value of a named attribute of multiple edges.

get_edges_attributes(names[, values, keys])

Get the values of multiple named attribute of multiple edges.

get_face_attribute(key, name[, value])

Get the value of a named attribute of one face.

get_face_attributes(key, names[, values])

Get the value of a named attribute of one face.

get_faces_attribute(keys, name[, value])

Get the value of a named attribute of multiple faces.

get_faces_attributes(keys, names[, values])

Get the values of multiple named attribute of multiple faces.

get_vertex_attribute(key, name[, value])

Get the value of a named attribute of one vertex.

get_vertex_attributes(key, names[, values])

Get the value of a named attribute of one vertex.

get_vertices_attribute(name[, value, keys])

Get the value of a named attribute of multiple vertices.

get_vertices_attributes(names[, values, keys])

Get the values of multiple named attribute of multiple vertices.

halfface_adjacency(ckey)

halfface_cell(fkey)

halfface_edge_dependents(hfkey)

halfface_edges(fkey)

halfface_oriented_area(hfkey)

halfface_oriented_normal(hfkey[, unitized])

halfface_vertices(fkey[, ordered])

number_of_cells()

Count the number of faces in the mesh.

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.

planes()

scale([factor])

set_edge_attribute(key, name, value)

Set one attribute of one edge.

set_edge_attributes(key, names, values)

Set multiple attributes of one edge.

set_edges_attribute(name, value[, keys])

Set one attribute of multiple edges.

set_edges_attributes(names, values[, keys])

Set multiple attributes of multiple edges.

set_face_attribute(key, name, value)

Set one attribute of one face.

set_face_attributes(key, names, values)

Set multiple attributes of one face.

set_faces_attribute(keys, name, value)

Set one attribute of multiple faces.

set_faces_attributes(keys, names, values)

Set multiple attributes of multiple faces.

set_vertex_attribute(key, name, value)

Set one attribute of one vertex.

set_vertex_attributes(key, names, values)

Set multiple attributes of one vertex.

set_vertices_attribute(name, value[, keys])

Set one attribute of multiple vertices.

set_vertices_attributes(names, values[, keys])

Set multiple attributes of multiple vertices.

to_data()

Returns a dictionary of structured data representing the data structure.

to_json(filepath[, pretty])

Serialise the structured data representing the data structure to json.

to_obj(filepath)

update_default_edge_attributes([attr_dict])

Update the default edge attributes (this also affects already existing edges).

update_default_face_attributes([attr_dict])

Update the default face attributes (this also affects already existing faces).

update_default_vertex_attributes([attr_dict])

Update the default vertex attributes (this also affects already existing vertices).

vertex_coordinates(vkey[, axes])

vertex_label_name(key)

Get the name of a vertex label.

vertex_name(key)

Get the name of a vertex.

vertex_neighbors(vkey)

vertex_update_xyz(vkey, xyz[, constrained])

vertices([data])

vertices_where(conditions[, data])

Get vertices for which a certain condition or set of conditions is true.

vertices_where_predicate(predicate[, data])

Get vertices for which a certain condition or set of conditions is true using a lambda function.

volmesh_edge_dependents_all(hfkey)

Attributes

color

data

The data representing the mesh.

name

The name of the mesh.

x

list – The X coordinates of the vertices.

xy

list – The XY coordinates of the vertices.

xyz

list – The XYZ coordinates of the vertices.

y

list – The Y coordinates of the vertices.

z

list – The Z coordinates of the vertices.