VolMeshObject

class compas_rhino.objects.VolMeshObject(volmesh, scene=None, name=None, layer=None, visible=True, settings=None)[source]

Bases: compas_rhino.objects._object.BaseObject

Class for representing COMPAS volmeshes in Rhino.

Parameters

  • volmesh (compas.datastructures.VolMesh) – A volmesh data structure.

  • scene (compas.scenes.Scene, optional) – A scene object.

  • name (str, optional) – The name of the object.

  • layer (str, optional) – The layer for drawing.

  • visible (bool, optional) – Toggle for the visibility of the object.

  • settings (dict, optional) – A dictionary of settings.

Methods

build(item, **kwargs)

clear()

Clear all objects previously drawn by this artist.

clear_layer()

Clear the layer of the object.

draw()

Draw the volmesh using the visualisation settings.

modify()

Update the attributes of the volmesh.

modify_edges(edges[, names])

Update the attributes of the edges.

modify_faces(faces[, names])

Update the attributes of selected faces.

modify_vertices(vertices[, names])

Update the attributes of selected vertices.

move()

Move the entire volmesh object to a different location.

move_face(face)

Move a single face of the volmesh object and update the data structure accordingly.

move_vertex(vertex)

Move a single vertex of the volmesh object and update the data structure accordingly.

move_vertices(vertices)

Move a multiple vertices of the volmesh object and update the data structure accordingly.

redraw()

Redraw the Rhino scene/view.

register(item_type, object_type)

registered_object_types()

select()

Select the object representing the item.

select_edges([message])

Select edges of the volmesh.

select_faces([message])

Select faces of the volmesh.

select_vertex([message])

Select one vertex of the mesh.

select_vertices([message])

Select vertices of the volmesh.