omni.flux.validator.plugin.selector.usd#

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.

class omni.flux.validator.plugin.selector.usd.extension.FluxValidatorPluginSelectorUSDExtension#

Bases: IExt

Create Final Configuration

on_shutdown()#

on_startup(ext_id)#

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.

class omni.flux.validator.plugin.selector.usd.all_lights.AllLights#

Bases: SelectorUSDBase

pydantic model Data#

Bases: Data

Show JSON schema

{
   "title": "Data",
   "type": "object",
   "properties": {
      "on_progress_callback": {
         "default": null,
         "title": "On Progress Callback"
      },
      "on_global_progress_callback": {
         "default": null,
         "title": "On Global Progress Callback"
      },
      "data_flows": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/DataFlow"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Data Flows"
      },
      "channel": {
         "default": "Default",
         "title": "Channel",
         "type": "string"
      },
      "expose_mass_ui": {
         "default": false,
         "title": "Expose Mass Ui",
         "type": "boolean"
      },
      "expose_mass_queue_action_ui": {
         "default": false,
         "title": "Expose Mass Queue Action Ui",
         "type": "boolean"
      },
      "cook_mass_template": {
         "default": false,
         "description": "Set this to true if you want the mass validator to use the plugin to cook the template",
         "title": "Cook Mass Template",
         "type": "boolean"
      },
      "display_name_mass_template": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name to show when we process a cooked template from mass processing",
         "title": "Display Name Mass Template"
      },
      "display_name_mass_template_tooltip": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Tooltip to show when we process a cooked template from mass processing",
         "title": "Display Name Mass Template Tooltip"
      },
      "uuid": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "UUID of the plugin",
         "title": "Uuid"
      },
      "progress": {
         "anyOf": [
            {
               "maxItems": 3,
               "minItems": 3,
               "prefixItems": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "boolean"
                  }
               ],
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [
            0.0,
            "Initializing",
            true
         ],
         "description": "Progress of the plugin",
         "title": "Progress"
      },
      "global_progress_value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.0,
         "description": "Global progress value of the plugin",
         "title": "Global Progress Value"
      },
      "on_select_callback": {
         "default": null,
         "title": "On Select Callback"
      },
      "last_select_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Message"
      },
      "last_select_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Select Data"
      },
      "last_select_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Timing"
      },
      "last_select_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Result"
      },
      "select_from_root_layer_only": {
         "default": false,
         "title": "Select From Root Layer Only",
         "type": "boolean"
      },
      "light_types": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/LightType"
               },
               "type": "array",
               "uniqueItems": true
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Light Types"
      }
   },
   "$defs": {
      "DataFlow": {
         "additionalProperties": false,
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "channel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Default",
               "title": "Channel"
            }
         },
         "required": [
            "name"
         ],
         "title": "DataFlow",
         "type": "object"
      },
      "LightType": {
         "enum": [
            "DomeLight",
            "DiskLight",
            "RectLight",
            "SphereLight",
            "CylinderLight",
            "DistantLight",
            "UnknownLight"
         ],
         "title": "LightType",
         "type": "string"
      }
   },
   "additionalProperties": false
}

Config:

extra: str = forbid
validate_assignment: bool = True
arbitrary_types_allowed: bool = True

Fields:

light_types (set[omni.flux.validator.plugin.selector.usd.all_lights.LightType] | None)

Validators:

_fire_global_progress_value_callback » global_progress_value
_fire_last_select_result_callback » last_select_result
_fire_progress_callback » progress
sanitize_uuid » uuid

field light_types: set[LightType] | None = None#

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.

data_type#: alias of Data

name: ClassVar[str] = 'AllLights'#

tooltip = 'This plugin will select all lights in the stage'#

class omni.flux.validator.plugin.selector.usd.all_lights.LightType(value)#

Bases: Enum

An enumeration.

CylinderLight = 'CylinderLight'#

DiskLight = 'DiskLight'#

