Don’t expect these code snippets to work flawlessly in every context, they prioritise conciseness and being easy to read over any form of robustness

</aside>

User Interface

Button

def print_hello_world():
    print("Hello World")

ui.Button("Print Hello World", clicked_fn=print_hello_world)

Text box input

def on_end_edit_string(self, item_model):
    string_value = item_model.as_string
    print(string_value)

self.string_model = ui.SimpleStringModel()
ui.StringField(model=self.string_model)
self.val_changed_id = self.string_model.subscribe_end_edit_fn(on_end_edit_string)

High-level Commands

Create a cube

def create_cube():
    attr = {'size': 100.0, 'extent': [(-50.0, -50.0, -50.0), (50.0, 50.0, 50.0)]}
    omni.kit.commands.execute('CreatePrimWithDefaultXform', prim_type='Cube', attributes=attr)

Change the name of a prim

def rename_prim(old_path="/World", new_path="/Renamed_World"):
    omni.kit.commands.execute("MovePrim", path_from=old_path, path_to=new_path)

Create a child prim to another prim

def create_child_prim(parent_path="/World"):
    child_path = parent_path + "/I_am_a_child"
    attr = {'size': 100.0, 'extent': [(-50.0, -50.0, -50.0), (50.0, 50.0, 50.0)]}
    omni.kit.commands.execute('CreatePrimWithDefaultXform', prim_type='Cube', attributes=attr, prim_path = child_path)

Low-level API

Get the stage and its default prim

def get_stage() -> Tuple[Usd.Stage, Usd.Prim]:
    context: omni.usd.UsdContext = omni.usd.get_context()
    stage: Usd.Stage = context.get_stage()  # Usd from 'pxr'
    default_prim: Usd.Prim = stage.GetDefaultPrim()
    print(f"{stage} | {default_prim}")
    return stage, default_prim