prepareRender is undoable, queryable, and editable.
This command is used to register, manage and invoke render traversals.
Render traversals are used to configure a scene to prepare it for rendering.
In query mode, return type is based on queried flag.
Long name (short name) |
Argument types |
Properties |
-defaultTraversalSet(-dt)
|
string
|
|
|
Set or query the default traversal set. The prepareRender
command performs operations on the default traversal set, unless the
-traversalSet flag is used to specify an explicit traversal set.
|
|
-deregister(-d)
|
string
|
|
|
Deregister a registered traversal set. If the deregistered traversal set is
the default traversal set, the new default traversal set will be the "null"
traversal set.
|
|
-saveAssemblyConfig(-sac)
|
boolean
|
|
|
Set or query whether or not the assembly active representation configuration
for the whole scene should be saved for a given traversal set. The traversal
set will be the default, unless the -traversalSet flag is used to specify an
explicit traversal set.
|
|
-label(-lbl)
|
string
|
|
|
Set or query the label for a given traversal set. The label is used for UI
display purposes, and can be localized. The traversal set will be the default,
unless the -traversalSet flag is used to specify an explicit traversal set.
|
|
-listTraversalSets(-lt)
|
|
|
|
Query the supported render traversal sets.
|
|
-preRender(-prr)
|
script
|
|
|
Set or query the preRender render traversal for a given traversal
set. This traversal is run before a render. The traversal set will be the
default traversal set, unless the -traversalSet flag is used to specify an
explicit traversal set.
|
|
-postRender(-por)
|
script
|
|
|
Set or query the postRender render traversal for a given traversal
set. This traversal is run after a render. The traversal set will be the
default traversal set, unless the -traversalSet flag is used to specify an
explicit traversal set.
|
|
-preRenderLayer(-prl)
|
script
|
|
|
Set or query the preRenderLayer render traversal for a given traversal
set. This traversal is run before a render layer is rendered, within a
render. The traversal set will be the default traversal set, unless the
-traversalSet flag is used to specify an explicit traversal set.
|
|
-postRenderLayer(-pol)
|
script
|
|
|
Set or query the postRenderLayer render traversal for a given traversal
set. This traversal is run after a render layer is rendered, within a
render. The traversal set will be the default traversal set, unless the
-traversalSet flag is used to specify an explicit traversal set.
|
|
-preRenderFrame(-prf)
|
script
|
|
|
Set or query the preRenderFrame render traversal for a given traversal
set. This traversal is run before the render of a single frame, with a
render layer. The traversal set will be the default traversal set, unless
the -traversalSet flag is used to specify an explicit traversal set.
|
|
-postRenderFrame(-pof)
|
script
|
|
|
Set or query the postRenderFrame render traversal for a given traversal
set. This traversal is run after the render of a single frame, with a
render layer. The traversal set will be the default traversal set, unless
the -traversalSet flag is used to specify an explicit traversal set.
|
|
-invokePreRender(-irr)
|
|
|
|
Invoke the preRender render traversal for a given traversal
set. The traversal set will be the default traversal set, unless the
-traversalSet flag is used to specify an explicit traversal set.
|
|
-invokePostRender(-ior)
|
|
|
|
Invoke the postRender render traversal for a given traversal
set. The traversal set will be the default traversal set, unless the
-traversalSet flag is used to specify an explicit traversal set.
|
|
-invokePreRenderLayer(-irl)
|
|
|
|
Invoke the preRenderLayer render traversal for a given traversal
set. The traversal set will be the default traversal set, unless the
-traversalSet flag is used to specify an explicit traversal set.
|
|
-invokePostRenderLayer(-iol)
|
|
|
|
Invoke the postRenderLayer render traversal for a given traversal
set. The traversal set will be the default traversal set, unless the
-traversalSet flag is used to specify an explicit traversal set.
|
|
-invokePreRenderFrame(-irf)
|
|
|
|
Invoke the preRenderFrame render traversal for a given traversal
set. The traversal set will be the default traversal set, unless the
-traversalSet flag is used to specify an explicit traversal set.
|
|
-invokePostRenderFrame(-iof)
|
|
|
|
Invoke the postRenderFrame render traversal for a given traversal
set. The traversal set will be the default traversal set, unless the
-traversalSet flag is used to specify an explicit traversal set.
|
|
-setup(-stp)
|
|
|
|
Setup render preparation, including saving the assembly active representation
configuration for the whole scene, if the saveAssemblyConfig flag for
the traversal set is true. Any previously-saved configuration will be
overwritten. The traversal set will be the default traversal set, unless the
-traversalSet flag is used to specify an explicit traversal set.
|
|
-restore(-rtr)
|
|
|
|
Clean up after rendering, including restoring the assembly active
representation configuration for the whole scene, if the saveAssemblyConfig
flag for the traversal set is true. The traversal set will be the default
traversal set, unless the -traversalSet flag is used to specify an explicit
traversal set.
|
|
-traversalSet(-ts)
|
string
|
|
|
Set or query properties for the specified registered traversal set.
In query mode, this flag needs a value.
|
|
-settingsUI(-sui)
|
script
|
|
|
Set or query the settings UI callback for a given traversal set. The
traversal set will be the default traversal set, unless the -traversalSet
flag is used to specify an explicit traversal set.
|
|
-invokeSettingsUI(-isu)
|
|
|
|
Invoke the settings UI callback to populate a layout with UI controls,
for a given traversal set. The current UI parent will be a form layout,
which the callback can query using the setParent command. The traversal set
will be the default traversal set, unless the -traversalSet flag is used to
specify an explicit traversal set.
|
|
-traversalSetInit(-tsi)
|
script
|
|
|
Set or query the traversal set initialisation callback for a given traversal set.
The traversal set will be the default traversal set, unless the -traversalSet flag
is used to specify an explicit traversal set. This callback is invoked whenever
the specified traversal set becomes the default.
traversal set.
|
|