DistantLight = 'DistantLight'#

DomeLight = 'DomeLight'#

RectLight = 'RectLight'#

SphereLight = 'SphereLight'#

UnknownLight = 'UnknownLight'#

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.

class omni.flux.validator.plugin.selector.usd.all_materials.AllMaterials#

Bases: SelectorUSDBase

pydantic model Data#

Bases: Data

Show JSON schema

{
   "title": "Data",
   "type": "object",
   "properties": {
      "on_progress_callback": {
         "default": null,
         "title": "On Progress Callback"
      },
      "on_global_progress_callback": {
         "default": null,
         "title": "On Global Progress Callback"
      },
      "data_flows": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/DataFlow"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Data Flows"
      },
      "channel": {
         "default": "Default",
         "title": "Channel",
         "type": "string"
      },
      "expose_mass_ui": {
         "default": false,
         "title": "Expose Mass Ui",
         "type": "boolean"
      },
      "expose_mass_queue_action_ui": {
         "default": false,
         "title": "Expose Mass Queue Action Ui",
         "type": "boolean"
      },
      "cook_mass_template": {
         "default": false,
         "description": "Set this to true if you want the mass validator to use the plugin to cook the template",
         "title": "Cook Mass Template",
         "type": "boolean"
      },
      "display_name_mass_template": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name to show when we process a cooked template from mass processing",
         "title": "Display Name Mass Template"
      },
      "display_name_mass_template_tooltip": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Tooltip to show when we process a cooked template from mass processing",
         "title": "Display Name Mass Template Tooltip"
      },
      "uuid": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "UUID of the plugin",
         "title": "Uuid"
      },
      "progress": {
         "anyOf": [
            {
               "maxItems": 3,
               "minItems": 3,
               "prefixItems": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "boolean"
                  }
               ],
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [
            0.0,
            "Initializing",
            true
         ],
         "description": "Progress of the plugin",
         "title": "Progress"
      },
      "global_progress_value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.0,
         "description": "Global progress value of the plugin",
         "title": "Global Progress Value"
      },
      "on_select_callback": {
         "default": null,
         "title": "On Select Callback"
      },
      "last_select_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Message"
      },
      "last_select_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Select Data"
      },
      "last_select_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Timing"
      },
      "last_select_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Result"
      },
      "select_from_root_layer_only": {
         "default": false,
         "title": "Select From Root Layer Only",
         "type": "boolean"
      }
   },
   "$defs": {
      "DataFlow": {
         "additionalProperties": false,
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "channel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Default",
               "title": "Channel"
            }
         },
         "required": [
            "name"
         ],
         "title": "DataFlow",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

extra: str = forbid
validate_assignment: bool = True
arbitrary_types_allowed: bool = True

Fields:

Validators:

_fire_global_progress_value_callback » global_progress_value
_fire_last_select_result_callback » last_select_result
_fire_progress_callback » progress
sanitize_uuid » uuid

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.

data_type#: alias of Data

name: ClassVar[str] = 'AllMaterials'#

tooltip = 'This plugin will select all materials in the stage'#

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.

class omni.flux.validator.plugin.selector.usd.all_meshes.AllMeshes#

Bases: SelectorUSDBase

pydantic model Data#

Bases: Data

Show JSON schema

