omni.flux.validator.plugin.check.usd

• 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.check.usd.extension.FluxValidatorPluginCheckUSDExtension

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.check.usd.ai.generate_pbr_material.GeneratePBRMaterial

Bases: CheckBaseUSD

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_fix_callback": {
         "default": null,
         "title": "On Fix Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Check Data"
      },
      "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_fix_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Message"
      },
      "last_fix_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Fix Data"
      },
      "last_fix_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Timing"
      },
      "last_fix_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Result"
      },
      "save_on_fix_failure": {
         "default": true,
         "title": "Save On Fix Failure",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      },
      "model_artifact_path": {
         "format": "path",
         "title": "Model Artifact Path",
         "type": "string"
      },
      "config_artifact_path": {
         "format": "path",
         "title": "Config Artifact Path",
         "type": "string"
      },
      "subdirectory_per_input": {
         "default": true,
         "title": "Subdirectory Per Input",
         "type": "boolean"
      },
      "min_inference_resolution": {
         "default": 64,
         "title": "Min Inference Resolution",
         "type": "integer"
      },
      "max_inference_resolution": {
         "default": 512,
         "title": "Max Inference Resolution",
         "type": "integer"
      },
      "noise_level": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Noise Level"
      },
      "denoising_steps": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Denoising Steps"
      },
      "inference_mode": {
         "$ref": "#/$defs/InferenceMode",
         "default": "Quality"
      }
   },
   "$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"
      },
      "InferenceMode": {
         "enum": [
            "Speed",
            "Quality"
         ],
         "title": "InferenceMode",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "model_artifact_path",
      "config_artifact_path"
   ]
}

Config:

• extra: str = forbid

• validate_assignment: bool = True

• arbitrary_types_allowed: bool = True

Fields:

• config_artifact_path (pathlib.Path)

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

• denoising_steps (int | None)

• inference_mode (omni.flux.validator.plugin.check.usd.ai.generate_pbr_material.InferenceMode)

• max_inference_resolution (int)

• min_inference_resolution (int)

• model_artifact_path (pathlib.Path)

• noise_level (float | None)

• subdirectory_per_input (bool)

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_fix_result_callback » last_fix_result

• _fire_progress_callback » progress

• file_exists » config_artifact_path

• file_exists » model_artifact_path

• sanitize_uuid » uuid

field config_artifact_path: Path [Required]

Validated by:

• file_exists

field data_flows: list[InOutDataFlow] | None = None

field denoising_steps: int | None = None

field inference_mode: InferenceMode = InferenceMode.QUALITY

field max_inference_resolution: int = 512

field min_inference_resolution: int = 64

field model_artifact_path: Path [Required]

Validated by:

• file_exists

field noise_level: float | None = None

field subdirectory_per_input: bool = True

validator file_exists  »  config_artifact_path, model_artifact_path

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

destroy()

display_name: str | None = 'Generate PBR Material'

name: ClassVar[str] = 'GeneratePBRMaterial'

tooltip = 'This plugin will generate PBR Materials from a single color texture.\n\nNOTE: Input textures larger than 512x512 can be used but will cause more artifacts in the output textures'

class omni.flux.validator.plugin.check.usd.ai.generate_pbr_material.InferenceMode(value)

Bases: Enum

An enumeration.

QUALITY = 'Quality'

SPEED = 'Speed'

class omni.flux.validator.plugin.check.usd.ai.generate_pbr_material.Prompt(

title,

text,

ok_button_text='OK',

cancel_button_text=None,

middle_button_text=None,

middle_2_button_text=None,

ok_button_fn=None,

cancel_button_fn=None,

middle_button_fn=None,

middle_2_button_fn=None,

modal=False,

on_closed_fn=None,

shortcut_keys=True,

no_title_bar=False,

width=None,

height=None,

callback_addons: List = [],

)

Bases: object

Pop up a prompt window that asks the user a simple question with up to four buttons for answers.

Callbacks are executed for each button press, as well as when the window is closed manually.

destroy()

Destructor.

hide()

Make the prompt window invisible

is_visible() → bool

Returns True if the prompt is currently visible.

Returns:

bool

set_cancel_fn(on_cancel_button_clicked)

Define a new callback for when the third (cancel) button is clicked

set_confirm_fn(on_ok_button_clicked)

Define a new callback for when the first (okay) button is clicked

set_middle_2_button_fn(on_middle_2_button_clicked)

Define a new callback for when the second (middle) button is clicked

set_middle_button_fn(on_middle_button_clicked)

Define a new callback for when the second (middle) button is clicked

set_on_closed_fn(on_on_closed)

Define a new callback for when the window is closed without pressing a button

set_text(text)

Set a new question label

show()

Make the prompt window visible

property visible

Get the prompt’s visible stat.

Returns:

True is prompt is visible else False.

Return type:

bool

omni.flux.validator.plugin.check.usd.ai.generate_pbr_material.get_telemetry_instance() → TelemetryCore

Returns:

The Telemetry core instance

• 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.check.usd.base.check_base_usd.CheckBaseUSD

Bases: CheckBase

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_fix_callback": {
         "default": null,
         "title": "On Fix Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Check Data"
      },
      "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_fix_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Message"
      },
      "last_fix_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Fix Data"
      },
      "last_fix_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Timing"
      },
      "last_fix_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Result"
      },
      "save_on_fix_failure": {
         "default": true,
         "title": "Save On Fix Failure",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      }
   },
   "$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:

• context_name (str | None)

• save_on_fix_failure (bool)

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_fix_result_callback » last_fix_result

• _fire_progress_callback » progress

• sanitize_uuid » uuid

field context_name: str | None = None

field save_on_fix_failure: bool = True

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.

async check(

schema_data: Data,

context_plugin_data: Any,

selector_plugin_data: Any,

) → Tuple[bool, str, Any]

Function that will be executed to check if asset paths on the selected prims in the attributes listed in schema data’s conversion_args are dds encoded

Note: This is intended to be run on Shader prims.

Parameters:

• schema_data – the data from the schema.

• context_plugin_data – the data from the context plugin

• selector_plugin_data – the data from the selector plugin

Returns: True if the check passed, False if not

data_type

alias of Data

async fix(

schema_data: Data,

context_plugin_data: SetupDataTypeVar,

selector_plugin_data: Any,

) → Tuple[bool, str, Any]

Function that will be called to fix the data if the fix function return False

Parameters:

• schema_data – the data from the schema.

• context_plugin_data – the data from the context plugin

• selector_plugin_data – the data from the selector plugin

Returns:

True if the fix passed, False if not. str: the message you want to show, like “Succeeded to fix this” any: data that you want to pass. For now this is used no where. So you can pass whatever you want (None)

Return type:

bool

• 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.check.usd.example.print_prims.PrintPrims

Bases: CheckBaseUSD

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_fix_callback": {
         "default": null,
         "title": "On Fix Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Check Data"
      },
      "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_fix_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Message"
      },
      "last_fix_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Fix Data"
      },
      "last_fix_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Timing"
      },
      "last_fix_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Result"
      },
      "save_on_fix_failure": {
         "default": true,
         "title": "Save On Fix Failure",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      },
      "slow_down": {
         "default": false,
         "title": "Slow Down",
         "type": "boolean"
      },
      "slow_down_value": {
         "default": 0.03,
         "title": "Slow Down Value",
         "type": "number"
      }
   },
   "$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:

• slow_down (bool)

• slow_down_value (float)

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_fix_result_callback » last_fix_result

• _fire_progress_callback » progress

• sanitize_uuid » uuid

field slow_down: bool = False

field slow_down_value: float = 0.03

model_post_init(context: Any, /) → None

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

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

Parameters:

• self – The BaseModel instance.

• context – The context.

data_type

alias of Data

name: ClassVar[str] = 'PrintPrims'

tooltip = 'This plugin will print prims from the selector plugin'

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

• SPDX-License-Identifier: Apache-2.0

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

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

• You may obtain a copy of the License at

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

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

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

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

• See the License for the specific language governing permissions and

• limitations under the License.

pydantic model omni.flux.validator.plugin.check.usd.generic.value_mapping.AttributeMapping

Bases: BaseModel

Show JSON schema

{
   "title": "AttributeMapping",
   "type": "object",
   "properties": {
      "operator": {
         "$ref": "#/$defs/Operator"
      },
      "input_value": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Input Value"
      },
      "output_value": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Output Value"
      },
      "mapping_fn": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Mapping function will be used in priority over the output_value if set",
         "title": "Mapping Fn"
      }
   },
   "$defs": {
      "Operator": {
         "enum": [
            "<",
            "<=",
            "=",
            "!=",
            ">=",
            ">",
            "All",
            "None"
         ],
         "title": "Operator",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "operator"
   ]
}

Config:

• extra: str = forbid

• validate_assignment: bool = True

Fields:

• input_value (Any | None)

• mapping_fn (str | None)

• operator (omni.flux.validator.plugin.check.usd.generic.value_mapping.Operator)

• output_value (Any | None)

field input_value: Any | None = None

field mapping_fn: str | None = None

Mapping function will be used in priority over the output_value if set

field operator: Operator [Required]

field output_value: Any | None = None

class omni.flux.validator.plugin.check.usd.generic.value_mapping.Operator(value)

Bases: Enum

An enumeration.

all_items = 'All'

eq = '='

ge = '>='

gt = '>'

le = '<='

lt = '<'

ne = '!='

no_items = 'None'

class omni.flux.validator.plugin.check.usd.generic.value_mapping.ValueMapping

Bases: CheckBaseUSD

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_fix_callback": {
         "default": null,
         "title": "On Fix Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Check Data"
      },
      "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_fix_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Message"
      },
      "last_fix_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Fix Data"
      },
      "last_fix_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Timing"
      },
      "last_fix_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Result"
      },
      "save_on_fix_failure": {
         "default": true,
         "title": "Save On Fix Failure",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      },
      "attributes": {
         "additionalProperties": {
            "items": {
               "$ref": "#/$defs/AttributeMapping"
            },
            "type": "array"
         },
         "title": "Attributes",
         "type": "object"
      }
   },
   "$defs": {
      "AttributeMapping": {
         "additionalProperties": false,
         "properties": {
            "operator": {
               "$ref": "#/$defs/Operator"
            },
            "input_value": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Input Value"
            },
            "output_value": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Output Value"
            },
            "mapping_fn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Mapping function will be used in priority over the output_value if set",
               "title": "Mapping Fn"
            }
         },
         "required": [
            "operator"
         ],
         "title": "AttributeMapping",
         "type": "object"
      },
      "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"
      },
      "Operator": {
         "enum": [
            "<",
            "<=",
            "=",
            "!=",
            ">=",
            ">",
            "All",
            "None"
         ],
         "title": "Operator",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "attributes"
   ]
}

