• OctoMY API
  • OctoMY API Reference
  • C++ Classes
  • OctoMY
  • SceneListDefinitionsTask
  • construct::opal::SceneListDefinitionsTask Class

    OPAL task construct.scene.list_definitions: list the SDF definitions a document can use. More...

    Header: #include <SceneListDefinitionsTask>
    Inherits: construct::opal::ConstructQueryTask

    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 category parameter filters the list. A definition tagged transient is not listed.

    Each entry gives the id, the name, the category, 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 and DefinitionUpdateTask.