omni.kit.window.file Functions#

Functions Summary:

add_reference

Prompt for the file to add reference or payload to.

close

Check if current stage is dirty. If it’s dirty, it will ask if to save the file, then close stage.

get_instance

Get the file utils instance.

new

Create a new USD stage. If currently opened stage is dirty, a prompt will show to let you save it.

open

Bring up a file picker to choose a USD file to open. If currently opened stage is dirty, a prompt will show to let you save it.

open_stage

Open stage. If the current stage is dirty, a prompt will show to let you save it.

open_with_new_edit_layer

Open stage and create a new edit layer.

prompt_if_unsaved_stage

Check if current stage is dirty. If it’s dirty, ask to save the file, then execute callback. Otherwise runs callback directly.

register_open_stage_addon

Register callback to call when opening a stage.

register_open_stage_complete

Register callback to call when finish opening a stage.

reopen

Reopen currently opened stage. If the stage is dirty, a prompt will show to let you save it.

save

Save currently opened stage to file. Will call Save As for a newly created stage.

save_as

Bring up a file picker to choose a file to save current stage to.

save_layers

Save current layers.