omni.flux.validator.plugin.context.usd_stage#

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

  • SPDX-License-Identifier: Apache-2.0

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

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

  • You may obtain a copy of the License at

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

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

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

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

  • See the License for the specific language governing permissions and

  • limitations under the License.

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

Create Final Configuration

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

  • SPDX-License-Identifier: Apache-2.0

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

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

  • You may obtain a copy of the License at

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

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

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

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

  • See the License for the specific language governing permissions and

  • limitations under the License.

class omni.flux.validator.plugin.context.usd_stage.asset_importer.AssetImporter#
pydantic model Data#
Config:

  • extra: str = forbid

  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Validators:

  • _fire_global_progress_value_callback » global_progress_value

  • _fire_last_check_result_callback » last_check_result

  • _fire_last_exit_result_callback » last_on_exit_result

  • _fire_last_set_result_callback » last_set_result

  • _fire_progress_callback » progress

  • sanitize_uuid » uuid

field bake_material: Annotated[bool, SkipValidation()] = False#
field baking_scales: Annotated[bool, SkipValidation()] = False#
field convert_fbx_to_y_up: Annotated[bool, SkipValidation()] = False#
field convert_fbx_to_z_up: Annotated[bool, SkipValidation()] = False#
field convert_stage_up_y: Annotated[bool, SkipValidation()] = False#
field convert_stage_up_z: Annotated[bool, SkipValidation()] = False#
field create_world_as_default_root_prim: Annotated[bool, SkipValidation()] = True#
field disabling_instancing: Annotated[bool, SkipValidation()] = False#
field embed_mdl_in_usd: Annotated[bool, SkipValidation()] = True#
field embed_textures: Annotated[bool, SkipValidation()] = True#
field export_hidden_props: Annotated[bool, SkipValidation()] = False#
field export_mdl_gltf_extension: Annotated[bool, SkipValidation()] = False#
field export_preview_surface: Annotated[bool, SkipValidation()] = False#
field export_separate_gltf: Annotated[bool, SkipValidation()] = False#
field ignore_animations: Annotated[bool, SkipValidation()] = False#
field ignore_camera: Annotated[bool, SkipValidation()] = False#
field ignore_flip_rotations: Annotated[bool, SkipValidation()] = False#
field ignore_light: Annotated[bool, SkipValidation()] = False#
field ignore_materials: Annotated[bool, SkipValidation()] = False#
field ignore_pivots: Annotated[bool, SkipValidation()] = False#
field ignore_unbound_bones: Annotated[bool, SkipValidation()] = False#
field keep_all_materials: Annotated[bool, SkipValidation()] = False#
field merge_all_meshes: Annotated[bool, SkipValidation()] = False#
field single_mesh: Annotated[bool, SkipValidation()] = False#
field smooth_normals: Annotated[bool, SkipValidation()] = True#
field support_point_instancer: Annotated[bool, SkipValidation()] = False#
field use_double_precision_to_usd_transform_op: Annotated[bool, SkipValidation()] = False#
field use_meter_as_world_unit: Annotated[bool, SkipValidation()] = False#
model_post_init(context: Any, /) → None#

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

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

Parameters:

  • self – The BaseModel instance.

  • context – The context.

pydantic model DataBase#
Config:

  • extra: str = forbid

  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:

  • allow_empty_input_files_list (bool | None)

  • close_stage_on_exit (bool)

  • create_output_directory_if_missing (bool)

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

  • default_output_endpoint (str | None)

  • full_path_keep (bool)

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

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

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

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

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

Validators:
field allow_empty_input_files_list: bool | None = False#
field close_stage_on_exit: bool = False#
field create_output_directory_if_missing: bool = True#
field data_flows: list[InOutDataFlow] | None = None#
field default_output_endpoint: str | None = None#

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

field full_path_keep: bool = False#

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

field full_path_root: OmniUrl | None = None#
field input_files: list[OmniUrl] [Required]#
Validated by:
field output_directory: OmniUrl [Required]#
Validated by:
field output_files: dict[str, str] | None = None#

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

field output_usd_extension: UsdExtensions | None = None#
validator at_least_one  »  input_files#
validator can_have_children  »  output_directory#
validator is_readable  »  input_files#
model_post_init(context: Any, /) → None#

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

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

Parameters:

  • self – The BaseModel instance.

  • context – The context.

validator output_dir_unequal_input_dirs  »  output_directory#
data_type#

