GetPlaceholderPropertiesForPrim

omni.kit.property.material.scripts.widgets.usdshade.placeholder.GetPlaceholderPropertiesForPrim(prim: Prim, args: dict) List[UsdShadePropertyPlaceholder]

Retrieves a list of UsdShadePropertyPlaceholder objects for a given USD prim.

This function builds placeholders used for driving the UI by examining the type of USD prim provided. Depending on whether the prim is a Shader, Material, or NodeGraph, it delegates to the corresponding builder class to construct the placeholders.

Parameters
  • prim (Usd.Prim) – The USD primitive for which to retrieve property placeholders.

  • args (dict) – A dictionary of arguments that are passed to the builder classes.

Returns

A list of UsdShadePropertyPlaceholder objects that represent the properties of the given prim within the UI.

Return type

List[UsdShadePropertyPlaceholder]

Raises

A warning is logged if the provided prim is not of type Shader, Material, or NodeGraph.