CylinderArtist

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

Bases: BlenderArtist, ShapeArtist

Artist for drawing cylinder shapes in Blender.

Parameters
  • cylinder (Cylinder) – A COMPAS cylinder.

  • collection (str | bpy.types.Collection) – 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 Plane, Circle, Cylinder
from compas_blender.artists import CylinderArtist

cylinder = Cylinder(Circle(Plane([0, 0, 0], [0, 0, 1]), 0.3), 1.0)

artist = CylinderArtist(cylinder)
artist.draw()

Or, use the artist through the plugin mechanism.

from compas.geometry import Plane, Circle, Cylinder
from compas.artists import Artist

cylinder = Cylinder(Circle(Plane([0, 0, 0], [0, 0, 1]), 0.3), 1.0)

artist = Artist(cylinder)
artist.draw()

Methods

draw

Draw the cylinder 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.