omni.flux.validator.plugin.context.usd_stage

• Overview
• 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.

class omni.flux.validator.plugin.context.usd_stage.extension.FluxValidatorPluginContextUSDStageExtension

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.context.usd_stage.asset_importer.AssetImporter

Bases: ContextBaseUSD

DEFAULT_UI_HEIGHT_PIXEL = 24

DEFAULT_UI_SPACING_PIXEL = 8

DEFAULT_UI_WIDTH_PIXEL = 120

pydantic model Data

Bases: DataBase

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/InOutDataFlow"
               },
               "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_check_callback": {
         "default": null,
         "title": "On Check Callback"
      },
      "on_set_callback": {
         "default": null,
         "title": "On Set Callback"
      },
      "on_exit_callback": {
         "default": null,
         "title": "On Exit Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Timing"
      },
      "last_check_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Result"
      },
      "last_set_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Set Message"
      },
      "last_set_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Set Data"
      },
      "last_set_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Set Timing"
      },
      "last_set_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Set Result"
      },
      "last_on_exit_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last On Exit Message"
      },
      "last_on_exit_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last On Exit Timing"
      },
      "last_on_exit_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last On Exit Result"
      },
      "hide_context_ui": {
         "default": false,
         "title": "Hide Context Ui",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      },
      "create_context_if_not_exist": {
         "default": false,
         "title": "Create Context If Not Exist",
         "type": "boolean"
      },
      "computed_context": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Computed Context"
      },
      "allow_empty_input_files_list": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": false,
         "title": "Allow Empty Input Files List"
      },
      "input_files": {
         "items": {
            "type": "string"
         },
         "title": "Input Files",
         "type": "array"
      },
      "create_output_directory_if_missing": {
         "default": true,
         "title": "Create Output Directory If Missing",
         "type": "boolean"
      },
      "output_directory": {
         "title": "Output Directory",
         "type": "string"
      },
      "output_usd_extension": {
         "anyOf": [
            {
               "$ref": "#/$defs/UsdExtensions"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "full_path_keep": {
         "default": false,
         "description": "Keep the full path like c:/source/path2/asset.usd will be c:/output/path2/asset.usd if full_path_root is c:/source/ and full_path_keep is True",
         "title": "Full Path Keep",
         "type": "boolean"
      },
      "full_path_root": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Full Path Root"
      },
      "close_stage_on_exit": {
         "default": false,
         "title": "Close Stage On Exit",
         "type": "boolean"
      },
      "default_output_endpoint": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "An API endpoint to hit up to get the default output directory",
         "title": "Default Output Endpoint"
      },
      "output_files": {
         "anyOf": [
            {
               "additionalProperties": {
                  "type": "string"
               },
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Output Files"
      },
      "ignore_materials": {
         "default": false,
         "title": "Ignore Materials",
         "type": "boolean"
      },
      "ignore_animations": {
         "default": false,
         "title": "Ignore Animations",
         "type": "boolean"
      },
      "ignore_camera": {
         "default": false,
         "title": "Ignore Camera",
         "type": "boolean"
      },
      "ignore_light": {
         "default": false,
         "title": "Ignore Light",
         "type": "boolean"
      },
      "single_mesh": {
         "default": false,
         "title": "Single Mesh",
         "type": "boolean"
      },
      "smooth_normals": {
         "default": true,
         "title": "Smooth Normals",
         "type": "boolean"
      },
      "export_preview_surface": {
         "default": false,
         "title": "Export Preview Surface",
         "type": "boolean"
      },
      "support_point_instancer": {
         "default": false,
         "title": "Support Point Instancer",
         "type": "boolean"
      },
      "embed_mdl_in_usd": {
         "default": true,
         "title": "Embed Mdl In Usd",
         "type": "boolean"
      },
      "use_meter_as_world_unit": {
         "default": false,
         "title": "Use Meter As World Unit",
         "type": "boolean"
      },
      "create_world_as_default_root_prim": {
         "default": true,
         "title": "Create World As Default Root Prim",
         "type": "boolean"
      },
      "embed_textures": {
         "default": true,
         "title": "Embed Textures",
         "type": "boolean"
      },
      "convert_fbx_to_y_up": {
         "default": false,
         "title": "Convert Fbx To Y Up",
         "type": "boolean"
      },
      "convert_fbx_to_z_up": {
         "default": false,
         "title": "Convert Fbx To Z Up",
         "type": "boolean"
      },
      "keep_all_materials": {
         "default": false,
         "title": "Keep All Materials",
         "type": "boolean"
      },
      "merge_all_meshes": {
         "default": false,
         "title": "Merge All Meshes",
         "type": "boolean"
      },
      "use_double_precision_to_usd_transform_op": {
         "default": false,
         "title": "Use Double Precision To Usd Transform Op",
         "type": "boolean"
      },
      "ignore_pivots": {
         "default": false,
         "title": "Ignore Pivots",
         "type": "boolean"
      },
      "disabling_instancing": {
         "default": false,
         "title": "Disabling Instancing",
         "type": "boolean"
      },
      "export_hidden_props": {
         "default": false,
         "title": "Export Hidden Props",
         "type": "boolean"
      },
      "baking_scales": {
         "default": false,
         "title": "Baking Scales",
         "type": "boolean"
      },
      "ignore_flip_rotations": {
         "default": false,
         "title": "Ignore Flip Rotations",
         "type": "boolean"
      },
      "ignore_unbound_bones": {
         "default": false,
         "title": "Ignore Unbound Bones",
         "type": "boolean"
      },
      "bake_material": {
         "default": false,
         "title": "Bake Material",
         "type": "boolean"
      },
      "export_separate_gltf": {
         "default": false,
         "title": "Export Separate Gltf",
         "type": "boolean"
      },
      "export_mdl_gltf_extension": {
         "default": false,
         "title": "Export Mdl Gltf Extension",
         "type": "boolean"
      },
      "convert_stage_up_y": {
         "default": false,
         "title": "Convert Stage Up Y",
         "type": "boolean"
      },
      "convert_stage_up_z": {
         "default": false,
         "title": "Convert Stage Up Z",
         "type": "boolean"
      }
   },
   "$defs": {
      "InOutDataFlow": {
         "additionalProperties": false,
         "properties": {
            "name": {
               "default": "InOutData",
               "title": "Name",
               "type": "string"
            },
            "channel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Default",
               "title": "Channel"
            },
            "input_data": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Input Data"
            },
            "push_input_data": {
               "default": false,
               "title": "Push Input Data",
               "type": "boolean"
            },
            "output_data": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Output Data"
            },
            "push_output_data": {
               "default": false,
               "title": "Push Output Data",
               "type": "boolean"
            }
         },
         "title": "InOutDataFlow",
         "type": "object"
      },
      "UsdExtensions": {
         "enum": [
            "usd",
            "usda",
            "usdc"
         ],
         "title": "UsdExtensions",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "input_files",
      "output_directory"
   ]
}

