FrameArtist

class compas_ghpython.artists.FrameArtist(*args, **kwargs)[source]

Bases: compas_ghpython.artists.artist.GHArtist, compas.artists.primitiveartist.PrimitiveArtist

Artist for drawing frames.

Parameters

  • frame (compas.geometry.Frame) – A COMPAS frame.

  • scale (float, optional) – The scale of the vectors representing the axes of the frame. Default is 1.0.

Attributes

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

  • color_origin (tuple of 3 int between 0 and 255) – Default is (0, 0, 0).

  • color_xaxis (tuple of 3 int between 0 and 255) – Default is (255, 0, 0).

  • color_yaxis (tuple of 3 int between 0 and 255) – Default is (0, 255, 0).

  • color_zaxis (tuple of 3 int between 0 and 255) – Default is (0, 0, 255).

Methods

build(item, **kwargs)

Build an artist corresponding to the item type.

build_as(item, artist_type, **kwargs)

clear()

draw()

Draw the frame.

draw_axes()

Draw the frame's axes.

draw_collection(collection)

draw_origin()

Draw the frame's origin.

get_artist_cls(data, **kwargs)

redraw()

register(item_type, artist_type)