Config:

• extra: str = forbid

• validate_assignment: bool = True

• arbitrary_types_allowed: bool = True

Fields:

• attributes (dict[str, list[omni.flux.validator.plugin.check.usd.generic.value_mapping.AttributeMapping]])

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_fix_result_callback » last_fix_result

• _fire_progress_callback » progress

• input_output_same_type » attributes

• iterable_input_output_same_length » attributes

• not_empty_attribute_name » attributes

• sanitize_uuid » uuid

• valid_inputs » attributes

field attributes: dict[str, list[AttributeMapping]] [Required]

Validated by:

• input_output_same_type

• iterable_input_output_same_length

• not_empty_attribute_name

• valid_inputs

validator input_output_same_type  »  attributes

validator iterable_input_output_same_length  »  attributes

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 not_empty_attribute_name  »  attributes

validator valid_inputs  »  attributes

data_type

alias of Data

destroy()

display_name: str | None = 'Update Attribute Values'

name: ClassVar[str] = 'ValueMapping'

tooltip = 'This plugin will remap any value to a different target value for any specified attribute'

• 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.check.usd.material.clear_unassigned_materials.ClearUnassignedMaterial

Bases: CheckBaseUSD

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_fix_callback": {
         "default": null,
         "title": "On Fix Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Check Data"
      },
      "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_fix_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Message"
      },
      "last_fix_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Fix Data"
      },
      "last_fix_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Timing"
      },
      "last_fix_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Result"
      },
      "save_on_fix_failure": {
         "default": true,
         "title": "Save On Fix Failure",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      }
   },
   "$defs": {
      "DataFlow": {
         "additionalProperties": false,
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "channel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Default",
               "title": "Channel"
            }
         },
         "required": [
            "name"
         ],
         "title": "DataFlow",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

• extra: str = forbid

• validate_assignment: bool = True

• arbitrary_types_allowed: bool = True

Fields:

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_fix_result_callback » last_fix_result

• _fire_progress_callback » progress

• sanitize_uuid » uuid

model_post_init(context: Any, /) → None

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

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

Parameters:

• self – The BaseModel instance.

• context – The context.

data_type

alias of Data

display_name: str | None = 'Clear Unassigned Material'

get_assigned_materials(

message,

stage,

selector_plugin_data,

)

get_not_assigned_materials(

stage,

assigned_materials,

)

name: ClassVar[str] = 'ClearUnassignedMaterial'

tooltip = 'This plugin will delete materials that are not assigned to anything'

• 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.check.usd.material.default_material.DefaultMaterial

Bases: CheckBaseUSD

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_fix_callback": {
         "default": null,
         "title": "On Fix Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Check Data"
      },
      "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_fix_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Message"
      },
      "last_fix_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Fix Data"
      },
      "last_fix_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Timing"
      },
      "last_fix_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Result"
      },
      "save_on_fix_failure": {
         "default": true,
         "title": "Save On Fix Failure",
         "type": "boolean"
      },
      "context_name": {
         "default": "",
         "title": "Context Name",
         "type": "string"
      },
      "default_material_mdl_url": {
         "default": "OmniPBR.mdl",
         "title": "Default Material Mdl Url",
         "type": "string"
      },
      "default_material_mdl_name": {
         "default": "OmniPBR",
         "title": "Default Material Mdl Name",
         "type": "string"
      }
   },
   "$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:

• context_name (str)

• default_material_mdl_name (str)

• default_material_mdl_url (str)

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_fix_result_callback » last_fix_result

• _fire_progress_callback » progress

• sanitize_uuid » uuid

field context_name: str = ''

field default_material_mdl_name: str = 'OmniPBR'

field default_material_mdl_url: str = 'OmniPBR.mdl'

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 = 'Create Default Materials'

name: ClassVar[str] = 'DefaultMaterial'

tooltip = 'This plugin will ensure all meshes in the stage use valid materials'

• 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.check.usd.material.material_shaders.MaterialShaders

Bases: CheckBaseUSD

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_fix_callback": {
         "default": null,
         "title": "On Fix Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Check Data"
      },
      "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_fix_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Message"
      },
      "last_fix_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Fix Data"
      },
      "last_fix_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Timing"
      },
      "last_fix_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Result"
      },
      "save_on_fix_failure": {
         "default": true,
         "title": "Save On Fix Failure",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      },
      "shader_subidentifiers": {
         "additionalProperties": {
            "type": "string"
         },
         "title": "Shader Subidentifiers",
         "type": "object"
      },
      "ignore_not_convertable_shaders": {
         "default": false,
         "title": "Ignore Not Convertable Shaders",
         "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,
   "required": [
      "shader_subidentifiers"
   ]
}

Config:

• extra: str = forbid

• validate_assignment: bool = True

• arbitrary_types_allowed: bool = True

Fields:

• context_name (str | None)

• ignore_not_convertable_shaders (bool)

• shader_subidentifiers (collections.OrderedDict[str, str])

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_fix_result_callback » last_fix_result

• _fire_progress_callback » progress

• at_least_one » shader_subidentifiers

• sanitize_uuid » uuid

• supported_shader_output » shader_subidentifiers

• valid_subidentifier » shader_subidentifiers

field context_name: str | None = None

field ignore_not_convertable_shaders: bool = False

field shader_subidentifiers: OrderedDict[str, str] [Required]