{
   "title": "Data",
   "type": "object",
   "properties": {
      "on_progress_callback": {
         "default": null,
         "title": "On Progress Callback"
      },
      "on_global_progress_callback": {
         "default": null,
         "title": "On Global Progress Callback"
      },
      "data_flows": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/DataFlow"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Data Flows"
      },
      "channel": {
         "default": "Default",
         "title": "Channel",
         "type": "string"
      },
      "expose_mass_ui": {
         "default": false,
         "title": "Expose Mass Ui",
         "type": "boolean"
      },
      "expose_mass_queue_action_ui": {
         "default": false,
         "title": "Expose Mass Queue Action Ui",
         "type": "boolean"
      },
      "cook_mass_template": {
         "default": false,
         "description": "Set this to true if you want the mass validator to use the plugin to cook the template",
         "title": "Cook Mass Template",
         "type": "boolean"
      },
      "display_name_mass_template": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name to show when we process a cooked template from mass processing",
         "title": "Display Name Mass Template"
      },
      "display_name_mass_template_tooltip": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Tooltip to show when we process a cooked template from mass processing",
         "title": "Display Name Mass Template Tooltip"
      },
      "uuid": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "UUID of the plugin",
         "title": "Uuid"
      },
      "progress": {
         "anyOf": [
            {
               "maxItems": 3,
               "minItems": 3,
               "prefixItems": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "boolean"
                  }
               ],
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [
            0.0,
            "Initializing",
            true
         ],
         "description": "Progress of the plugin",
         "title": "Progress"
      },
      "global_progress_value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.0,
         "description": "Global progress value of the plugin",
         "title": "Global Progress Value"
      },
      "on_select_callback": {
         "default": null,
         "title": "On Select Callback"
      },
      "last_select_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Message"
      },
      "last_select_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Select Data"
      },
      "last_select_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Timing"
      },
      "last_select_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Result"
      },
      "select_from_root_layer_only": {
         "default": false,
         "title": "Select From Root Layer Only",
         "type": "boolean"
      },
      "include_geom_subset": {
         "default": false,
         "title": "Include Geom Subset",
         "type": "boolean"
      }
   },
   "$defs": {
      "DataFlow": {
         "additionalProperties": false,
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "channel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Default",
               "title": "Channel"
            }
         },
         "required": [
            "name"
         ],
         "title": "DataFlow",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

extra: str = forbid
validate_assignment: bool = True
arbitrary_types_allowed: bool = True

Fields:

include_geom_subset (bool)

Validators:

_fire_global_progress_value_callback » global_progress_value
_fire_last_select_result_callback » last_select_result
_fire_progress_callback » progress
sanitize_uuid » uuid

field include_geom_subset: bool = False#

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.

data_type#: alias of Data

name: ClassVar[str] = 'AllMeshes'#

tooltip = 'This plugin will select all meshes in the stage'#

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.

class omni.flux.validator.plugin.selector.usd.all_prims.AllPrims#

Bases: SelectorUSDBase

pydantic model Data#

Bases: Data

Show JSON schema

{
   "title": "Data",
   "type": "object",
   "properties": {
      "on_progress_callback": {
         "default": null,
         "title": "On Progress Callback"
      },
      "on_global_progress_callback": {
         "default": null,
         "title": "On Global Progress Callback"
      },
      "data_flows": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/DataFlow"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Data Flows"
      },
      "channel": {
         "default": "Default",
         "title": "Channel",
         "type": "string"
      },
      "expose_mass_ui": {
         "default": false,
         "title": "Expose Mass Ui",
         "type": "boolean"
      },
      "expose_mass_queue_action_ui": {
         "default": false,
         "title": "Expose Mass Queue Action Ui",
         "type": "boolean"
      },
      "cook_mass_template": {
         "default": false,
         "description": "Set this to true if you want the mass validator to use the plugin to cook the template",
         "title": "Cook Mass Template",
         "type": "boolean"
      },
      "display_name_mass_template": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name to show when we process a cooked template from mass processing",
         "title": "Display Name Mass Template"
      },
      "display_name_mass_template_tooltip": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Tooltip to show when we process a cooked template from mass processing",
         "title": "Display Name Mass Template Tooltip"
      },
      "uuid": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "UUID of the plugin",
         "title": "Uuid"
      },
      "progress": {
         "anyOf": [
            {
               "maxItems": 3,
               "minItems": 3,
               "prefixItems": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "boolean"
                  }
               ],
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [
            0.0,
            "Initializing",
            true
         ],
         "description": "Progress of the plugin",
         "title": "Progress"
      },
      "global_progress_value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.0,
         "description": "Global progress value of the plugin",
         "title": "Global Progress Value"
      },
      "on_select_callback": {
         "default": null,
         "title": "On Select Callback"
      },
      "last_select_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Message"
      },
      "last_select_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Select Data"
      },
      "last_select_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Timing"
      },
      "last_select_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Result"
      },
      "select_from_root_layer_only": {
         "default": false,
         "title": "Select From Root Layer Only",
         "type": "boolean"
      }
   },
   "$defs": {
      "DataFlow": {
         "additionalProperties": false,
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "channel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Default",
               "title": "Channel"
            }
         },
         "required": [
            "name"
         ],
         "title": "DataFlow",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

