Shelf

Shelves hold commonly used actions and tools. A shelf can be added with the Shelf Editor or with the Python API. Custom shelves created with Shelf Editor can also be extended with the Script Editor by pressing the small_shelf Add to shelf button.

../../_images/shelf.png

Shelves

Built-in shelves can’t be edited with the GUI but can be extended using Python APIs.

General

Button

Action

create_ref

Create reference

camera

Create camera

Geometry

Button

Action

mesh

Create polygonal plane with settings

s_mesh

Create polygonal sphere with settings

cube

Create cube

sphere

Create sphere

cylinder

Create cylinder

cone

Create cone

capsule

Create capsule

sculpt

Sculpt Tool

paint

Paint Primvar Tool

Light

Button

Action

light_cylinder

Create UsdLuxCylinderLight

light_disk

Create UsdLuxDiskLight

light_distant

Create UsdLuxDistantLight

light_environment

Create UsdLuxDomeLight

light_quad

Create UsdLuxRectLight

light_sphere

Create UsdLuxSphereLight

Instancer

Note

Violet color represents instancing.

Button

Action

pointinstancer

Create PointInstancer

paint_instance

Point Instancer Tool

Shelf Editor

Note

Custom shelves are shelves that are created with the Shelf Editor. Only custom shelves can be edited with the Shelf Editor or the Script Editor.

The Shelf Editor can create and edit custom shelves. It can be accessed by pressing the gear gear button or right-click on a custom shelf or one of its actions.

../../_images/shelf_editor.png

Custom actions can also be separators, have an icon, or be displayed as text if they don’t have an icon.

You can use a built-in icon or type any file path.

Custom shelves are saved as separate JSON files so they can be copied to another machine if needed.