Validated by:

• at_least_one

• supported_shader_output

• valid_subidentifier

validator at_least_one  »  shader_subidentifiers

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 supported_shader_output  »  shader_subidentifiers

validator valid_subidentifier  »  shader_subidentifiers

data_type

alias of Data

display_name: str | None = 'Convert Material Shaders'

name: ClassVar[str] = 'MaterialShaders'

tooltip = 'This plugin will ensure all materials in the stage use valid shaders'

omni.flux.validator.plugin.check.usd.material.material_shaders.disable_orphan_parameter_cleanup()

Disable orphan parameter cleanup temporarily

• 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.check.usd.mesh.add_vertex_indices_to_geom_subsets.AddVertexIndicesToGeomSubsets

Bases: CheckBaseUSD

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_fix_callback": {
         "default": null,
         "title": "On Fix Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Check Data"
      },
      "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_fix_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Message"
      },
      "last_fix_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Fix Data"
      },
      "last_fix_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Timing"
      },
      "last_fix_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Result"
      },
      "save_on_fix_failure": {
         "default": true,
         "title": "Save On Fix Failure",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      }
   },
   "$defs": {
      "DataFlow": {
         "additionalProperties": false,
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "channel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Default",
               "title": "Channel"
            }
         },
         "required": [
            "name"
         ],
         "title": "DataFlow",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

• extra: str = forbid

• validate_assignment: bool = True

• arbitrary_types_allowed: bool = True

Fields:

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_fix_result_callback » last_fix_result

• _fire_progress_callback » progress

• sanitize_uuid » uuid

model_post_init(

context: Any,

/,

) → None

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

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

Parameters:

• self – The BaseModel instance.

• context – The context.

data_type

alias of Data

display_name: str | None = 'Add Vertex Indices to Geometry Subsets'

name: ClassVar[str] = 'AddVertexIndicesToGeomSubsets'

tooltip = 'This plugin will ensure any GeomSubsets of the input triangulated mesh prims have up-to-date per-vertex indices properties.'

• 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.check.usd.mesh.force_primvar_to_vertex_interpolation.ForcePrimvarToVertexInterpolation

Bases: CheckBaseUSD

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_fix_callback": {
         "default": null,
         "title": "On Fix Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Check Data"
      },
      "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_fix_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Message"
      },
      "last_fix_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Fix Data"
      },
      "last_fix_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Timing"
      },
      "last_fix_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Result"
      },
      "save_on_fix_failure": {
         "default": true,
         "title": "Save On Fix Failure",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      }
   },
   "$defs": {
      "DataFlow": {
         "additionalProperties": false,
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "channel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Default",
               "title": "Channel"
            }
         },
         "required": [
            "name"
         ],
         "title": "DataFlow",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

• extra: str = forbid

• validate_assignment: bool = True

• arbitrary_types_allowed: bool = True

Fields:

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_fix_result_callback » last_fix_result

• _fire_progress_callback » progress

• sanitize_uuid » uuid

model_post_init(

context: Any,

/,

) → None

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

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

Parameters:

• self – The BaseModel instance.

• context – The context.

data_type

alias of Data

display_name: str | None = 'Force Vertex Interpolation'

name: ClassVar[str] = 'ForcePrimvarToVertexInterpolation'

tooltip = 'This plugin will ensure that per vertex data does not use the `varying` or `faceVarying` interpolation schemes.'

• 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.check.usd.mesh.triangulate.Triangulate

Bases: CheckBaseUSD

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_fix_callback": {
         "default": null,
         "title": "On Fix Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Check Data"
      },
      "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_fix_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Message"
      },
      "last_fix_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Fix Data"
      },
      "last_fix_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Timing"
      },
      "last_fix_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Result"
      },
      "save_on_fix_failure": {
         "default": true,
         "title": "Save On Fix Failure",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      }
   },
   "$defs": {
      "DataFlow": {
         "additionalProperties": false,
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "channel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Default",
               "title": "Channel"
            }
         },
         "required": [
            "name"
         ],
         "title": "DataFlow",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

• extra: str = forbid

• validate_assignment: bool = True

• arbitrary_types_allowed: bool = True

Fields:

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_fix_result_callback » last_fix_result

• _fire_progress_callback » progress

• sanitize_uuid » uuid

model_post_init(context: Any, /) → None

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

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

Parameters:

• self – The BaseModel instance.

• context – The context.

data_type

alias of Data

display_name: str | None = 'Triangulate Mesh'

name: ClassVar[str] = 'Triangulate'

tooltip = 'This plugin will check if meshes are triangulated, or triangulate them.  Includes processing GeomSubsets'

• 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.check.usd.meta.default_prim.DefaultPrim

Bases: CheckBaseUSD

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_fix_callback": {
         "default": null,
         "title": "On Fix Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Check Data"
      },
      "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_fix_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Message"
      },
      "last_fix_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Fix Data"
      },
      "last_fix_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Timing"
      },
      "last_fix_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Result"
      },
      "save_on_fix_failure": {
         "default": true,
         "title": "Save On Fix Failure",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      },
      "manual_selection": {
         "default": false,
         "title": "Manual Selection",
         "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:

• manual_selection (bool)

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_fix_result_callback » last_fix_result

• _fire_progress_callback » progress

• sanitize_uuid » uuid

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

destroy()

Destroy.

display_name: str | None = 'Has Default Prim'

name: ClassVar[str] = 'DefaultPrim'

tooltip = 'This plugin will ensure a usd file has a default prim.'

• 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.check.usd.meta.wrap_root_prims.WrapRootPrims

Bases: CheckBaseUSD

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_fix_callback": {
         "default": null,
         "title": "On Fix Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Check Data"
      },
      "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_fix_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Message"
      },
      "last_fix_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Fix Data"
      },
      "last_fix_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Timing"
      },
      "last_fix_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Result"
      },
      "save_on_fix_failure": {
         "default": true,
         "title": "Save On Fix Failure",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      },
      "set_default_prim": {
         "default": true,
         "title": "Set Default Prim",
         "type": "boolean"
      },
      "wrap_prim_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Wrap Prim Name"
      }
   },
   "$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:

• set_default_prim (bool)

• wrap_prim_name (str | None)

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_fix_result_callback » last_fix_result

• _fire_progress_callback » progress

• is_not_empty » wrap_prim_name

• is_valid_prim_path » wrap_prim_name

• sanitize_uuid » uuid

field set_default_prim: bool = True

field wrap_prim_name: str | None = None

Validated by:

• is_not_empty

• is_valid_prim_path

validator is_not_empty  »  wrap_prim_name

validator is_valid_prim_path  »  wrap_prim_name

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 = 'Wrap Root Prims'

name: ClassVar[str] = 'WrapRootPrims'

tooltip = 'This plugin will wrap all the root prims into an empty Xform prim and optionally set the wrapper as the default prim.'

• 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.check.usd.paths.relative_asset_paths.RelativeAssetPaths

Bases: CheckBaseUSD

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_fix_callback": {
         "default": null,
         "title": "On Fix Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Check Data"
      },
      "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_fix_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Message"
      },
      "last_fix_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Fix Data"
      },
      "last_fix_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Timing"
      },
      "last_fix_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Result"
      },
      "save_on_fix_failure": {
         "default": true,
         "title": "Save On Fix Failure",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      }
   },
   "$defs": {
      "DataFlow": {
         "additionalProperties": false,
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "channel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Default",
               "title": "Channel"
            }
         },
         "required": [
            "name"
         ],
         "title": "DataFlow",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

• extra: str = forbid

• validate_assignment: bool = True

• arbitrary_types_allowed: bool = True

Fields:

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_fix_result_callback » last_fix_result

• _fire_progress_callback » progress

• sanitize_uuid » uuid

model_post_init(context: Any, /) → None

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

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

Parameters:

• self – The BaseModel instance.

• context – The context.

data_type

alias of Data

display_name: str | None = 'Make Asset Paths Relative'

name: ClassVar[str] = 'RelativeAssetPaths'

tooltip = 'This plugin will replace absolute asset paths with relative paths.'

• 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.check.usd.paths.relative_references.RelativeReferences

Bases: CheckBaseUSD

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_fix_callback": {
         "default": null,
         "title": "On Fix Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Check Data"
      },
      "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_fix_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Message"
      },
      "last_fix_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Fix Data"
      },
      "last_fix_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Timing"
      },
      "last_fix_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Result"
      },
      "save_on_fix_failure": {
         "default": true,
         "title": "Save On Fix Failure",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      }
   },
   "$defs": {
      "DataFlow": {
         "additionalProperties": false,
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "channel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Default",
               "title": "Channel"
            }
         },
         "required": [
            "name"
         ],
         "title": "DataFlow",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

• extra: str = forbid

• validate_assignment: bool = True

• arbitrary_types_allowed: bool = True

Fields:

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_fix_result_callback » last_fix_result

• _fire_progress_callback » progress

• sanitize_uuid » uuid

model_post_init(context: Any, /) → None

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

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

Parameters:

• self – The BaseModel instance.

• context – The context.

data_type

alias of Data

display_name: str | None = 'Make References Relative'

name: ClassVar[str] = 'RelativeReferences'

tooltip = 'This plugin will replace absolute reference paths with relative paths.'

• 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.check.usd.render.generate_thumbnail.GenerateThumbnail

Bases: CheckBaseUSD

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_fix_callback": {
         "default": null,
         "title": "On Fix Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Check Data"
      },
      "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_fix_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Message"
      },
      "last_fix_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Fix Data"
      },
      "last_fix_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Timing"
      },
      "last_fix_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Result"
      },
      "save_on_fix_failure": {
         "default": true,
         "title": "Save On Fix Failure",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      },
      "light_rig_path": {
         "default": "${omni.flux.validator.plugin.check.usd}/data/rigs/default_light_template.usda",
         "title": "Light Rig Path",
         "type": "string"
      },
      "light_rotation": {
         "anyOf": [
            {
               "maxItems": 3,
               "minItems": 3,
               "prefixItems": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "number"
                  },
                  {
                     "type": "number"
                  }
               ],
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Light Rotation"
      },
      "thumbnail_size": {
         "default": [
            256,
            256
         ],
         "maxItems": 2,
         "minItems": 2,
         "prefixItems": [
            {
               "type": "integer"
            },
            {
               "type": "integer"
            }
         ],
         "title": "Thumbnail Size",
         "type": "array"
      },
      "render_mode": {
         "default": "RayTracing",
         "title": "Render Mode",
         "type": "string"
      },
      "light_intensity_multipler": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "title": "Light Intensity Multipler"
      },
      "viewport_api": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Viewport Api"
      }
   },
   "$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:

• light_intensity_multipler (int | None)

• light_rig_path (str)