extra: str = forbid
validate_assignment: bool = True
arbitrary_types_allowed: bool = True

Fields:

Validators:

_fire_global_progress_value_callback » global_progress_value
_fire_last_select_result_callback » last_select_result
_fire_progress_callback » progress
sanitize_uuid » uuid

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.

data_type#: alias of Data

name: ClassVar[str] = 'AllPrims'#

tooltip = 'This plugin will select all prims in the stage'#

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.

class omni.flux.validator.plugin.selector.usd.all_shaders.AllShaders#

Bases: SelectorUSDBase

pydantic model Data#

Bases: Data

Show JSON schema

{
   "title": "Data",
   "type": "object",
   "properties": {
      "on_progress_callback": {
         "default": null,
         "title": "On Progress Callback"
      },
      "on_global_progress_callback": {
         "default": null,
         "title": "On Global Progress Callback"
      },
      "data_flows": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/DataFlow"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Data Flows"
      },
      "channel": {
         "default": "Default",
         "title": "Channel",
         "type": "string"
      },
      "expose_mass_ui": {
         "default": false,
         "title": "Expose Mass Ui",
         "type": "boolean"
      },
      "expose_mass_queue_action_ui": {
         "default": false,
         "title": "Expose Mass Queue Action Ui",
         "type": "boolean"
      },
      "cook_mass_template": {
         "default": false,
         "description": "Set this to true if you want the mass validator to use the plugin to cook the template",
         "title": "Cook Mass Template",
         "type": "boolean"
      },
      "display_name_mass_template": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name to show when we process a cooked template from mass processing",
         "title": "Display Name Mass Template"
      },
      "display_name_mass_template_tooltip": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Tooltip to show when we process a cooked template from mass processing",
         "title": "Display Name Mass Template Tooltip"
      },
      "uuid": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "UUID of the plugin",
         "title": "Uuid"
      },
      "progress": {
         "anyOf": [
            {
               "maxItems": 3,
               "minItems": 3,
               "prefixItems": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "boolean"
                  }
               ],
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [
            0.0,
            "Initializing",
            true
         ],
         "description": "Progress of the plugin",
         "title": "Progress"
      },
      "global_progress_value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.0,
         "description": "Global progress value of the plugin",
         "title": "Global Progress Value"
      },
      "on_select_callback": {
         "default": null,
         "title": "On Select Callback"
      },
      "last_select_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Message"
      },
      "last_select_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Select Data"
      },
      "last_select_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Timing"
      },
      "last_select_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Result"
      },
      "select_from_root_layer_only": {
         "default": false,
         "title": "Select From Root Layer Only",
         "type": "boolean"
      }
   },
   "$defs": {
      "DataFlow": {
         "additionalProperties": false,
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "channel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Default",
               "title": "Channel"
            }
         },
         "required": [
            "name"
         ],
         "title": "DataFlow",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

extra: str = forbid
validate_assignment: bool = True
arbitrary_types_allowed: bool = True

Fields:

Validators:

_fire_global_progress_value_callback » global_progress_value
_fire_last_select_result_callback » last_select_result
_fire_progress_callback » progress
sanitize_uuid » uuid

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.

data_type#: alias of Data

name: ClassVar[str] = 'AllShaders'#

