opal (construct)

The OPAL tasks that read and edit a construct scene.

Group construct

In the namespace construct.

Detailed description

Each task is one step that an LLM or a plan can call: query the scene, its items, definitions, materials and variable sets, or change them, bake and export them. A mutating task runs its change on the GUI thread, on the live document.

Classes

Class What it is
BakeTask `construct.bake`: bake one SDF item into a tri mesh or a tet volume item, as the Bake menu does
CameraSetTask `construct.camera.set`: a camera item's projection and frame size (scene-tree-row-standard §RSO-1.2)
CondenseTask `construct.condense` — flatten an SDF branch into one frozen primitive
ConstructCaptureSource A construct scene OPAL can look at from a camera it places (opal-vision §OVD-5, D15)
ConstructPlanScope Construct's plan scope: a plan holds each document it edits (opal-plan-edit-sessions §PES-1, §PES-2)
ConstructStagedMutationTask Base for a mutation whose work must stay off the GUI thread
DefinitionAddTask OPAL task construct.definition.add: create a new SDF definition in the active document from its own GLSL
DefinitionEditorCameraTask OPAL task construct.definition_editor.camera: turn the camera of the live preview of the editor, or frame the definition again
DefinitionEditorDeleteTask OPAL task construct.definition_editor.delete: delete the definition that the editor shows, as the Delete button does
DefinitionEditorDuplicateTask OPAL task construct.definition_editor.duplicate: copy the definition that the editor shows, as the Duplicate button does
DefinitionEditorEditTask OPAL task construct.definition_editor.edit: change the record that the definition editor shows, as a control or a tab does
DefinitionEditorNewTask OPAL task construct.definition_editor.new: make a new definition from the template, as the New button does
DefinitionEditorOpenTask OPAL task construct.definition_editor.open: show the definition editor on one definition, as its Open… button does
DefinitionEditorRevertTask OPAL task construct.definition_editor.revert: give up the unsaved changes of the definition editor
DefinitionEditorSaveTask OPAL task construct.definition_editor.save: save the record that the definition editor shows to where the definition lives
DefinitionEditorStateTask OPAL task construct.definition_editor.state: read what the definition editor shows
DefinitionGetTask Return one definition in full, its GLSL source included
DefinitionPublishTask OPAL task construct.definition.publish: copy one of the definitions of this document to the user library
DefinitionUpdateTask OPAL task construct.definition.update: replace one of the document's own SDF definitions
DefinitionValidateTask Validate one definition record and return each finding with its editor tab and line
DefinitionVocabularyTask OPAL task construct.definition.vocabulary: the values a definition record may take
DocumentInfoTask `construct.document.info`: a summary of one document (opal-scene-facts §OSF-5 item 7): its file, units, item counts by type, the memory its meshes hold, and the counts that need attention
FieldColormapsTask `construct.field.colormaps`: the field colormaps of libstyle (field-presentation §FVO-2, §FVC-3, matrix FVW-32)
FieldExportVideoTask `construct.field.export_video`: a video of the deformation or of an axis of a tet volume (field-presentation §FVE-10, §FVO-2, matrix FVW-72)
FieldKernelsTask `construct.field.kernels`: the field kernel catalog (field-presentation §FVO-2, §FVK-5, matrix FVW-22)
FieldSampleTask `construct.field.sample`: the values of field references at a point of a tet volume (field-presentation §FVO-2, §FVS-1)
FieldVerdictTask `construct.field.verdict`: the verdict of the factor-of-safety view of an item (field-presentation §FVO-2, §FVU-8, matrix FVW-70)
ItemExportFileTask `construct.item.export_file`: write a mesh or tet item to a file as it is, as Export ▸ "... to file" does (construct-mesh-tet-items §MTO-1, §MTM-2)
ItemGetMaterialTask Construct.item.get_material: an item's effective material binding, the item it comes from, and its values with the defaults (rendering-revamp §RVO-1)
ItemImportFileTask `construct.item.import_file`: import a mesh or a tet volume file as an item, so the model can look at it (opal-mesh-references §OMO-1)
ItemMeasureTask `construct.item.measure`: the counts, edges, area, volume and quality of a mesh item or a tet volume, without an export (opal-scene-facts §OSF-3)
ItemSetRotationModeTask Construct-editing-ux §UD-4b — set an SDF item's rotation representation with a no-jump conversion (§RO-4a)
LibraryListTask `construct.library.*` tasks: the management of the user's library items, as the finder does it (definition-picker-library §DPLA-10)
LibraryTrashTask `construct.library.trash`: move the user's library items to the Trash. No task deletes for good or empties the Trash (ruling 13): a person can, in the finder
MaterialMutateTask Construct.material.mutate: change keys of a material record by path, without the whole text (rendering-revamp §RVO-1)
MaterialSampleTask Construct.material.sample: the OpenPBR inputs of an item's material at a surface point (rendering-revamp §RVO-1)
MaterialUpdateFromLibraryTask Construct.material.update_from_library: replace a scene record with the newer library record it was copied from, one undo step (rendering-revamp §RVM-5, §RVO-1)
PassengerProcessTask `construct.passenger.process`: run one step of the post-process chain on a mesh or tet item, as Mesh ▸ and Tet ▸ do (construct-mesh-tet-items §MTO-1, §MTM-4)
PresentationKindsTask Presentation tasks: `construct.presentation.kinds`, `.list`, `.add`, `.remove`, `.move`, `.set`, and `construct.legend.set` (field-presentation §FVO-2, matrix FVW-38)
ProbeAddTask Probe tasks of field-presentation §FVO-2 (phase 7): pinned points of a tet volume or a mesh item and their values, a line of samples, and the statistics of a field over a region
RenderCapabilitiesTask `construct.render.capabilities`: what this build and this computer can write, and the last measured frame cost of the scene (construct-render-settings §CRSA-9, matrix CRS-25)
RenderMeasureTask `construct.render.measure`: render 1 to 3 frames of the scene off screen with the render job's renderer, size and quality, write nothing, and answer the seconds per frame and for the whole range (§CRSA-5, matrix CRS-25)
RenderQueueTask `construct.render.*` tasks: the viewport's status, shading choice, pause and resume (rendering-revamp §RVO-2), and the render job's capabilities, measure, queue and export (construct-render-settings §CRSA-9)
SceneGroupSelectionTask Construct.scene.group_selection — put the selected items in a new group, as one undo step (scene-tree-ux-v3 §STG-O-3)
SceneListDefinitionsTask OPAL task construct.scene.list_definitions: list the SDF definitions a document can use
SceneSetSelectionTask Construct.scene.set_selection — write the selection the tree and the viewport show (scene-tree-ux-v3 §STG-O-2)
SceneUngroupTask Construct.scene.ungroup — dissolve a group into its parent, as one undo step (scene-tree-ux-v3 §STG-O-3)
StepDocument A staged task's handle on its document, safe on any thread
TetCompareTask `construct.tet.compare`: compare a tet volume with one of its kept solves, as Tet ▸ Compare with ▸ and Show difference do (field-presentation §FVO-2, §FVE-11, matrix FVW-74)
TetHistoryTask `construct.tet.history`: the kept solves of a tet volume, and a pin that keeps one (field-presentation §FVO-2, §FVE-11, matrix FVW-74)
TetQualityTask `construct.tet.quality`: the quality report of a tet volume item (tet-volume-improve §TVIA-7)
TetRemoveResultsTask `construct.tet.remove_results`: take the results of a solve off a tet volume, as Tet ▸ Remove results does (construct-fea-solve §FEO-1)
TetSolveTask `construct.tet.solve`: a linear static solve of one tet volume, as Tet ▸ Solve… runs it (construct-fea-solve §FEO-1)
ThumbnailGetTask Construct.thumbnail.get — the cached picture of one primitive (opal-vision §OVD-5.1)
ViewClockTask `construct.view.clock`: read and set the view clock of a document (field-presentation §FVG-6, §FVO-2)
ViewLabelsTask `construct.view.labels`: the anchored labels of the viewport that shows the document (field-presentation §FVO-2, §FVL-4)
ViewLegendsTask `construct.view.legends`: the field legends of the viewport, as a person sees them (construct-fea-solve §FEO-1)
In this section