FrameArtist

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

Bases: BlenderArtist, PrimitiveArtist

Artist for drawing frames in Blender.

Parameters

  • frame (Frame) – A COMPAS frame.

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

  • scale (float, optional) – Scale factor that controls the length of the axes.

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

Attributes

  • scale (float) – Scale factor that controls the length of the axes. Default is 1.0.

  • color_origin (Color) – Color for the point at the frame origin. Default is Color.black().

  • color_xaxis (Color) – Default is Color.red().

  • color_yaxis (Color) – Default is Color.green().

  • color_zaxis (Color) – Default is Color.blue().

Methods

draw

Draw the frame.

draw_axes

Draw the axes of the frame.

draw_origin

Draw the origin of the frame.

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.