tooltip = 'This plugin will select all shaders in the stage'#

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.

class omni.flux.validator.plugin.selector.usd.all_textures.AllTextures#

Bases: SelectorUSDBase

pydantic model Data#

Bases: Data

Show JSON schema

{
   "title": "Data",
   "type": "object",
   "properties": {
      "on_progress_callback": {
         "default": null,
         "title": "On Progress Callback"
      },
      "on_global_progress_callback": {
         "default": null,
         "title": "On Global Progress Callback"
      },
      "data_flows": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/DataFlow"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Data Flows"
      },
      "channel": {
         "default": "Default",
         "title": "Channel",
         "type": "string"
      },
      "expose_mass_ui": {
         "default": false,
         "title": "Expose Mass Ui",
         "type": "boolean"
      },
      "expose_mass_queue_action_ui": {
         "default": false,
         "title": "Expose Mass Queue Action Ui",
         "type": "boolean"
      },
      "cook_mass_template": {
         "default": false,
         "description": "Set this to true if you want the mass validator to use the plugin to cook the template",
         "title": "Cook Mass Template",
         "type": "boolean"
      },
      "display_name_mass_template": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name to show when we process a cooked template from mass processing",
         "title": "Display Name Mass Template"
      },
      "display_name_mass_template_tooltip": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Tooltip to show when we process a cooked template from mass processing",
         "title": "Display Name Mass Template Tooltip"
      },
      "uuid": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "UUID of the plugin",
         "title": "Uuid"
      },
      "progress": {
         "anyOf": [
            {
               "maxItems": 3,
               "minItems": 3,
               "prefixItems": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "boolean"
                  }
               ],
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [
            0.0,
            "Initializing",
            true
         ],
         "description": "Progress of the plugin",
         "title": "Progress"
      },
      "global_progress_value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.0,
         "description": "Global progress value of the plugin",
         "title": "Global Progress Value"
      },
      "on_select_callback": {
         "default": null,
         "title": "On Select Callback"
      },
      "last_select_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Message"
      },
      "last_select_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Select Data"
      },
      "last_select_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Timing"
      },
      "last_select_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Result"
      },
      "select_from_root_layer_only": {
         "default": false,
         "title": "Select From Root Layer Only",
         "type": "boolean"
      },
      "filtered_input_names": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Filtered Input Names"
      }
   },
   "$defs": {
      "DataFlow": {
         "additionalProperties": false,
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "channel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Default",
               "title": "Channel"
            }
         },
         "required": [
            "name"
         ],
         "title": "DataFlow",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

extra: str = forbid
validate_assignment: bool = True
arbitrary_types_allowed: bool = True

Fields:

filtered_input_names (List[str] | None)

Validators:

_fire_global_progress_value_callback » global_progress_value
_fire_last_select_result_callback » last_select_result
_fire_progress_callback » progress
sanitize_uuid » uuid

field filtered_input_names: List[str] | None = None#

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.

data_type#: alias of Data

name: ClassVar[str] = 'AllTextures'#

tooltip = 'This plugin will select all textures in the stage'#

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.

class omni.flux.validator.plugin.selector.usd.nothing.Nothing#

Bases: SelectorUSDBase

pydantic model Data#

Bases: Data

Show JSON schema