Config:

• extra: str = forbid

• validate_assignment: bool = True

• arbitrary_types_allowed: bool = True

Fields:

• bake_material (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• baking_scales (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• convert_fbx_to_y_up (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• convert_fbx_to_z_up (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• convert_stage_up_y (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• convert_stage_up_z (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• create_world_as_default_root_prim (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• disabling_instancing (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• embed_mdl_in_usd (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• embed_textures (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• export_hidden_props (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• export_mdl_gltf_extension (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• export_preview_surface (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• export_separate_gltf (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• ignore_animations (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• ignore_camera (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• ignore_flip_rotations (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• ignore_light (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• ignore_materials (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• ignore_pivots (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• ignore_unbound_bones (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• keep_all_materials (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• merge_all_meshes (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• single_mesh (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• smooth_normals (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• support_point_instancer (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• use_double_precision_to_usd_transform_op (Annotated[bool, pydantic.functional_validators.SkipValidation()])

• use_meter_as_world_unit (Annotated[bool, pydantic.functional_validators.SkipValidation()])

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_exit_result_callback » last_on_exit_result

• _fire_last_set_result_callback » last_set_result

• _fire_progress_callback » progress

• sanitize_uuid » uuid

field bake_material: Annotated[bool, SkipValidation()] = False

field baking_scales: Annotated[bool, SkipValidation()] = False

field convert_fbx_to_y_up: Annotated[bool, SkipValidation()] = False

field convert_fbx_to_z_up: Annotated[bool, SkipValidation()] = False

field convert_stage_up_y: Annotated[bool, SkipValidation()] = False

field convert_stage_up_z: Annotated[bool, SkipValidation()] = False

field create_world_as_default_root_prim: Annotated[bool, SkipValidation()] = True

field disabling_instancing: Annotated[bool, SkipValidation()] = False

field embed_mdl_in_usd: Annotated[bool, SkipValidation()] = True

field embed_textures: Annotated[bool, SkipValidation()] = True

field export_hidden_props: Annotated[bool, SkipValidation()] = False

field export_mdl_gltf_extension: Annotated[bool, SkipValidation()] = False

field export_preview_surface: Annotated[bool, SkipValidation()] = False

field export_separate_gltf: Annotated[bool, SkipValidation()] = False

field ignore_animations: Annotated[bool, SkipValidation()] = False

field ignore_camera: Annotated[bool, SkipValidation()] = False

field ignore_flip_rotations: Annotated[bool, SkipValidation()] = False

field ignore_light: Annotated[bool, SkipValidation()] = False

field ignore_materials: Annotated[bool, SkipValidation()] = False

field ignore_pivots: Annotated[bool, SkipValidation()] = False

field ignore_unbound_bones: Annotated[bool, SkipValidation()] = False

field keep_all_materials: Annotated[bool, SkipValidation()] = False

field merge_all_meshes: Annotated[bool, SkipValidation()] = False

field single_mesh: Annotated[bool, SkipValidation()] = False

field smooth_normals: Annotated[bool, SkipValidation()] = True

field support_point_instancer: Annotated[bool, SkipValidation()] = False

field use_double_precision_to_usd_transform_op: Annotated[bool, SkipValidation()] = False

field use_meter_as_world_unit: Annotated[bool, SkipValidation()] = 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.

pydantic model DataBase

Bases: Data

Show JSON schema

{
   "title": "DataBase",
   "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/InOutDataFlow"
               },
               "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_check_callback": {
         "default": null,
         "title": "On Check Callback"
      },
      "on_set_callback": {
         "default": null,
         "title": "On Set Callback"
      },
      "on_exit_callback": {
         "default": null,
         "title": "On Exit Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Timing"
      },
      "last_check_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Result"
      },
      "last_set_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Set Message"
      },
      "last_set_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Set Data"
      },
      "last_set_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Set Timing"
      },
      "last_set_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Set Result"
      },
      "last_on_exit_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last On Exit Message"
      },
      "last_on_exit_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last On Exit Timing"
      },
      "last_on_exit_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last On Exit Result"
      },
      "hide_context_ui": {
         "default": false,
         "title": "Hide Context Ui",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      },
      "create_context_if_not_exist": {
         "default": false,
         "title": "Create Context If Not Exist",
         "type": "boolean"
      },
      "computed_context": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Computed Context"
      },
      "allow_empty_input_files_list": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": false,
         "title": "Allow Empty Input Files List"
      },
      "input_files": {
         "items": {
            "type": "string"
         },
         "title": "Input Files",
         "type": "array"
      },
      "create_output_directory_if_missing": {
         "default": true,
         "title": "Create Output Directory If Missing",
         "type": "boolean"
      },
      "output_directory": {
         "title": "Output Directory",
         "type": "string"
      },
      "output_usd_extension": {
         "anyOf": [
            {
               "$ref": "#/$defs/UsdExtensions"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "full_path_keep": {
         "default": false,
         "description": "Keep the full path like c:/source/path2/asset.usd will be c:/output/path2/asset.usd if full_path_root is c:/source/ and full_path_keep is True",
         "title": "Full Path Keep",
         "type": "boolean"
      },
      "full_path_root": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Full Path Root"
      },
      "close_stage_on_exit": {
         "default": false,
         "title": "Close Stage On Exit",
         "type": "boolean"
      },
      "default_output_endpoint": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "An API endpoint to hit up to get the default output directory",
         "title": "Default Output Endpoint"
      },
      "output_files": {
         "anyOf": [
            {
               "additionalProperties": {
                  "type": "string"
               },
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Output Files"
      }
   },
   "$defs": {
      "InOutDataFlow": {
         "additionalProperties": false,
         "properties": {
            "name": {
               "default": "InOutData",
               "title": "Name",
               "type": "string"
            },
            "channel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Default",
               "title": "Channel"
            },
            "input_data": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Input Data"
            },
            "push_input_data": {
               "default": false,
               "title": "Push Input Data",
               "type": "boolean"
            },
            "output_data": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Output Data"
            },
            "push_output_data": {
               "default": false,
               "title": "Push Output Data",
               "type": "boolean"
            }
         },
         "title": "InOutDataFlow",
         "type": "object"
      },
      "UsdExtensions": {
         "enum": [
            "usd",
            "usda",
            "usdc"
         ],
         "title": "UsdExtensions",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "input_files",
      "output_directory"
   ]
}

Config:

• extra: str = forbid

• validate_assignment: bool = True

• arbitrary_types_allowed: bool = True

Fields:

• allow_empty_input_files_list (bool | None)

• close_stage_on_exit (bool)

• create_output_directory_if_missing (bool)

• data_flows (list[omni.flux.validator.factory.data_flow.in_out_data.InOutDataFlow] | None)

• default_output_endpoint (str | None)

• full_path_keep (bool)

• full_path_root (omni.flux.utils.common.omni_url.OmniUrl | None)

• input_files (list[omni.flux.utils.common.omni_url.OmniUrl])

• output_directory (omni.flux.utils.common.omni_url.OmniUrl)

• output_files (dict[str, str] | None)

• output_usd_extension (omni.flux.asset_importer.core.data_models.enums.UsdExtensions | None)

Validators:

• at_least_one » input_files

• can_have_children » output_directory

• is_readable » input_files

• output_dir_unequal_input_dirs » output_directory

field allow_empty_input_files_list: bool | None = False

field close_stage_on_exit: bool = False

field create_output_directory_if_missing: bool = True

field data_flows: list[InOutDataFlow] | None = None

field default_output_endpoint: str | None = None

An API endpoint to hit up to get the default output directory

field full_path_keep: bool = False

Keep the full path like c:/source/path2/asset.usd will be c:/output/path2/asset.usd if full_path_root is c:/source/ and full_path_keep is True

field full_path_root: OmniUrl | None = None

field input_files: list[OmniUrl] [Required]

Validated by:

• at_least_one

• is_readable

field output_directory: OmniUrl [Required]

Validated by:

• can_have_children

• output_dir_unequal_input_dirs

field output_files: dict[str, str] | None = None

This is tmp we don’t keep it in the schema

field output_usd_extension: UsdExtensions | None = None

validator at_least_one  »  input_files

validator can_have_children  »  output_directory

validator is_readable  »  input_files

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.

validator output_dir_unequal_input_dirs  »  output_directory

data_type

alias of Data

destroy()

display_name: str | None = 'Asset Importer'

name: ClassVar[str] = 'AssetImporter'

show(

value: bool,

schema_data: Data,

)

Called whenever the plugin is show or hidden in the UI.

tooltip = 'This plugin will import a list of files and process them sequentially'

omni.flux.validator.plugin.context.usd_stage.asset_importer.get_active_viewport(usd_context_name: str = '')

Retrieves the active viewport API instance for a given USD context.

If no USD context name is provided, the current USD context is used.

Parameters:

usd_context_name (str, optional) – The name of the USD context to query. Defaults to an empty string, which indicates the current USD context.

Returns:

The active viewport API instance, or None if not found.

Return type:

Optional[ViewportAPI]

• 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.context.usd_stage.current_stage.CurrentStage

Bases: ContextBaseUSD

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_check_callback": {
         "default": null,
         "title": "On Check Callback"
      },
      "on_set_callback": {
         "default": null,
         "title": "On Set Callback"
      },
      "on_exit_callback": {
         "default": null,
         "title": "On Exit Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Timing"
      },
      "last_check_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Result"
      },
      "last_set_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Set Message"
      },
      "last_set_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Set Data"
      },
      "last_set_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Set Timing"
      },
      "last_set_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Set Result"
      },
      "last_on_exit_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last On Exit Message"
      },
      "last_on_exit_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last On Exit Timing"
      },
      "last_on_exit_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last On Exit Result"
      },
      "hide_context_ui": {
         "default": false,
         "title": "Hide Context Ui",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      },
      "create_context_if_not_exist": {
         "default": false,
         "title": "Create Context If Not Exist",
         "type": "boolean"
      },
      "computed_context": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Computed Context"
      },
      "save_on_exit": {
         "default": false,
         "title": "Save On Exit",
         "type": "boolean"
      },
      "close_stage_on_exit": {
         "default": false,
         "title": "Close Stage On Exit",
         "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:

• close_stage_on_exit (bool)

• save_on_exit (bool)

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_exit_result_callback » last_on_exit_result

• _fire_last_set_result_callback » last_set_result

• _fire_progress_callback » progress

• sanitize_uuid » uuid

field close_stage_on_exit: bool = False

field save_on_exit: 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

display_name: str | None = 'Current Stage'

name: ClassVar[str] = 'CurrentStage'

tooltip = 'This plugin will use the current opened 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.context.usd_stage.dependency_iterator.DependencyIterator

Bases: ContextBaseUSD

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/InOutDataFlow"
               },
               "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_check_callback": {
         "default": null,
         "title": "On Check Callback"
      },
      "on_set_callback": {
         "default": null,
         "title": "On Set Callback"
      },
      "on_exit_callback": {
         "default": null,
         "title": "On Exit Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Timing"
      },
      "last_check_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Result"
      },
      "last_set_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Set Message"
      },
      "last_set_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Set Data"
      },
      "last_set_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Set Timing"
      },
      "last_set_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Set Result"
      },
      "last_on_exit_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last On Exit Message"
      },
      "last_on_exit_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last On Exit Timing"
      },
      "last_on_exit_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last On Exit Result"
      },
      "hide_context_ui": {
         "default": false,
         "title": "Hide Context Ui",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      },
      "create_context_if_not_exist": {
         "default": false,
         "title": "Create Context If Not Exist",
         "type": "boolean"
      },
      "computed_context": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Computed Context"
      },
      "save_all_layers_on_exit": {
         "default": false,
         "title": "Save All Layers On Exit",
         "type": "boolean"
      },
      "close_stage_on_exit": {
         "default": false,
         "title": "Close Stage On Exit",
         "type": "boolean"
      },
      "close_dependency_between_round": {
         "default": true,
         "title": "Close Dependency Between Round",
         "type": "boolean"
      }
   },
   "$defs": {
      "InOutDataFlow": {
         "additionalProperties": false,
         "properties": {
            "name": {
               "default": "InOutData",
               "title": "Name",
               "type": "string"
            },
            "channel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Default",
               "title": "Channel"
            },
            "input_data": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Input Data"
            },
            "push_input_data": {
               "default": false,
               "title": "Push Input Data",
               "type": "boolean"
            },
            "output_data": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Output Data"
            },
            "push_output_data": {
               "default": false,
               "title": "Push Output Data",
               "type": "boolean"
            }
         },
         "title": "InOutDataFlow",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

