USD Import: prim_path_mask does not use or behave like USDStage.OpenMasked #102594

New Issue

System Information
Operating system: any
Graphics card: any

Blender Version
Broken: 3.4.0 Alpha)

Apologies if this should not be logged as a bug, but it feels like one.
Opening stages with a population mask is a powerful feature to handle large stages with USD. It's great that blenders' import USD method supports a prim_path_mask, but unfortunately this seems to be limited to a single prim (path). The UsdStage.OpenMasked on the other hand supports a list paths via USD's population mask class.
Additionally, the prim_path_mask causes the prim to be imported at the root of the hierarchy, whilst UsdStage.OpenMasked preserves the SdfPath.

It would be great if this could be implemented by setting the population mask on the stage before it is opened rather than fixing the existing GetPrimAtPath based method here:
https://github.com/blender/blender/blob/master/source/blender/io/usd/intern/usd_reader_stage.cc#L283

Exact steps for others to reproduce the error
Download the Animal Logic Alab

This "works"

bpy.ops.wm.usd_import(filepath="C:\Users\jjebens\Downloads\alab-v2.0.0\ALab\entity\electronics_portable_tv01\electronics_portable_tv01.usda", prim_path_mask="/root/GEO/handle01_M_geo")

This should work, but doesn't

bpy.ops.wm.usd_import(filepath="C:\Users\jjebens\Downloads\alab-v2.0.0\ALab\entity\electronics_portable_tv01\electronics_portable_tv01.usda", prim_path_mask=["/root/GEO/handle01_M_geo", "/root/GEO/dial01_M_geo"])

**System Information** Operating system: any Graphics card: any **Blender Version** Broken: 3.4.0 Alpha) Apologies if this should not be logged as a bug, but it *feels* like one. Opening stages with a population mask is a powerful feature to handle large stages with USD. It's great that blenders' import USD method supports a prim_path_mask, but unfortunately this seems to be limited to a single prim (path). The UsdStage.OpenMasked on the other hand supports a list paths via USD's population mask class. Additionally, the prim_path_mask causes the prim to be imported at the root of the hierarchy, whilst UsdStage.OpenMasked preserves the SdfPath. It would be great if this could be implemented by setting the population mask on the stage before it is opened rather than fixing the existing GetPrimAtPath based method here: https://github.com/blender/blender/blob/master/source/blender/io/usd/intern/usd_reader_stage.cc#L283 **Exact steps for others to reproduce the error** Download the Animal Logic Alab ### This "works" bpy.ops.wm.usd_import(filepath="C:\\Users\\jjebens\\Downloads\\alab-v2.0.0\\ALab\\entity\\electronics_portable_tv01\\electronics_portable_tv01.usda", prim_path_mask="/root/GEO/handle01_M_geo") ### This should work, but doesn't bpy.ops.wm.usd_import(filepath="C:\\Users\\jjebens\\Downloads\\alab-v2.0.0\\ALab\\entity\\electronics_portable_tv01\\electronics_portable_tv01.usda", prim_path_mask=["/root/GEO/handle01_M_geo", "/root/GEO/dial01_M_geo"])

Added subscriber: @jjebens

Added subscriber: @OmarEmaraDev

Changed status from 'Needs Triage' to: 'Needs Developer To Reproduce'

It is possible that not having more than one path is a limitation of the API, as Blender doesn't support string array as far as I know.
Though I am not knowledgeable enough about USD to triage the other concern about preserving the SdfPath, so I will tag the module fore more information.

It is possible that not having more than one path is a limitation of the API, as Blender doesn't support string array as far as I know. Though I am not knowledgeable enough about USD to triage the other concern about preserving the SdfPath, so I will tag the module fore more information.

This is actually already implemented for Blender's universal-scene-description branch. I am working on creating a pull request to merge this feature into main. This is one of the relevant commits that I am porting to main:

90f1d1f4b6

This is actually already implemented for Blender's `universal-scene-description` branch. I am working on creating a pull request to merge this feature into `main`. This is one of the relevant commits that I am porting to `main`: https://projects.blender.org/blender/blender/commit/90f1d1f4b665fff57da774ced961fadd5424e0db

As for supporting multiple file paths, this will be accomplished by allowing the prim_path_mask option to contain multiple entries delimited by spaces, commas or semicolons.

As for supporting multiple file paths, this will be accomplished by allowing the `prim_path_mask` option to contain multiple entries delimited by spaces, commas or semicolons.

I created a pull request for this feature here:

#106974

I created a pull request for this feature here: https://projects.blender.org/blender/blender/pulls/106974

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

USD Import: prim_path_mask does not use or behave like USDStage.OpenMasked #102594

This "works"

This should work, but doesn't