{
   "title": "Data",
   "type": "object",
   "properties": {
      "on_progress_callback": {
         "default": null,
         "title": "On Progress Callback"
      },
      "on_global_progress_callback": {
         "default": null,
         "title": "On Global Progress Callback"
      },
      "data_flows": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/DataFlow"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Data Flows"
      },
      "channel": {
         "default": "Default",
         "title": "Channel",
         "type": "string"
      },
      "expose_mass_ui": {
         "default": false,
         "title": "Expose Mass Ui",
         "type": "boolean"
      },
      "expose_mass_queue_action_ui": {
         "default": false,
         "title": "Expose Mass Queue Action Ui",
         "type": "boolean"
      },
      "cook_mass_template": {
         "default": false,
         "description": "Set this to true if you want the mass validator to use the plugin to cook the template",
         "title": "Cook Mass Template",
         "type": "boolean"
      },
      "display_name_mass_template": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name to show when we process a cooked template from mass processing",
         "title": "Display Name Mass Template"
      },
      "display_name_mass_template_tooltip": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Tooltip to show when we process a cooked template from mass processing",
         "title": "Display Name Mass Template Tooltip"
      },
      "uuid": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "UUID of the plugin",
         "title": "Uuid"
      },
      "progress": {
         "anyOf": [
            {
               "maxItems": 3,
               "minItems": 3,
               "prefixItems": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "boolean"
                  }
               ],
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [
            0.0,
            "Initializing",
            true
         ],
         "description": "Progress of the plugin",
         "title": "Progress"
      },
      "global_progress_value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.0,
         "description": "Global progress value of the plugin",
         "title": "Global Progress Value"
      },
      "on_select_callback": {
         "default": null,
         "title": "On Select Callback"
      },
      "last_select_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Message"
      },
      "last_select_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Select Data"
      },
      "last_select_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Timing"
      },
      "last_select_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Result"
      },
      "select_from_root_layer_only": {
         "default": false,
         "title": "Select From Root Layer Only",
         "type": "boolean"
      }
   },
   "$defs": {
      "DataFlow": {
         "additionalProperties": false,
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "channel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Default",
               "title": "Channel"
            }
         },
         "required": [
            "name"
         ],
         "title": "DataFlow",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

extra: str = forbid
validate_assignment: bool = True
arbitrary_types_allowed: bool = True

Fields:

Validators:

_fire_global_progress_value_callback » global_progress_value
_fire_last_select_result_callback » last_select_result
_fire_progress_callback » progress
sanitize_uuid » uuid

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.

data_type#: alias of Data

name: ClassVar[str] = 'Nothing'#

tooltip = 'This plugin will select nothing'#

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.

class omni.flux.validator.plugin.selector.usd.root_prims.RootPrims#

Bases: SelectorUSDBase

pydantic model Data#

Bases: Data

Show JSON schema

{
   "title": "Data",
   "type": "object",
   "properties": {
      "on_progress_callback": {
         "default": null,
         "title": "On Progress Callback"
      },
      "on_global_progress_callback": {
         "default": null,
         "title": "On Global Progress Callback"
      },
      "data_flows": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/DataFlow"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Data Flows"
      },
      "channel": {
         "default": "Default",
         "title": "Channel",
         "type": "string"
      },
      "expose_mass_ui": {
         "default": false,
         "title": "Expose Mass Ui",
         "type": "boolean"
      },
      "expose_mass_queue_action_ui": {
         "default": false,
         "title": "Expose Mass Queue Action Ui",
         "type": "boolean"
      },
      "cook_mass_template": {
         "default": false,
         "description": "Set this to true if you want the mass validator to use the plugin to cook the template",
         "title": "Cook Mass Template",
         "type": "boolean"
      },
      "display_name_mass_template": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name to show when we process a cooked template from mass processing",
         "title": "Display Name Mass Template"
      },
      "display_name_mass_template_tooltip": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Tooltip to show when we process a cooked template from mass processing",
         "title": "Display Name Mass Template Tooltip"
      },
      "uuid": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "UUID of the plugin",
         "title": "Uuid"
      },
      "progress": {
         "anyOf": [
            {
               "maxItems": 3,
               "minItems": 3,
               "prefixItems": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "boolean"
                  }
               ],
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [
            0.0,
            "Initializing",
            true
         ],
         "description": "Progress of the plugin",
         "title": "Progress"
      },
      "global_progress_value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.0,
         "description": "Global progress value of the plugin",
         "title": "Global Progress Value"
      },
      "on_select_callback": {
         "default": null,
         "title": "On Select Callback"
      },
      "last_select_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Message"
      },
      "last_select_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Select Data"
      },
      "last_select_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Timing"
      },
      "last_select_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Result"
      },
      "select_from_root_layer_only": {
         "default": false,
         "title": "Select From Root Layer Only",
         "type": "boolean"
      },
      "select_session_layer_prims": {
         "default": false,
         "title": "Select Session Layer Prims",
         "type": "boolean"
      }
   },
   "$defs": {
      "DataFlow": {
         "additionalProperties": false,
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "channel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Default",
               "title": "Channel"
            }
         },
         "required": [
            "name"
         ],
         "title": "DataFlow",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

