omni.flux.stage_manager.plugin.column

• omni.flux.stage_manager.plugin.column
• Changelog

• SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.

• SPDX-License-Identifier: Apache-2.0

• Licensed under the Apache License, Version 2.0 (the “License”);

• you may not use this file except in compliance with the License.

• You may obtain a copy of the License at

• https://www.apache.org/licenses/LICENSE-2.0

• Unless required by applicable law or agreed to in writing, software

• distributed under the License is distributed on an “AS IS” BASIS,

• WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

• See the License for the specific language governing permissions and

• limitations under the License.

• SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.

• SPDX-License-Identifier: Apache-2.0

• Licensed under the Apache License, Version 2.0 (the “License”);

• you may not use this file except in compliance with the License.

• You may obtain a copy of the License at

• https://www.apache.org/licenses/LICENSE-2.0

• Unless required by applicable law or agreed to in writing, software

• distributed under the License is distributed on an “AS IS” BASIS,

• WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

• See the License for the specific language governing permissions and

• limitations under the License.

pydantic model omni.flux.stage_manager.plugin.column.horizontal_column.HorizontalColumnPlugin

Show JSON schema

{
   "title": "HorizontalColumnPlugin",
   "type": "object",
   "properties": {
      "enabled": {
         "default": true,
         "description": "Whether the plugin should be enabled or not",
         "title": "Enabled",
         "type": "boolean"
      },
      "display_name": {
         "description": "The name to display in the column header",
         "title": "Display Name",
         "type": "string"
      },
      "tooltip": {
         "default": "",
         "description": "The tooltip to display when hovering over the column header",
         "title": "Tooltip",
         "type": "string"
      },
      "widgets": {
         "description": "Widgets to be displayed in the column",
         "items": {
            "$ref": "#/$defs/StageManagerWidgetPlugin"
         },
         "title": "Widgets",
         "type": "array"
      },
      "width": {
         "$ref": "#/$defs/ColumnWidth",
         "default": {
            "unit": "Fraction",
            "value": 1.0
         },
         "description": "Width of the column"
      },
      "centered_title": {
         "default": false,
         "description": "Whether the title should be centered or left-aligned",
         "title": "Centered Title",
         "type": "boolean"
      }
   },
   "$defs": {
      "ColumnWidth": {
         "properties": {
            "unit": {
               "$ref": "#/$defs/LengthUnit",
               "description": "The unit of the column width"
            },
            "value": {
               "description": "The value of the column width",
               "title": "Value",
               "type": "number"
            }
         },
         "required": [
            "unit",
            "value"
         ],
         "title": "ColumnWidth",
         "type": "object"
      },
      "LengthUnit": {
         "enum": [
            "Fraction",
            "Percent",
            "Pixel"
         ],
         "title": "LengthUnit",
         "type": "string"
      },
      "StageManagerWidgetPlugin": {
         "description": "A plugin that provides a widget for the TreeView",
         "properties": {
            "enabled": {
               "default": true,
               "description": "Whether the plugin should be enabled or not",
               "title": "Enabled",
               "type": "boolean"
            },
            "display_name": {
               "description": "The string to display when displaying the plugin in the UI",
               "title": "Display Name",
               "type": "string"
            },
            "tooltip": {
               "description": "The tooltip to display when hovering over the plugin in the UI",
               "title": "Tooltip",
               "type": "string"
            }
         },
         "required": [
            "display_name",
            "tooltip"
         ],
         "title": "StageManagerWidgetPlugin",
         "type": "object"
      }
   },
   "required": [
      "display_name",
      "widgets"
   ]
}

Config:

• arbitrary_types_allowed: bool = True

Fields:

build_overview_ui(

model: _StageManagerTreeModel,

)

build_ui(

model: _StageManagerTreeModel,

item: _StageManagerTreeItem,

level: int,

expanded: bool,

)

Build the UI for the given column. This function will be used within a delegate and should therefore only build the UI for a single element.

model_post_init(context: Any, /) → None

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

• self – The BaseModel instance.

• context – The context.

name: ClassVar[str] = 'HorizontalColumnPlugin'