Is this page helpful?

[isaacsim.gui.menu] Isaac Sim Menus#

Version: 2.10.5

Overview#

The isaacsim.gui.menu extension provides Isaac Sim-specific menu bar functionality for robotics applications. It creates and manages multiple specialized menus including File, Edit, Create, Window, Tools, Utilities, Layouts, and Help menus, each tailored with robotics-focused operations and Isaac Sim assets.

Key Components#

Asset Creation Functions#

The extension provides specialized functions for creating Isaac Sim assets, including create_asset() for referencing USD assets with optional camera positioning and create_apriltag() for generating AprilTag materials with custom tag textures.

Functionality#

Each menu extension is responsible for registering its menu items, managing menu state, and handling menu-specific actions. The extensions provide validation methods to determine when menu items should be enabled or disabled based on current stage state, selection, and live session status.

The Edit menu includes advanced prim operations like instancing, duplication across layers, parenting with validation, and screenshot capture with configurable save paths. The Create menu focuses on robotics asset creation and material generation specific to Isaac Sim workflows.

All menu extensions follow a consistent lifecycle pattern with initialization that takes an extension ID and a shutdown method that removes menu layouts and cleans up resources.

Enable Extension#

The extension can be enabled (if not already) in one of the following ways:

Define the next entry as an application argument from a terminal.

APP_SCRIPT.(sh|bat) --enable isaacsim.gui.menu

Define the next entry under [dependencies] in an experience (.kit) file or an extension configuration (extension.toml) file.

[dependencies]
"isaacsim.gui.menu" = {}

Open the Window > Extensions menu in a running application instance and search for isaacsim.gui.menu. Then, toggle the enable control button if it is not already active.

Actions in isaacsim.gui.menu#

ID

Display Name

Description

create_env_black_grid

Create Black Grid

Create a Black Grid environment

create_env_flat_grid

Create Flat Grid

Create a Flat Grid environment

create_env_simple_room

Create Simple Room

Create a Simple Room environment

create_robot_ant

Create Ant

Create a Ant robot

create_robot_franka

Create Franka Emika Panda Arm

Create a Franka Emika Panda Arm robot

create_robot_humanoid

Create Humanoid

Create a Humanoid robot

create_robot_nova_carter

Create Nova Carter with Sensors

Create a Nova Carter with Sensors robot

create_robot_quadcopter

Create Quadcopter

Create a Quadcopter robot

create_robot_spot

Create Boston Dynamics Spot

Create a Boston Dynamics Spot robot

open_content_browser_environments

Open Content Browser (Environments)

Open the Content Browser to the Environments folder

open_content_browser_robots

Open Content Browser (Robots)

Open the Content Browser to the Robots folder

open_content_browser_sensors

Open Content Browser (Sensors)

Open the Content Browser to the Sensors folder

open_isaac_forums

Open Isaac Sim Online Forums

Open the Isaac Sim online forums

open_isaac_online_guide

Open Isaac Sim Online Guide

Open the Isaac Sim online documentation

open_isaac_scripting_manual

Open Isaac Sim Scripting Manual

Open the Isaac Sim Python scripting manual

open_kit_manual

Open Kit Programming Manual

Open the Kit programming manual

open_openusd_reference

Open OpenUSD Reference Guide

Open the OpenUSD reference documentation

open_physics_manual

Open Physics Programming Manual

Open the physics programming manual

open_warp_documentation

Open Warp Documentation

Open the Warp reference documentation

open_warp_getting_started

Open Warp Getting Started

Open the Warp getting started documentation