cambrian.renderer.overlays¶

Defines utilities for overlays in the Mujoco viewer.

Classes¶

`MjCambrianViewerOverlay`	This class is used to add an overlay to the viewer.
`MjCambrianTextViewerOverlay`	This class is used to add text to the viewer.
`MjCambrianImageViewerOverlay`	This class is used to add an image to the viewer.
`MjCambrianSiteViewerOverlay`	This class is used to add a site to the viewer.

class MjCambrianViewerOverlay(obj, cursor=None)[source]¶

This class is used to add an overlay to the viewer.

Note

This is applied only to the passed scene, so other scenes (i.e. ones for the eyes) will not be affected.

draw_after_render(mjr_context, viewport)[source]¶: Called after rendering the scene.

place(cursor)[source]¶

Places the cursor at the given location. Won’t overwrite the current cursor, if it exists.

static create_text_overlay(text, *, cursor=None)[source]¶: Creates a text overlay.

static create_image_overlay(obj, *, cursor=None)[source]¶: Creates an image overlay.

static create_site_overlay(pos, rgba, size, geom_kwargs=dict(emission=0.25))[source]¶: Creates a site overlay.

class MjCambrianTextViewerOverlay(obj, cursor=None)[source]¶

This class is used to add text to the viewer.

draw_after_render(mjr_context, viewport)[source]¶: Called after rendering the scene.

place(cursor)[source]¶

Places the cursor at the given location. Won’t overwrite the current cursor, if it exists.

class MjCambrianImageViewerOverlay(obj, cursor=None)[source]¶

This class is used to add an image to the viewer.

draw_after_render(mjr_context, viewport)[source]¶: Called after rendering the scene.

place(cursor)[source]¶

Places the cursor at the given location. Won’t overwrite the current cursor, if it exists.

class MjCambrianSiteViewerOverlay(pos, rgba, size, geom_kwargs=dict(emission=0.25))[source]¶

This class is used to add a site to the viewer.

Todo

Make this an image overlay where the pos is converted to pixel coordinates.