FrameArtist

class compas_rhino.artists.FrameArtist(frame, layer=None, scale=1.0)[source]

Bases: compas_rhino.artists._primitiveartist.PrimitiveArtist

Artist for drawing frames.

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

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

Notes

See compas_rhino.artists.PrimitiveArtist for all other parameters.

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

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

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

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

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

Examples

from compas.geometry import Pointcloud
from compas.geometry import Frame

import compas_rhino
from compas_rhino.artists import FrameArtist

pcl = Pointcloud.from_bounds(10, 10, 10, 100)
tpl = Frame([0, 0, 0], [1, 0, 0], [0, 1, 0])

compas_rhino.clear_layer("Test::FrameArtist")

for point in pcl.points:
    frame = tpl.copy()
    frame.point = point
    artist = FrameArtist(frame, layer="Test::FrameArtist")
    artist.draw()

Methods

__init__(frame[, layer, scale])

Initialize self.

build(item, **kwargs)

Build an artist corresponding to the item type.

clear()

clear_layer()

Clear the layer containing the artist.

draw()

Draw the frame.

redraw()

register(item_type, artist_type)