Implementation:Google deepmind Mujoco Platform GUI Header
| Knowledge Sources | |
|---|---|
| Domains | GUI, API Declaration |
| Last Updated | 2026-02-15 04:00 GMT |
Overview
Declares the public API for ImGui-based MuJoCo GUI panels including theme setup, docking layout, physics controls, visualization options, and rendering flag management.
Description
gui.h defines the interface for the MuJoCo platform GUI module. It declares the GuiTheme enum (kLight, kDark, kClassic), SetupTheme for applying themes, and ConfigureDockingLayout which establishes the standard Studio docking layout with named sections (ToolBar, StatusBar, Options, Inspector, Explorer, Stats, Properties). The header declares panel functions for physics (PhysicsGui), groups (GroupsGui), rendering (RenderingGui), and visualization (VisualizationGui) settings, each taking relevant MuJoCo structures as parameters. The file documents that GUI state storage is managed by the caller through MuJoCo data structures.
Usage
Included by app.cc and other platform applications to access the standard MuJoCo GUI panel functions. All functions are in the mujoco::platform namespace.
Code Reference
Source Location
- Repository: Google_deepmind_Mujoco
- File: src/experimental/platform/gui.h
- Lines: 1-129
Key Functions
enum class GuiTheme { kLight, kDark, kClassic };
void SetupTheme(GuiTheme theme);
ImVec4 ConfigureDockingLayout();
void PhysicsGui(mjModel* model, float min_width);
void GroupsGui(const mjModel* model, mjvOption* vis_options, float min_width);
void RenderingGui(const mjModel* model, mjvOption* vis_options, mjtByte* render_flags, float min_width);
void VisualizationGui(mjModel* model, mjvOption* vis_options, mjvCamera* camera, ...);
Import
#include "experimental/platform/gui.h"
I/O Contract
Inputs
| Name | Type | Required | Description |
|---|---|---|---|
| model | mjModel* | Yes | MuJoCo model for physics and visualization parameters |
| vis_options | mjvOption* | Yes | Visualization options for rendering and group flags |
| camera | mjvCamera* | No | Camera settings for visualization panel |
Outputs
| Name | Type | Description |
|---|---|---|
| ImVec4 | ImVec4 | Workspace area dimensions returned by ConfigureDockingLayout |