ghosting is undoable, queryable, and editable.
Provides an aggregated interface to all of the node-base ghosting parameters, as well
as the global preferences used by this command for ghosting actions.
Query the 'enable' flag to check if ghost drawing is currently enabled.
If you run in create mode with no 'action' set then you will be modifying the current values of the ghosting parameters.
If you have 'action=ghost' set then you will be modifying the current values of the ghosting parameters and then applying them to selected objects.
boolean | the previous global state of ghost visibility (after setting 'enable' flag) |
boolean | the global state of ghost visibility (query 'enabled' flag) |
boolean | the global state of the default ghost all-in-range value (query 'allInRange' flag) |
boolean | the global state of the default ghost hierarchy (query 'hierarchy' flag) |
boolean | the global state of the default ghost geometry filter (query 'geometryFilter' flag) |
boolean | the global state of the default ghost joint filter (query 'jointFilter' flag) |
boolean | the global state of the default ghost locator filter (query 'locatorFilter' flag) |
boolean | the global state of the default post frame count (query 'postFrames' flag) |
boolean | the global state of the default pre frame count (query 'preFrames' flag) |
boolean | the global state of the default ghost frames step count (query 'ghostsStep' flag) |
string[] | List of all objects for which ghosting was enabled ('action="ghost"' in create mode) |
string[] | List of all objects for which ghosting was disabled ('action="unghost"' or 'action="unghostAll"' in create mode) |
string[] | List of all objects for which ghosting is currently enabled (query 'ghostedObjects' flag) |
string[] | List of affected objects (any flag in edit mode) |
float[] | List of (frame1, frame2, ...) that is the union of ghosted frames on all selected objects (query 'frames' flag) |
float | Current opacity value for ghosts farthest from the current time (query 'farOpacity' flag) |
float | Current opacity value for ghosts closest to the current time (query 'nearOpacity' flag) |
float | The previous opacity value for ghosts farthest from the current time (set 'farOpacity' flag) |
float | The previous opacity value for ghosts closest to the current time (set 'nearOpacity' flag) |
string | Current ghosting mode (query 'mode' flag) |
string | The previous ghosting mode (set 'mode' flag) |
float[] | Color as [red, green, blue] used for ghosts after the current time (query 'postColor' flag) |
float[] | Previous color as [red, green, blue] used for ghosts after the current time (set 'postColor' flag) |
float[] | Color as [red, green, blue] used for ghosts before the current time (query 'preColor' flag) |
float[] | Previous color as [red, green, blue] used for ghosts before the current time (set 'preColor' flag) |
int[] | Custom frame list for the 'frames' mode (query 'customFrames' flag) |
int[] | Previous custom frame list (set 'customFrames' flag) |
In query mode, return type is based on queried flag.
Long name (short name) |
Argument types |
Properties |
-action(-act)
|
string
|
|
|
Define the actions to be performed by the command. Legal values are
"ghost", "unghost", and "unghostAll".
The "ghost" will try to enable ghosting on all _visible_ DAG objects in the selection list.
Imtermediate transform nodes will only be ghosted if axis display are active.
|
|
-allGhostedObjects(-ago)
|
|
|
|
Only works in edit mode, specifying that the edits are to be applied to all ghosted objects instead of just the selected ones.
|
|
-allInRange(-a)
|
boolean
|
|
|
In create mode, define the default value for whether keyframe mode should use every keyframe in the playback range or use the specified values.
In edit mode, modify the all-in-range value for all ghosts.
In create mode with the "ghost" action, also set the custom ghost all-in-range value for the selected objects.
|
|
-customFrames(-cf)
|
int
|
|
|
In create mode, define the default value for the list of custom ghost frames.
In edit mode, modify the custom ghost frames for all ghosts. The special frame number "-9999999" is used
to remove all custom frames, circumventing a quirk in the command engine that does not allow passing an empty list.
In create mode with the "ghost" action, also set the custom ghost frames for the selected objects.
|
|
-enable(-en)
|
boolean
|
|
|
Enables or disables ghost visibility on the entire scene. This does not modify
any of the node ghosting attributes, it only globally enables or disables the
drawing of any ghosts that have been defined on nodes.
This is a preference-based flag so its value will persist between sessions,
even if you load a new file with different ghost attribute settings.
|
|
-farOpacity(-fo)
|
float
|
|
|
In create mode, define the default value for the opacity value for ghosts farthest away from the current time.
In edit mode, modify the opacity value of ghosts farthest away from the current time for all ghosts.
In create mode with the "ghost" action, also set the opacity value of ghosts farthest away from the current time for the selected objects.
|
|
-frames(-f)
|
|
|
|
Queries the current set of ghost frames on the selected objects based on the ghosting
mode, parameters set on the object, and the current time when relevant. Ignores the state
of the ghosting enabled flag.
|
|
-geometryFilter(-gf)
|
boolean
|
|
|
In create mode, enable or disable the default ghost geometry filter.
In create mode with the "ghost" action set, also filter the selection to omit geometry nodes if this flag is false.
|
|
-ghostedObjects(-go)
|
|
|
|
Only works in query mode to find the names of all currently ghosted DAG nodes.
|
|
-ghostsStep(-gs)
|
int
|
|
|
In create mode, define the default value for the number of steps (keyframes or frames) between ghosts.
In edit mode, modify the number of steps (keyframes or frames) between ghosts.
In create mode with the "ghost" action, also set the default number of steps (keyframes or frames) between ghosts for the selected objects.
|
|
-hierarchy(-h)
|
boolean
|
|
|
Enables or disables the ghost hierarchy default value. When no ghosting action is set it does
not modify any of the node ghosting attributes, it only sets the preference for how
future commands will filter the list of affected nodes.
When used in conjunction with a ghosting action it will fist set the preference value and
then use that new value as a filter on the ghosting action. If a ghosting action is specified
without this flag then the current value of the preference is used in its place.
This is a preference-based flag so its value will persist between sessions,
even if you load a new file with different ghost attribute settings.
|
|
-jointFilter(-jf)
|
boolean
|
|
|
In create mode, enable or disable the default ghost joint filter.
In create mode with the "ghost" action set, also filter the selection to omit joint nodes if this flag is false.
|
|
-locatorFilter(-lf)
|
boolean
|
|
|
In create mode, enable or disable the default ghost locator filter.
In create mode with the "ghost" action set, also filter the selection to omit locator nodes if this flag is false.
|
|
-mode(-m)
|
string
|
|
|
Define the default mode for ghosting actions. Legal values are "preAndPost",
"pre", "post", "custom", and "keyframes".
|
|
-nearOpacity(-no)
|
float
|
|
|
In create mode, define the default value for the opacity value for ghosts nearest to the current time.
In edit mode, modify the opacity value of ghosts nearest to the current time for all ghosts.
In create mode with the "ghost" action, also set the opacity value of ghosts nearest to the current time for the selected objects.
|
|
-postColor(-poc)
|
float float float
|
|
|
In create mode, define the default value for the color of ghosts after the current time.
In edit mode, modify the color of ghosts after the current time for all ghosts.
In create mode with the "ghost" action, also set the color of ghosts after the current time for the selected objects.
|
|
-postFrames(-pof)
|
int
|
|
|
In create mode, define the default value for the number of ghosted frames after the current time.
In edit mode, modify the number of ghosted frames after the current time for all ghosts.
In create mode with the "ghost" action, also set the default number of ghosted frames after the current time for the selected objects.
|
|
-preColor(-prc)
|
float float float
|
|
|
In create mode, define the default value for the color of ghosts before the current time.
In edit mode, modify the color of ghosts before the current time for all ghosts.
In create mode with the "ghost" action, also set the color of ghosts before the current time for the selected objects.
|
|
-preFrames(-prf)
|
int
|
|
|
In create mode, define the default value for the number of ghosted frames before the current time.
In edit mode, modify the number of ghosted frames before the current time for all ghosts.
In create mode with the "ghost" action, also set the default number of ghosted frames before the current time for the selected objects.
|
|
-preset(-p)
|
string
|
|
|
Define the default mode for ghosting presets. Legal values are "1s", "2s", "4s", "5s", "10s", and "Custom".
Setting anything other than "Custom" fixes ghosts at 3 pre frames, 3 post frames, with a step value of the preset
(e.g. "2s" means show ghosts at every second frame or keyframe)
|
|
-resetAll(-r)
|
|
|
|
Reset all ghosting options to their default values. Use with caution!
|
|
-useDriver(-ud)
|
boolean
|
|
|
In create mode, enable or disable the default ghost use driver value.
In edit mode, modify the use driver value of all existing ghosts.
In create mode with the "ghost" action, also set the use driver value for the selected objects.
|
|