• extra: str = forbid

• validate_assignment: bool = True

• arbitrary_types_allowed: bool = True

Fields:

• close_dependency_between_round (bool)

• close_stage_on_exit (bool)

• data_flows (List[omni.flux.validator.factory.data_flow.in_out_data.InOutDataFlow] | None)

• save_all_layers_on_exit (bool)

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_exit_result_callback » last_on_exit_result

• _fire_last_set_result_callback » last_set_result

• _fire_progress_callback » progress

• sanitize_uuid » uuid

field close_dependency_between_round: bool = True

field close_stage_on_exit: bool = False

field data_flows: List[InOutDataFlow] | None = None

field save_all_layers_on_exit: 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

display_name: str | None = 'Dependency Iterator'

name: ClassVar[str] = 'DependencyIterator'

tooltip = 'This plugin will iterate and open all dependencies (sublayers, references, etc etc)'

• 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.context.usd_stage.texture_importer.TextureImporter

Bases: ContextBaseUSD

DEFAULT_UI_HEIGHT_PIXEL = 24

DEFAULT_UI_SPACING_PIXEL = 8

DEFAULT_UI_WIDTH_PIXEL = 115

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/InOutDataFlow"
               },
               "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_check_callback": {
         "default": null,
         "title": "On Check Callback"
      },
      "on_set_callback": {
         "default": null,
         "title": "On Set Callback"
      },
      "on_exit_callback": {
         "default": null,
         "title": "On Exit Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Timing"
      },
      "last_check_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Result"
      },
      "last_set_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Set Message"
      },
      "last_set_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Set Data"
      },
      "last_set_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Set Timing"
      },
      "last_set_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Set Result"
      },
      "last_on_exit_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last On Exit Message"
      },
      "last_on_exit_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last On Exit Timing"
      },
      "last_on_exit_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last On Exit Result"
      },
      "hide_context_ui": {
         "default": false,
         "title": "Hide Context Ui",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      },
      "create_context_if_not_exist": {
         "default": false,
         "title": "Create Context If Not Exist",
         "type": "boolean"
      },
      "computed_context": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Computed Context"
      },
      "allow_empty_input_files_list": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": false,
         "title": "Allow Empty Input Files List"
      },
      "input_files": {
         "items": {
            "maxItems": 2,
            "minItems": 2,
            "prefixItems": [
               {
                  "type": "string"
               },
               {
                  "type": "string"
               }
            ],
            "type": "array"
         },
         "title": "Input Files",
         "type": "array"
      },
      "error_on_texture_types": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Error On Texture Types"
      },
      "create_output_directory_if_missing": {
         "default": true,
         "title": "Create Output Directory If Missing",
         "type": "boolean"
      },
      "output_directory": {
         "title": "Output Directory",
         "type": "string"
      },
      "default_output_endpoint": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Default Output Endpoint"
      }
   },
   "$defs": {
      "InOutDataFlow": {
         "additionalProperties": false,
         "properties": {
            "name": {
               "default": "InOutData",
               "title": "Name",
               "type": "string"
            },
            "channel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Default",
               "title": "Channel"
            },
            "input_data": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Input Data"
            },
            "push_input_data": {
               "default": false,
               "title": "Push Input Data",
               "type": "boolean"
            },
            "output_data": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Output Data"
            },
            "push_output_data": {
               "default": false,
               "title": "Push Output Data",
               "type": "boolean"
            }
         },
         "title": "InOutDataFlow",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "input_files",
      "output_directory"
   ]
}

