Frame

Frames represented by an origin and three colored axes.

Example

import meshcat
import meshcat_shapes

vis = meshcat.Visualizer().open()

meshcat_shapes.frame(
    vis["my_frame"],
    axis_length=0.2,
    axis_thickness=0.01,
    opacity=0.8,
    origin_radius=0.02,
)
meshcat_shapes.frame.frame(handle, axis_length=0.1, axis_thickness=0.005, opacity=1.0, origin_color=0, origin_radius=0.01)

Set MeshCat handle to a frame, represented by an origin and three axes.

Parameters:
  • handle (Visualizer) – MeshCat handle to attach the frame to.

  • axis_length (float) – Length of axis unit vectors, in [m].

  • axis_thickness (float) – Thickness of axis unit vectors, in [m].

  • opacity (float) – Opacity of all three unit vectors.

  • origin_color (int) – Color of the origin sphere.

  • origin_radius (float) – Radius of the frame origin sphere, in [m].

Return type:

None

Note

As per the de-facto standard (Blender, OpenRAVE, RViz, …), the x-axis is red, the y-axis is green and the z-axis is blue.