Find All the Prims of a Given Attribute#

To find all Prims with a certain Attribute, you can Traverse the stage and use Usd.Object.IsValid() combined with Usd.Prim.GetAttribute() to check if the Attribute you are looking for exists for each prim in the stage.

USD Python

Traverse a stage to find prims with a given attribute.

from typing import List
from pxr import Usd

def find_prims_by_attribute(stage: Usd.Stage, attr_name: str) -> List[Usd.Prim]:
    found_prims = [x for x in stage.Traverse() if x.GetAttribute(attr_name).IsValid()]
    return found_prims


##############
# Full Usage
##############

from pxr import UsdGeom, Sdf

# Create an in-memory Stage with /World Xform prim as the default prim
stage: Usd.Stage = Usd.Stage.CreateInMemory()
default_prim = UsdGeom.Xform.Define(stage, Sdf.Path("/World"))
stage.SetDefaultPrim(default_prim.GetPrim())

# Create some shape prims
xform = UsdGeom.Xform.Define(stage, "/World/Xform")
cone = UsdGeom.Cone.Define(stage, "/World/Cone") # Has a radius attribute
cube = UsdGeom.Cube.Define(stage, "/World/Cube")
sphere = UsdGeom.Sphere.Define(stage, "/World/Sphere") # Has a radius attribute

# Find all the prims in the stage with the attribute "radius"
prims: List[Usd.Prim] = find_prims_by_attribute(stage, "radius")

# Print the prims to check that only the prims with radius attribute are printed
print(prims)

# Check the number of prims found and whether the found data is correct
assert len(prims) == 2
assert isinstance(prims[0], Usd.Prim)
assert prims[0].GetAttribute("radius").IsValid()
assert prims[0].GetTypeName() == "Cone"

Warning

This will be slow for stages with many prims, as stage traversal is currently single-threaded. Learn more about scene complexity.

Traverse a parent-child hierarchy to find prims with a given attribute.

from typing import List
from pxr import Usd

def find_prims_by_attribute(parent_prim: Usd.Prim, attr_name: str) -> List[Usd.Prim]:
    found_prims = [x for x in parent_prim.GetAllChildren() if x.GetAttribute(attr_name).IsValid()]
    return found_prims


##############
# Full Usage
##############

from pxr import UsdGeom, Sdf

# Create an in-memory Stage with /World Xform prim as the default prim
stage: Usd.Stage = Usd.Stage.CreateInMemory()
default_prim = UsdGeom.Xform.Define(stage, Sdf.Path("/World"))
stage.SetDefaultPrim(default_prim.GetPrim())

# Create some shape prims
xform_parent = stage.DefinePrim('/xform', 'Xform')
cone_child = stage.DefinePrim('/xform/cone', 'Cone') # Has a radius attribute
cube_child = stage.DefinePrim('/xform/cube', 'Cube')
sphere_child = stage.DefinePrim('/xform/sphere', 'Sphere') # Has a radius attribute

# Find all the prims under the given parent prim with the attribute "radius"
prims: List[Usd.Prim] = find_prims_by_attribute(xform_parent, "radius")

# Print the prims to check that only the prims with radius attribute are printed
print(prims)

# Check the number of prims found and whether the found data is correct
assert len(prims) == 2
assert isinstance(prims[0], Usd.Prim)
assert prims[0].GetAttribute("radius").IsValid()
assert prims[0].GetTypeName() == "Cone"