BoxArtist

class compas_blender.artists.BoxArtist(item, **kwargs)[source]

Bases: BlenderArtist, ShapeArtist

Artist for drawing box shapes in Blender.

Parameters
  • box (Box) – A COMPAS box.

  • collection (str | bpy.types.Collection, optional) – The Blender scene collection the object(s) created by this artist belong to.

  • **kwargs (dict, optional) – Additional keyword arguments. For more info, see BlenderArtist and ShapeArtist.

Examples

Use the Blender artist explicitly.

from compas.geometry import Box
from compas_blender.artists import BoxArtist

box = Box.from_width_height_depth(1, 1, 1)

artist = BoxArtist(box)
artist.draw()

Or, use the artist through the plugin mechanism.

from compas.geometry import Box
from compas.artists import Artist

box = Box.from_width_height_depth(1, 1, 1)

artist = Artist(box)
artist.draw()

Methods

draw

Draw the box associated with the artist.

Inherited Methods

build

Build an artist corresponding to the item type.

build_as

Build an artist with the given type.

clear

Clear all objects from the view.

draw_collection

Drawing method for drawing an entire collection of objects.

redraw

Redraw the view.

register

Register an artist type to a data type.