• light_rotation (Tuple[float, float, float] | None)

• render_mode (str)

• thumbnail_size (Tuple[int, int])

• viewport_api (str | None)

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_fix_result_callback » last_fix_result

• _fire_progress_callback » progress

• sanitize_uuid » uuid

field light_intensity_multipler: int | None = 1

field light_rig_path: str = '${omni.flux.validator.plugin.check.usd}/data/rigs/default_light_template.usda'

field light_rotation: Tuple[float, float, float] | None = None

field render_mode: str = 'RayTracing'

field thumbnail_size: Tuple[int, int] = (256, 256)

field viewport_api: str | None = None

model_post_init(context: Any, /) → None

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

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

Parameters:

• self – The BaseModel instance.

• context – The context.

data_type

alias of Data

display_name: str | None = 'Generate the thumbnail'

name: ClassVar[str] = 'GenerateThumbnail'

tooltip = 'This plugin will generate the thumbnail'

omni.flux.validator.plugin.check.usd.render.generate_thumbnail.capture_viewport_to_buffer(

viewport_api,

on_capture_fn: Callable,

is_hdr: bool = False,

)

Captures the current viewport and sends the image to a callback function.

Parameters:

• viewport_api (ViewportAPI) – The viewport API instance to capture.

• on_capture_fn (Callable) – The callback function that will receive the image.

• is_hdr (bool, optional) – If True, captures the HDR buffer; otherwise, captures the LDR buffer. Defaults to False.

Returns:

A future-like object that can be awaited to ensure the capture completes.

omni.flux.validator.plugin.check.usd.render.generate_thumbnail.frame_viewport_selection(

viewport_api=None,

force_legacy_api: bool = False,

)

Frames the camera in the viewport to include the current selection.

This function adjusts the camera in the viewport to frame the currently selected objects. If no objects are selected, it adjusts the camera to show the entire scene.

Parameters:

• viewport_api (ViewportAPI, optional) – The viewport API instance to operate on. If not provided, the active viewport is used.

• force_legacy_api (bool, optional) – If set to True, forces the use of the legacy viewport API. Defaults to False.

Returns:

True if the operation was successful, False otherwise.

Return type:

bool

omni.flux.validator.plugin.check.usd.render.generate_thumbnail.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.

pydantic model omni.flux.validator.plugin.check.usd.texture.convert_to_dds.ConversionArgs

Bases: BaseModel

Show JSON schema

{
   "title": "ConversionArgs",
   "type": "object",
   "properties": {
      "args": {
         "items": {
            "type": "string"
         },
         "title": "Args",
         "type": "array"
      }
   },
   "additionalProperties": false,
   "required": [
      "args"
   ]
}

Config:

• extra: str = forbid

Fields:

• args (list[str])

field args: list[str] [Required]

class omni.flux.validator.plugin.check.usd.texture.convert_to_dds.ConvertToDDS