Config:

• extra: str = forbid

• validate_assignment: bool = True

• arbitrary_types_allowed: bool = True

Fields:

• allow_empty_input_files_list (bool | None)

• create_output_directory_if_missing (bool)

• data_flows (list[omni.flux.validator.factory.data_flow.in_out_data.InOutDataFlow] | None)

• default_output_endpoint (str | None)

• error_on_texture_types (list[omni.flux.asset_importer.core.data_models.enums.TextureTypes] | None)

• input_files (list[tuple[omni.flux.utils.common.omni_url.OmniUrl, omni.flux.asset_importer.core.data_models.enums.TextureTypes]])

• output_directory (omni.flux.utils.common.omni_url.OmniUrl)

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_exit_result_callback » last_on_exit_result

• _fire_last_set_result_callback » last_set_result

• _fire_progress_callback » progress

• at_least_one » input_files

• can_have_children » output_directory

• is_valid » input_files

• output_dir_unequal_input_dirs » output_directory

• sanitize_uuid » uuid

field allow_empty_input_files_list: bool | None = False

field create_output_directory_if_missing: bool = True

field data_flows: list[InOutDataFlow] | None = None

field default_output_endpoint: str | None = None

field error_on_texture_types: list[TextureTypes] | None = None

field input_files: list[tuple[OmniUrl, TextureTypes]] [Required]

