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.

Attributes

SETTINGS
anchor	The vertex of the volmesh that is anchored to the location of the object.
guid_cell	Map between Rhino object GUIDs and volmesh face identifiers.
guid_celllabel	Map between Rhino object GUIDs and volmesh celllabel identifiers.
guid_edge	Map between Rhino object GUIDs and volmsh edge identifiers.
guid_edgelabel	Map between Rhino object GUIDs and volmesh edgelabel identifiers.
guid_face	Map between Rhino object GUIDs and volmesh face identifiers.
guid_facelabel	Map between Rhino object GUIDs and volmesh facelabel identifiers.
guid_vertex	Map between Rhino object GUIDs and volmesh vertex identifiers.
guid_vertexlabel	Map between Rhino object GUIDs and volmesh vertexlabel identifiers.
guids	The GUIDs of all Rhino objects created by this artist.
location	compas.geometry.Point: The location of the object.
rotation	list of float: The rotation angles around the 3 axis of the coordinate system with the origin placed at the location of the object in the scene.
scale	float: A uniform scaling factor for the object in the scene.
vertex_xyz	The view coordinates of the volmesh object.
volmesh

Inherited Attributes

artist
id
item
layer
name
scene

Methods

clear	Clear all objects previously drawn by this artist.
draw	Draw the volmesh using the visualisation settings.
modify	Update the attributes of the volmesh.
modify_edges	Update the attributes of the edges.
modify_faces	Update the attributes of selected faces.
modify_vertices	Update the attributes of selected vertices.
move	Move the entire volmesh object to a different location.
move_face	Move a single face of the volmesh object and update the data structure accordingly.
move_vertex	Move a single vertex of the volmesh object and update the data structure accordingly.
move_vertices	Move a multiple vertices of the volmesh object and update the data structure accordingly.
select	Select the object representing the item.
select_edges	Select edges of the volmesh.
select_faces	Select faces of the volmesh.
select_vertex	Select one vertex of the mesh.
select_vertices	Select vertices of the volmesh.

Inherited Methods

build
clear_layer	Clear the layer of the object.
redraw	Redraw the Rhino scene/view.
register
registered_object_types