Bases: CheckBaseUSD

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_fix_callback": {
         "default": null,
         "title": "On Fix Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Check Data"
      },
      "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_fix_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Message"
      },
      "last_fix_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Fix Data"
      },
      "last_fix_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Timing"
      },
      "last_fix_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Result"
      },
      "save_on_fix_failure": {
         "default": true,
         "title": "Save On Fix Failure",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      },
      "conversion_args": {
         "additionalProperties": {
            "$ref": "#/$defs/ConversionArgs"
         },
         "default": {
            "inputs:diffuse_texture": {
               "args": [
                  "--format",
                  "bc7",
                  "--mip-gamma-correct"
               ]
            },
            "inputs:normalmap_texture": {
               "args": [
                  "--format",
                  "bc5",
                  "--no-mip-gamma-correct"
               ]
            },
            "inputs:reflectionroughness_texture": {
               "args": [
                  "--format",
                  "bc4",
                  "--no-mip-gamma-correct"
               ]
            },
            "inputs:emissive_mask_texture": {
               "args": [
                  "--format",
                  "bc7",
                  "--mip-gamma-correct"
               ]
            },
            "inputs:metallic_texture": {
               "args": [
                  "--format",
                  "bc4",
                  "--no-mip-gamma-correct"
               ]
            },
            "inputs:height_texture": {
               "args": [
                  "--format",
                  "bc4",
                  "--no-mip-gamma-correct",
                  "--mip-filter",
                  "max"
               ]
            },
            "inputs:transmittance_texture": {
               "args": [
                  "--format",
                  "bc7",
                  "--mip-gamma-correct"
               ]
            }
         },
         "title": "Conversion Args",
         "type": "object"
      },
      "replace_udim_textures_by_empty": {
         "default": false,
         "title": "Replace Udim Textures By Empty",
         "type": "boolean"
      },
      "suffix": {
         "default": ".rtex.dds",
         "title": "Suffix",
         "type": "string"
      }
   },
   "$defs": {
      "ConversionArgs": {
         "additionalProperties": false,
         "properties": {
            "args": {
               "items": {
                  "type": "string"
               },
               "title": "Args",
               "type": "array"
            }
         },
         "required": [
            "args"
         ],
         "title": "ConversionArgs",
         "type": "object"
      },
      "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:

• conversion_args (dict[str, omni.flux.validator.plugin.check.usd.texture.convert_to_dds.ConversionArgs])

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

• replace_udim_textures_by_empty (bool)

• suffix (str)

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_fix_result_callback » last_fix_result

• _fire_progress_callback » progress

• dot_in_suffix » suffix

• sanitize_uuid » uuid

field conversion_args: dict[str, ConversionArgs] = {'inputs:diffuse_texture': ConversionArgs(args=['--format', 'bc7', '--mip-gamma-correct']), 'inputs:emissive_mask_texture': ConversionArgs(args=['--format', 'bc7', '--mip-gamma-correct']), 'inputs:height_texture': ConversionArgs(args=['--format', 'bc4', '--no-mip-gamma-correct', '--mip-filter', 'max']), 'inputs:metallic_texture': ConversionArgs(args=['--format', 'bc4', '--no-mip-gamma-correct']), 'inputs:normalmap_texture': ConversionArgs(args=['--format', 'bc5', '--no-mip-gamma-correct']), 'inputs:reflectionroughness_texture': ConversionArgs(args=['--format', 'bc4', '--no-mip-gamma-correct']), 'inputs:transmittance_texture': ConversionArgs(args=['--format', 'bc7', '--mip-gamma-correct'])}

field data_flows: list[InOutDataFlow] | None = None

field replace_udim_textures_by_empty: bool = False

field suffix: str = '.rtex.dds'

Validated by:

• dot_in_suffix

validator dot_in_suffix  »  suffix

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 = 'Convert Textures to DDS'

name: ClassVar[str] = 'ConvertToDDS'

tooltip = 'This plugin will ensure all textures are encoded as DDS'

omni.flux.validator.plugin.check.usd.texture.convert_to_dds.as_completed(fs, timeout=None)

An iterator over the given futures that yields each as it completes.

Parameters:

• fs – The sequence of Futures (possibly created by different Executors) to iterate over.

• timeout – The maximum number of seconds to wait. If None, then there is no limit on the wait time.

Returns:

An iterator that yields the given Futures as they complete (finished or cancelled). If any given Futures are duplicated, they will be returned once.

Raises:

TimeoutError – If the entire result iterator could not be generated before the given timeout.

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

• SPDX-License-Identifier: Apache-2.0

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

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

• You may obtain a copy of the License at

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

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

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

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

• See the License for the specific language governing permissions and

• limitations under the License.

pydantic model omni.flux.validator.plugin.check.usd.texture.convert_to_octahedral.ConversionArgs

Bases: BaseModel

Show JSON schema

{
   "title": "ConversionArgs",
   "type": "object",
   "properties": {
      "encoding_attr": {
         "title": "Encoding Attr",
         "type": "string"
      },
      "suffix": {
         "title": "Suffix",
         "type": "string"
      },
      "replace_suffix": {
         "title": "Replace Suffix",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "encoding_attr",
      "suffix",
      "replace_suffix"
   ]
}

Config:

• extra: str = forbid

Fields:

• encoding_attr (str)

• replace_suffix (str)

• suffix (str)

Validators:

• dot_not_in_replace_suffix » replace_suffix

• dot_not_in_suffix » suffix

field encoding_attr: str [Required]

field replace_suffix: str [Required]

Validated by:

• dot_not_in_replace_suffix

field suffix: str [Required]

Validated by:

• dot_not_in_suffix

validator dot_not_in_replace_suffix  »  replace_suffix

validator dot_not_in_suffix  »  suffix

class omni.flux.validator.plugin.check.usd.texture.convert_to_octahedral.ConvertToOctahedral

Bases: CheckBaseUSD

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_fix_callback": {
         "default": null,
         "title": "On Fix Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Check Data"
      },
      "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_fix_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Message"
      },
      "last_fix_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Fix Data"
      },
      "last_fix_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Timing"
      },
      "last_fix_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Result"
      },
      "save_on_fix_failure": {
         "default": true,
         "title": "Save On Fix Failure",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      },
      "conversion_args": {
         "additionalProperties": {
            "$ref": "#/$defs/ConversionArgs"
         },
         "default": {
            "inputs:normalmap_texture": {
               "encoding_attr": "inputs:encoding",
               "replace_suffix": "_Normal",
               "suffix": "_OTH_Normal"
            }
         },
         "title": "Conversion Args",
         "type": "object"
      },
      "replace_udim_textures_by_empty": {
         "default": false,
         "title": "Replace Udim Textures By Empty",
         "type": "boolean"
      }
   },
   "$defs": {
      "ConversionArgs": {
         "additionalProperties": false,
         "properties": {
            "encoding_attr": {
               "title": "Encoding Attr",
               "type": "string"
            },
            "suffix": {
               "title": "Suffix",
               "type": "string"
            },
            "replace_suffix": {
               "title": "Replace Suffix",
               "type": "string"
            }
         },
         "required": [
            "encoding_attr",
            "suffix",
            "replace_suffix"
         ],
         "title": "ConversionArgs",
         "type": "object"
      },
      "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:

• conversion_args (dict[str, omni.flux.validator.plugin.check.usd.texture.convert_to_octahedral.ConversionArgs])

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

• replace_udim_textures_by_empty (bool)

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_fix_result_callback » last_fix_result

• _fire_progress_callback » progress

• sanitize_uuid » uuid

field conversion_args: dict[str, ConversionArgs] = {'inputs:normalmap_texture': ConversionArgs(encoding_attr='inputs:encoding', suffix='_OTH_Normal', replace_suffix='_Normal')}

field data_flows: list[InOutDataFlow] | None = None

field replace_udim_textures_by_empty: 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 = 'Convert Normal Maps to Octahedral'

name: ClassVar[str] = 'ConvertToOctahedral'

tooltip = 'This plugin will ensure all normal maps are octahedral encoded'

class omni.flux.validator.plugin.check.usd.texture.convert_to_octahedral.NormalMapEncodings(value)

Bases: IntEnum

An enumeration.

OCTAHEDRAL = 0

TANGENT_SPACE_DX = 2

TANGENT_SPACE_OGL = 1

class omni.flux.validator.plugin.check.usd.texture.convert_to_octahedral.OctahedralConverter

Bases: object

static convert_dx_file_to_octahedral(dx_path, oth_path)

static convert_dx_to_octahedral(image)

static convert_ogl_file_to_octahedral(ogl_path, oth_path)

static convert_ogl_to_octahedral(image)

omni.flux.validator.plugin.check.usd.texture.convert_to_octahedral.as_completed(fs, timeout=None)

An iterator over the given futures that yields each as it completes.

Parameters:

• fs – The sequence of Futures (possibly created by different Executors) to iterate over.

• timeout – The maximum number of seconds to wait. If None, then there is no limit on the wait time.

Returns:

An iterator that yields the given Futures as they complete (finished or cancelled). If any given Futures are duplicated, they will be returned once.

Raises:

TimeoutError – If the entire result iterator could not be generated before the given timeout.

• 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.check.usd.texture.mass_texture_preview.MassTexturePreview

Bases: CheckBaseUSD

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_fix_callback": {
         "default": null,
         "title": "On Fix Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Check Data"
      },
      "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_fix_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Message"
      },
      "last_fix_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Fix Data"
      },
      "last_fix_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Timing"
      },
      "last_fix_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Result"
      },
      "save_on_fix_failure": {
         "default": true,
         "title": "Save On Fix Failure",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      },
      "temp_usd": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Temp Usd"
      }
   },
   "$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:

• temp_usd (str | None)

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_fix_result_callback » last_fix_result

• _fire_progress_callback » progress

• sanitize_uuid » uuid

field temp_usd: str | None = None

model_post_init(context: Any, /) → None

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

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

Parameters:

• self – The BaseModel instance.

• context – The context.

data_type

alias of Data

display_name: str | None = 'Mass Texture Preview'

name: ClassVar[str] = 'MassTexturePreview'

tooltip = 'This plugin is a fake check plugin that we use to show texture preview (in viewport or not)'

omni.flux.validator.plugin.check.usd.texture.mass_texture_preview.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.check.usd.xform.apply_unit_scale.ApplyUnitScale

Bases: CheckBaseUSD

DEFAULT_UI_WIDTH_PIXEL = 120

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_fix_callback": {
         "default": null,
         "title": "On Fix Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Check Data"
      },
      "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_fix_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Message"
      },
      "last_fix_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Fix Data"
      },
      "last_fix_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Timing"
      },
      "last_fix_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Result"
      },
      "save_on_fix_failure": {
         "default": true,
         "title": "Save On Fix Failure",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      },
      "scale_target": {
         "default": 1.0,
         "title": "Scale Target",
         "type": "number"
      }
   },
   "$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:

• scale_target (float)

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_fix_result_callback » last_fix_result

• _fire_progress_callback » progress

• non_zero_positive_number » scale_target

• sanitize_uuid » uuid

field scale_target: float = 1.0

Validated by:

• non_zero_positive_number

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 non_zero_positive_number  »  scale_target

data_type

alias of Data

destroy()

display_name: str | None = 'Apply Unit Scale to Mesh'

name: ClassVar[str] = 'ApplyUnitScale'

tooltip = "This plugin will apply the meshes' metersPerUnit scaling to their XForm scale."

• 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.check.usd.xform.reset_pivot.ResetPivot

Bases: CheckBaseUSD

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_fix_callback": {
         "default": null,
         "title": "On Fix Callback"
      },
      "last_check_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Check Message"
      },
      "last_check_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Check Data"
      },
      "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_fix_message": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Message"
      },
      "last_fix_data": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is tmp we don't keep it in the schema",
         "title": "Last Fix Data"
      },
      "last_fix_timing": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Timing"
      },
      "last_fix_result": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Last Fix Result"
      },
      "save_on_fix_failure": {
         "default": true,
         "title": "Save On Fix Failure",
         "type": "boolean"
      },
      "context_name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Context Name"
      },
      "pivot_position": {
         "default": [
            0.0,
            0.0,
            0.0
         ],
         "maxItems": 3,
         "minItems": 3,
         "prefixItems": [
            {
               "type": "number"
            },
            {
               "type": "number"
            },
            {
               "type": "number"
            }
         ],
         "title": "Pivot Position",
         "type": "array"
      }
   },
   "$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:

• pivot_position (tuple[float, float, float])

Validators:

• _fire_global_progress_value_callback » global_progress_value

• _fire_last_check_result_callback » last_check_result

• _fire_last_fix_result_callback » last_fix_result

• _fire_progress_callback » progress

• sanitize_uuid » uuid

• translate_format_valid » pivot_position

field pivot_position: tuple[float, float, float] = (0.0, 0.0, 0.0)

Validated by:

• translate_format_valid

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 translate_format_valid  »  pivot_position

data_type

alias of Data

display_name: str | None = 'Reset Prim Pivot'

name: ClassVar[str] = 'ResetPivot'

tooltip = "This plugin will reset the selected prim's pivot to the desired position."