Validated by:

• at_least_one

• is_valid

field output_directory: OmniUrl [Required]

Validated by:

• can_have_children

• output_dir_unequal_input_dirs

validator at_least_one  »  input_files

validator can_have_children  »  output_directory

validator is_valid  »  input_files

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.

validator output_dir_unequal_input_dirs  »  output_directory

data_type

alias of Data

destroy()

display_name: str | None = 'Texture Importer'

name: ClassVar[str] = 'TextureImporter'

show(

value: bool,

schema_data: Data,

)

Called whenever the plugin is show or hidden in the UI.

tooltip = 'This plugin will import a list of textures, assign them to USD materials using the OmniPBR shader, and process the various textures sequentially.'

• 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.context.usd_stage.usd_directory.USDDirectory

Bases: ContextBaseUSD

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/InOutDataFlow"
               },
               "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_check_callback": {
         "default": null,
         "title": "On Check Callback"
      },
      "on_set_callback": {
         "default": null,
         "title": "On Set Callback"
      },
      "on_exit_callback": {
         "default": null,
         "title": "On Exit Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Timing"
      },
      "last_check_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Result"
      },
      "last_set_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Set Message"
      },
      "last_set_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Set Data"
      },
      "last_set_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Set Timing"
      },
      "last_set_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Set Result"
      },
      "last_on_exit_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last On Exit Message"
      },
      "last_on_exit_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last On Exit Timing"
      },
      "last_on_exit_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last On Exit Result"
      },
      "hide_context_ui": {
         "default": false,
         "title": "Hide Context Ui",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      },
      "create_context_if_not_exist": {
         "default": false,
         "title": "Create Context If Not Exist",
         "type": "boolean"
      },
      "computed_context": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Computed Context"
      },
      "directory": {
         "title": "Directory",
         "type": "string"
      },
      "recursive": {
         "default": true,
         "title": "Recursive",
         "type": "boolean"
      },
      "ignore_paths": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Ignore Paths"
      },
      "save_all_layers_on_exit": {
         "default": false,
         "title": "Save All Layers On Exit",
         "type": "boolean"
      },
      "close_stage_on_exit": {
         "default": false,
         "title": "Close Stage On Exit",
         "type": "boolean"
      },
      "close_dependency_between_round": {
         "default": true,
         "title": "Close Dependency Between Round",
         "type": "boolean"
      },
      "skip_validated_files": {
         "default": false,
         "title": "Skip Validated Files",
         "type": "boolean"
      },
      "file_validated_fixes": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array",
               "uniqueItems": true
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "File Validated Fixes"
      },
      "cooked_files": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Cooked Files"
      }
   },
   "$defs": {
      "InOutDataFlow": {
         "additionalProperties": false,
         "properties": {
            "name": {
               "default": "InOutData",
               "title": "Name",
               "type": "string"
            },
            "channel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Default",
               "title": "Channel"
            },
            "input_data": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Input Data"
            },
            "push_input_data": {
               "default": false,
               "title": "Push Input Data",
               "type": "boolean"
            },
            "output_data": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Output Data"
            },
            "push_output_data": {
               "default": false,
               "title": "Push Output Data",
               "type": "boolean"
            }
         },
         "title": "InOutDataFlow",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "directory"
   ]
}

