ProcessWriteUsd#
(Write Usd)
- Category:
Process
- Default object name:
write_usd
- Inherits from: ProjectItem > Process
Description#
Bakes the content of an input context into a USD stage.
Public Attributes#
Type | Name | Visual Hint | Description |
---|---|---|---|
reference |
input_context |
VISUAL_HINT_DEFAULT |
Input context to export. |
string |
filename |
VISUAL_HINT_FILENAME_SAVE |
Filename of the output stage. Choose .usda for text format (slow and huge file, only use for debug on small contexts) or .usdc for compact and fast binary format. |
long |
default_prim |
VISUAL_HINT_DEFAULT |
Configure the default prim of the exported stage. If 'Create' is chosen (default) an Xform root node will be created and used as the default prim. Otherwise you can choose an object from the scene to use as the default prim. In this case, beware that USD uses a kinematic hierarchy! |
reference (SceneItem ) |
root_prim |
VISUAL_HINT_DEFAULT |
Choose which object will be set as the root prim of the exported stage. Note that USD uses a kinematic hierarchy, so be careful when choosing. |
bool |
use_instances |
VISUAL_HINT_DEFAULT |
When true, objects used more than once will be encapsulated in an instanceable xform, and instances will be used instead of simple references. |
bool |
export_invisible_objects |
VISUAL_HINT_DEFAULT |
By default, objects that are always invisible will not be exported. Use this to force them to be exported (they will be flagged invisible in USD) |
bool |
export_displacement |
VISUAL_HINT_DEFAULT |
When checked (by default) displacement and subdivision will be baked in the exported geometry |
long |
anim_mode |
VISUAL_HINT_DEFAULT |
Choose what animation data to export. |
long |
custom_frame |
VISUAL_HINT_DEFAULT |
Specify the frame to export, when using Custom Range mode. |
long[2] |
custom_frame_range |
VISUAL_HINT_DEFAULT |
Specify the start/end frames to export, when using Custom Range mode. |
Inherited Public Attributes#
Type | Name | Visual Hint | Description |
---|---|---|---|
action |
run_process |
VISUAL_HINT_DEFAULT |
CID#
class "ProcessWriteUsd" "Process" {
#license {
flavor "advanced"
}
#version 0.1
icon "./icons/usd_export.iconrc"
doc "Bakes the content of an input context into a USD stage."
aliases "ProcessUsdExport"
attribute_group "input" {
reference "input_context" {
doc "Input context to export."
filter "Context"
value ""
}
}
attribute_group "output" {
filename_save "filename" {
doc "Filename of the output stage. Choose .usda for text format (slow and huge file, only use for debug on small contexts) or .usdc for compact and fast binary format."
extension "usdc" "usda"
value ""
}
long "default_prim" {
doc "Configure the default prim of the exported stage. If \'Create\' is chosen (default) an Xform root node will be created and used as the default prim. Otherwise you can choose an object from the scene to use as the default prim. In this case, beware that USD uses a kinematic hierarchy!"
preset "None" "0"
preset "Choose Existing" "1"
value 0
}
reference "root_prim" {
doc "Choose which object will be set as the root prim of the exported stage. Note that USD uses a kinematic hierarchy, so be careful when choosing."
filter "SceneItem"
read_only yes
value ""
}
bool "use_instances" {
doc "When true, objects used more than once will be encapsulated in an instanceable xform, and instances will be used instead of simple references."
value yes
}
bool "export_invisible_objects" {
doc "By default, objects that are always invisible will not be exported. Use this to force them to be exported (they will be flagged invisible in USD)"
value no
}
bool "export_displacement" {
doc "When checked (by default) displacement and subdivision will be baked in the exported geometry"
value yes
}
}
attribute_group "animation" {
long "anim_mode" {
doc "Choose what animation data to export."
preset "Current Frame" "0"
preset "Current Range" "1"
preset "Custom Frame" "2"
preset "Custom Range" "3"
value 0
}
long "custom_frame" {
doc "Specify the frame to export, when using `Custom Range` mode."
read_only yes
value 0
}
long[2] "custom_frame_range" {
doc "Specify the start/end frames to export, when using `Custom Range` mode."
read_only yes
value 0 0
}
}
}