alias of Data

handle_drop(event: Any) → None#

Forward a drop event to the file list. Used by drop-aware tab pages in mass widget.

show(
value: bool,
schema_data: Data,
)#

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

property visible: bool#

Whether the file list widget is visible (e.g. only the active tab’s list accepts drops in mass UI).

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

  • SPDX-License-Identifier: Apache-2.0

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

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

  • You may obtain a copy of the License at

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

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

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

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

  • See the License for the specific language governing permissions and

  • limitations under the License.

class omni.flux.validator.plugin.context.usd_stage.current_stage.CurrentStage#
pydantic model Data#
Config:

  • extra: str = forbid

  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:

  • close_stage_on_exit (bool)

  • save_on_exit (bool)

Validators:

  • _fire_global_progress_value_callback » global_progress_value

  • _fire_last_check_result_callback » last_check_result

  • _fire_last_exit_result_callback » last_on_exit_result

  • _fire_last_set_result_callback » last_set_result

  • _fire_progress_callback » progress

  • sanitize_uuid » uuid

field close_stage_on_exit: bool = False#
field save_on_exit: bool = False#
model_post_init(context: Any, /) → None#

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

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

Parameters:

  • self – The BaseModel instance.

  • context – The context.

data_type#

alias of Data

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

  • SPDX-License-Identifier: Apache-2.0

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

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

  • You may obtain a copy of the License at

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

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

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

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

  • See the License for the specific language governing permissions and

  • limitations under the License.

class omni.flux.validator.plugin.context.usd_stage.dependency_iterator.DependencyIterator#
pydantic model Data#
Config:

  • extra: str = forbid

  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:

  • close_dependency_between_round (bool)

  • close_stage_on_exit (bool)

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

  • save_all_layers_on_exit (bool)

Validators:

  • _fire_global_progress_value_callback » global_progress_value

  • _fire_last_check_result_callback » last_check_result

  • _fire_last_exit_result_callback » last_on_exit_result

  • _fire_last_set_result_callback » last_set_result

  • _fire_progress_callback » progress

  • sanitize_uuid » uuid

field close_dependency_between_round: bool = True#
field close_stage_on_exit: bool = False#
field data_flows: list[InOutDataFlow] | None = None#
field save_all_layers_on_exit: bool = False#
model_post_init(context: Any, /) → None#

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

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

Parameters:

  • self – The BaseModel instance.

  • context – The context.

data_type#

alias of Data

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

  • SPDX-License-Identifier: Apache-2.0

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

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

  • You may obtain a copy of the License at

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

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

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

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

  • See the License for the specific language governing permissions and

  • limitations under the License.

class omni.flux.validator.plugin.context.usd_stage.texture_importer.TextureImporter#
pydantic model Data#
Config:

  • extra: str = forbid

  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:

  • allow_empty_input_files_list (bool | None)

  • create_output_directory_if_missing (bool)

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

  • default_output_endpoint (str | None)

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

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

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

Validators:

  • _fire_global_progress_value_callback » global_progress_value

  • _fire_last_check_result_callback » last_check_result

  • _fire_last_exit_result_callback » last_on_exit_result

  • _fire_last_set_result_callback » last_set_result

  • _fire_progress_callback » progress

  • at_least_one » input_files

  • can_have_children » output_directory

  • is_valid » input_files

  • output_dir_unequal_input_dirs » output_directory

  • sanitize_uuid » uuid

field allow_empty_input_files_list: bool | None = False#
field create_output_directory_if_missing: bool = True#
field data_flows: list[InOutDataFlow] | None = None#
field default_output_endpoint: str | None = None#
field error_on_texture_types: list[TextureTypes] | None = None#
field input_files: list[tuple[OmniUrl, TextureTypes]] [Required]#
Validated by:
field output_directory: OmniUrl [Required]#
Validated by:
validator at_least_one  »  input_files#
validator can_have_children  »  output_directory#
validator is_valid  »  input_files#
model_post_init(context: Any, /) → None#

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

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

Parameters:

  • self – The BaseModel instance.

  • context – The context.

validator output_dir_unequal_input_dirs  »  output_directory#
data_type#

alias of Data

handle_drop(event: Any) → None#

Forward a drop event to the texture list. Used by drop-aware tab pages in mass widget.

show(
value: bool,
schema_data: Data,
)#

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

property visible: bool#