Config:

• extra: str = forbid

• validate_assignment: bool = True

• arbitrary_types_allowed: bool = True

Fields:

• close_dependency_between_round (bool)

• close_stage_on_exit (bool)

• cooked_files (list[str] | None)

• data_flows (List[omni.flux.validator.factory.data_flow.in_out_data.InOutDataFlow] | None)

• directory (str)

• file_validated_fixes (set[str] | None)

• ignore_paths (list[str] | None)

• recursive (bool)

• save_all_layers_on_exit (bool)

• skip_validated_files (bool)

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_exit_result_callback » last_on_exit_result

• _fire_last_set_result_callback » last_set_result

• _fire_progress_callback » progress

• file_validated_fixes_set » all fields

• sanitize_uuid » uuid

field close_dependency_between_round: bool = True

Validated by:

• file_validated_fixes_set

field close_stage_on_exit: bool = False

Validated by:

• file_validated_fixes_set

field cooked_files: list[str] | None = None

Validated by:

• file_validated_fixes_set

field data_flows: List[InOutDataFlow] | None = None

Validated by:

• file_validated_fixes_set

field directory: str [Required]

Validated by:

• file_validated_fixes_set

field file_validated_fixes: set[str] | None = None

Validated by:

• file_validated_fixes_set

field ignore_paths: list[str] | None = None

