FrameArtist

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

Bases: GHArtist, PrimitiveArtist

Artist for drawing frames.

Parameters

• frame (Frame) – A COMPAS frame.

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

• **kwargs (dict, optional) – Additional keyword arguments. See GHArtist and PrimitiveArtist for more info.

Attributes

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

• color_origin (Color) – 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 frame's axes.
draw_origin	Draw the frame's origin.

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.