SceneListDefinitionsTask
OPAL task construct.scene.list_definitions: list the SDF definitions a document can use.
| Inherits | construct::opal::ConstructQueryTask |
| Group | construct |
In the namespace construct::opal. Declared in src/libs/libconstruct/construct/opal/SceneListDefinitionsTask.hpp.
Detailed description
The task lists what the active document resolves: its own definitions over the built-in catalog. With no document it lists the catalog. The optional family parameter filters the list: a family path keeps the definitions of that family and of every family below it (definition-taxonomy §DTX-D2). A definition tagged transient is not listed.
Each entry gives the id, the name, the summary, the family, the audience, where the definition lives (scene, library or builtin), whether it is a primitive or an operator, and its parameters with their descriptions, defaults and limits. A position transform also gives what the editor knows about its inverse. The task does not return shader code; construct.definition.get does.
See also DefinitionGetTask, DefinitionUpdateTask.