Validated by:

• file_validated_fixes_set

field recursive: bool = True

Validated by:

• file_validated_fixes_set

field save_all_layers_on_exit: bool = False

Validated by:

• file_validated_fixes_set

field skip_validated_files: bool = False

Validated by:

• file_validated_fixes_set

validator file_validated_fixes_set  »  all fields

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

display_name: str | None = 'USD Directory'

name: ClassVar[str] = 'USDDirectory'

tooltip = 'This plugin will iterate and open all USD stages in the given path'

• 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.context.usd_stage.usd_file.USDFile

Bases: ContextBaseUSD

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/InOutDataFlow"
               },
               "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_check_callback": {
         "default": null,
         "title": "On Check Callback"
      },
      "on_set_callback": {
         "default": null,
         "title": "On Set Callback"
      },
      "on_exit_callback": {
         "default": null,
         "title": "On Exit Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Timing"
      },
      "last_check_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Result"
      },
      "last_set_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Set Message"
      },
      "last_set_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Set Data"
      },
      "last_set_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Set Timing"
      },
      "last_set_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Set Result"
      },
      "last_on_exit_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last On Exit Message"
      },
      "last_on_exit_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last On Exit Timing"
      },
      "last_on_exit_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last On Exit Result"
      },
      "hide_context_ui": {
         "default": false,
         "title": "Hide Context Ui",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      },
      "create_context_if_not_exist": {
         "default": false,
         "title": "Create Context If Not Exist",
         "type": "boolean"
      },
      "computed_context": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Computed Context"
      },
      "file": {
         "title": "File",
         "type": "string"
      },
      "save_on_exit": {
         "default": false,
         "title": "Save On Exit",
         "type": "boolean"
      },
      "close_stage_on_exit": {
         "default": false,
         "title": "Close Stage On Exit",
         "type": "boolean"
      },
      "skip_validated_files": {
         "default": false,
         "title": "Skip Validated Files",
         "type": "boolean"
      },
      "file_validated_fixes": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array",
               "uniqueItems": true
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "File Validated Fixes"
      }
   },
   "$defs": {
      "InOutDataFlow": {
         "additionalProperties": false,
         "properties": {
            "name": {
               "default": "InOutData",
               "title": "Name",
               "type": "string"
            },
            "channel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Default",
               "title": "Channel"
            },
            "input_data": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Input Data"
            },
            "push_input_data": {
               "default": false,
               "title": "Push Input Data",
               "type": "boolean"
            },
            "output_data": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Output Data"
            },
            "push_output_data": {
               "default": false,
               "title": "Push Output Data",
               "type": "boolean"
            }
         },
         "title": "InOutDataFlow",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "file"
   ]
}