Whether the file list widget is visible (e.g. only the active tab’s list accepts drops in mass UI).

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

  • SPDX-License-Identifier: Apache-2.0

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

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

  • You may obtain a copy of the License at

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

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

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

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

  • See the License for the specific language governing permissions and

  • limitations under the License.

class omni.flux.validator.plugin.context.usd_stage.usd_directory.USDDirectory#
pydantic model Data#
Config:

  • extra: str = forbid

  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:

  • close_dependency_between_round (bool)

  • close_stage_on_exit (bool)

  • cooked_files (list[str] | None)

  • data_flows (list[_InOutDataFlow] | None)

  • directory (str)

  • file_validated_fixes (set[str] | None)

  • ignore_paths (list[str] | None)

  • recursive (bool)

  • save_all_layers_on_exit (bool)

  • skip_validated_files (bool)

Validators:

  • _fire_global_progress_value_callback » global_progress_value

  • _fire_last_check_result_callback » last_check_result

  • _fire_last_exit_result_callback » last_on_exit_result

  • _fire_last_set_result_callback » last_set_result

  • _fire_progress_callback » progress

  • file_validated_fixes_set » all fields

  • sanitize_uuid » uuid

field close_dependency_between_round: bool = True#
Validated by:
field close_stage_on_exit: bool = False#
Validated by:
field cooked_files: list[str] | None = None#
Validated by:
field data_flows: list[_InOutDataFlow] | None = None#
Validated by:
field directory: str [Required]#
Validated by:
field file_validated_fixes: set[str] | None = None#
Validated by:
field ignore_paths: list[str] | None = None#
Validated by:
field recursive: bool = True#
Validated by:
field save_all_layers_on_exit: bool = False#
Validated by:
field skip_validated_files: bool = False#
Validated by:
validator file_validated_fixes_set  »  all fields#
model_post_init(context: Any, /) → None#

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

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

Parameters:

  • self – The BaseModel instance.

  • context – The context.

data_type#

alias of Data

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

  • SPDX-License-Identifier: Apache-2.0

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

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

  • You may obtain a copy of the License at

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

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

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

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

  • See the License for the specific language governing permissions and

  • limitations under the License.

class omni.flux.validator.plugin.context.usd_stage.usd_file.USDFile#
pydantic model Data#
Config:

  • extra: str = forbid

  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:

  • close_stage_on_exit (bool)

  • data_flows (list[_InOutDataFlow] | None)

  • file (str)

  • file_validated_fixes (set[str] | None)

  • save_on_exit (bool)

  • skip_validated_files (bool)

Validators:

  • _fire_global_progress_value_callback » global_progress_value

  • _fire_last_check_result_callback » last_check_result

  • _fire_last_exit_result_callback » last_on_exit_result

  • _fire_last_set_result_callback » last_set_result

  • _fire_progress_callback » progress

  • file_validated_fixes_set » all fields

  • sanitize_uuid » uuid

field close_stage_on_exit: bool = False#
Validated by:
field data_flows: list[_InOutDataFlow] | None = None#
Validated by:
field file: str [Required]#
Validated by:
field file_validated_fixes: set[str] | None = None#
Validated by:
field save_on_exit: bool = False#
Validated by:
field skip_validated_files: bool = False#
Validated by:
validator file_validated_fixes_set  »  all fields#
model_post_init(context: Any, /) → None#

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

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

Parameters:

  • self – The BaseModel instance.

  • context – The context.

data_type#

alias of Data

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

  • SPDX-License-Identifier: Apache-2.0

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

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

  • You may obtain a copy of the License at

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

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

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

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

  • See the License for the specific language governing permissions and

  • limitations under the License.

class omni.flux.validator.plugin.context.usd_stage.base.context_base_usd.ContextBaseUSD#
pydantic model Data#
Config:

  • extra: str = forbid

  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:

  • computed_context (str | None)

  • context_name (str | None)

  • create_context_if_not_exist (bool)

Validators:

  • _fire_global_progress_value_callback » global_progress_value

  • _fire_last_check_result_callback » last_check_result

  • _fire_last_exit_result_callback » last_on_exit_result

  • _fire_last_set_result_callback » last_set_result

  • _fire_progress_callback » progress

  • sanitize_uuid » uuid

field computed_context: str | None = None#
field context_name: str | None = None#
field create_context_if_not_exist: bool = False#
model_post_init(context: Any, /) → None#

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

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

Parameters:

  • self – The BaseModel instance.

  • context – The context.

On this page