MeshArtist

class compas_blender.artists.MeshArtist(*args, **kwargs)[source]

Bases: compas_blender.artists.artist.BlenderArtist, compas.artists.meshartist.MeshArtist

A mesh artist defines functionality for visualising COMPAS meshes in Blender.

Parameters
  • mesh (compas.datastructures.Mesh) – A COMPAS mesh.

  • collection (str or bpy.types.Collection) – The name of the collection the object belongs to.

  • vertices (list of int, optional) – A list of vertex identifiers. Default is None, in which case all vertices are drawn.

  • edges (list, optional) – A list of edge keys (as uv pairs) identifying which edges to draw. The default is None, in which case all edges are drawn.

  • faces (list, optional) – A list of face identifiers. The default is None, in which case all faces are drawn.

  • vertexcolor (rgb-tuple or dict of rgb-tuples, optional) – The color specification for the vertices.

  • edgecolor (rgb-tuple or dict of rgb-tuples, optional) – The color specification for the edges.

  • facecolor (rgb-tuple or dict of rgb-tuples, optional) – The color specification for the faces.

  • show_mesh (bool, optional)

  • show_vertices (bool, optional)

  • show_edges (bool, optional)

  • show_faces (bool, optional)

Attributes
  • vertexcollection (bpy.types.Collection) – The collection containing the vertices.

  • edgecollection (bpy.types.Collection) – The collection containing the edges.

  • facecollection (bpy.types.Collection) – The collection containing the faces.

  • vertexlabelcollection (bpy.types.Collection) – The collection containing the vertex labels.

  • edgelabelcollection (bpy.types.Collection) – The collection containing the edge labels.

  • facelabelcollection (bpy.types.Collection) – The collection containing the face labels.

Methods

build(item, **kwargs)

Build an artist corresponding to the item type.

build_as(item, artist_type, **kwargs)

clear()

Delete all objects created by the artist.

clear_edges()

clear_faces()

clear_vertices()

draw([vertices, edges, faces, vertexcolor, ...])

Draw the mesh using the chosen visualisation settings.

draw_collection(collection)

draw_edgelabels([text, color])

Draw labels for a selection of edges.

draw_edges([edges, color])

Draw a selection of edges.

draw_facelabels([text, color])

Draw labels for a selection of faces.

draw_facenormals([faces, color, scale])

Draw the normals of the faces.

draw_faces([faces, color])

Draw a selection of faces.

draw_mesh()

Draw the mesh.

draw_vertexlabels([text, color])

Draw labels for a selection vertices.

draw_vertexnormals([vertices, color, scale])

Draw the normals at the vertices of the mesh.

draw_vertices([vertices, color])

Draw a selection of vertices.

redraw()

register(item_type, artist_type)