compas_robots.rhino.scene

This package provides functionality for visualizing robot models in Rhino.

Classes

RobotModelObject

RobotModelObject(**kwargs)

Scene object for drawing robot models.

Parameters:

• **kwargs (dict, default: {} ) –

  Additional keyword arguments. For more info, see RhinoSceneObject and BaseRobotModelObject.

Functions

clear_layer

clear_layer()

Clear the main layer of the scene object.

Returns:

• None –

create_geometry

create_geometry(geometry: Mesh, name: str | None = None, color: Color | None = None)

Create a Rhino mesh corresponding to the geometry of the model.

Parameters:

• geometry (Mesh) –

  Instance of a mesh data structure

• name (str | None, default: None ) –

  The name of the mesh to draw.

• color (Color | None, default: None ) –

  The color of the object.`

Returns:

• `Rhino.Geometry.Mesh` –

draw

draw()

Draw the geometry of the model.

Returns:

• list[Guid] –

  The GUIDs of the created Rhino objects.

draw_attached_meshes

draw_attached_meshes()

Draw all the geometries attached to the robot model.

Returns:

• list[Guid] –

  The GUIDs of the created Rhino objects.

draw_collision

draw_collision()

Draw all the collision geometries of the robot model.

Returns:

• list[Guid] –

  The GUIDs of the created Rhino objects.

draw_visual

draw_visual()

Draw all the visual geometries of the robot model.

Returns:

• list[Guid] –

  The GUIDs of the created Rhino objects.

redraw

redraw(timeout: float = None)

Redraw the Rhino view.

Parameters:

• timeout (float, default: None ) –

  The amount of time the scene object waits before updating the Rhino view. The time should be specified in seconds.