Config:

• extra: str = forbid

• validate_assignment: bool = True

• arbitrary_types_allowed: bool = True

Fields:

• close_stage_on_exit (bool)

• data_flows (List[omni.flux.validator.factory.data_flow.in_out_data.InOutDataFlow] | None)

• file (str)

• file_validated_fixes (set[str] | None)

• save_on_exit (bool)

• skip_validated_files (bool)

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_exit_result_callback » last_on_exit_result

• _fire_last_set_result_callback » last_set_result

• _fire_progress_callback » progress

• file_validated_fixes_set » all fields

• sanitize_uuid » uuid

field close_stage_on_exit: bool = False

Validated by:

• file_validated_fixes_set

field data_flows: List[InOutDataFlow] | None = None

Validated by:

• file_validated_fixes_set

field file: str [Required]

Validated by:

• file_validated_fixes_set

field file_validated_fixes: set[str] | None = None

Validated by:

• file_validated_fixes_set

field save_on_exit: bool = False

Validated by:

• file_validated_fixes_set

field skip_validated_files: bool = False

Validated by:

• file_validated_fixes_set

validator file_validated_fixes_set  »  all fields

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

display_name: str | None = 'USD File'

name: ClassVar[str] = 'USDFile'

tooltip = 'This plugin will open the given stage path'

• 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.context.usd_stage.base.context_base_usd.ContextBaseUSD

Bases: ContextBase, ABC

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_check_callback": {
         "default": null,
         "title": "On Check Callback"
      },
      "on_set_callback": {
         "default": null,
         "title": "On Set Callback"
      },
      "on_exit_callback": {
         "default": null,
         "title": "On Exit Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Timing"
      },
      "last_check_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Result"
      },
      "last_set_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Set Message"
      },
      "last_set_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Set Data"
      },
      "last_set_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Set Timing"
      },
      "last_set_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Set Result"
      },
      "last_on_exit_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last On Exit Message"
      },
      "last_on_exit_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last On Exit Timing"
      },
      "last_on_exit_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last On Exit Result"
      },
      "hide_context_ui": {
         "default": false,
         "title": "Hide Context Ui",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      },
      "create_context_if_not_exist": {
         "default": false,
         "title": "Create Context If Not Exist",
         "type": "boolean"
      },
      "computed_context": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Computed Context"
      }
   },
   "$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:

• computed_context (str | None)

• context_name (str | None)

• create_context_if_not_exist (bool)

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_exit_result_callback » last_on_exit_result

• _fire_last_set_result_callback » last_set_result

• _fire_progress_callback » progress

• sanitize_uuid » uuid

field computed_context: str | None = None

field context_name: str | None = None

field create_context_if_not_exist: 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.