extra: str = forbid
validate_assignment: bool = True
arbitrary_types_allowed: bool = True

Fields:

select_session_layer_prims (bool)

Validators:

_fire_global_progress_value_callback » global_progress_value
_fire_last_select_result_callback » last_select_result
_fire_progress_callback » progress
sanitize_uuid » uuid

field select_session_layer_prims: bool = False#

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.

data_type#: alias of Data

name: ClassVar[str] = 'RootPrims'#

tooltip = 'This plugin will select all root prims in the stage'#

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.

class omni.flux.validator.plugin.selector.usd.base.base_selector.SelectorUSDBase#

Bases: SelectorBase

pydantic model Data#

Bases: Data

Show JSON schema

{
   "title": "Data",
   "type": "object",
   "properties": {
      "on_progress_callback": {
         "default": null,
         "title": "On Progress Callback"
      },
      "on_global_progress_callback": {
         "default": null,
         "title": "On Global Progress Callback"
      },
      "data_flows": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/DataFlow"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Data Flows"
      },
      "channel": {
         "default": "Default",
         "title": "Channel",
         "type": "string"
      },
      "expose_mass_ui": {
         "default": false,
         "title": "Expose Mass Ui",
         "type": "boolean"
      },
      "expose_mass_queue_action_ui": {
         "default": false,
         "title": "Expose Mass Queue Action Ui",
         "type": "boolean"
      },
      "cook_mass_template": {
         "default": false,
         "description": "Set this to true if you want the mass validator to use the plugin to cook the template",
         "title": "Cook Mass Template",
         "type": "boolean"
      },
      "display_name_mass_template": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name to show when we process a cooked template from mass processing",
         "title": "Display Name Mass Template"
      },
      "display_name_mass_template_tooltip": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Tooltip to show when we process a cooked template from mass processing",
         "title": "Display Name Mass Template Tooltip"
      },
      "uuid": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "UUID of the plugin",
         "title": "Uuid"
      },
      "progress": {
         "anyOf": [
            {
               "maxItems": 3,
               "minItems": 3,
               "prefixItems": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "boolean"
                  }
               ],
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [
            0.0,
            "Initializing",
            true
         ],
         "description": "Progress of the plugin",
         "title": "Progress"
      },
      "global_progress_value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.0,
         "description": "Global progress value of the plugin",
         "title": "Global Progress Value"
      },
      "on_select_callback": {
         "default": null,
         "title": "On Select Callback"
      },
      "last_select_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Message"
      },
      "last_select_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Select Data"
      },
      "last_select_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Timing"
      },
      "last_select_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Select Result"
      },
      "select_from_root_layer_only": {
         "default": false,
         "title": "Select From Root Layer Only",
         "type": "boolean"
      }
   },
   "$defs": {
      "DataFlow": {
         "additionalProperties": false,
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "channel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Default",
               "title": "Channel"
            }
         },
         "required": [
            "name"
         ],
         "title": "DataFlow",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

extra: str = forbid
validate_assignment: bool = True
arbitrary_types_allowed: bool = True

Fields:

select_from_root_layer_only (bool)

Validators:

_fire_global_progress_value_callback » global_progress_value
_fire_last_select_result_callback » last_select_result
_fire_progress_callback » progress
sanitize_uuid » uuid

field select_from_root_layer_only: bool = False#

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.