get_usd_prim
Get a USD prim's attributes, relationships, and children at a given frame, with long arrays summarized to keep responses small.
Instructions
Get detailed info about a USD prim.
Array attributes longer than 16 elements (points, faceVertexIndices,
primvars:st, ...) come back as a summary: size, element_type, the first 8
as head, and min/max for numeric data. That is what a mesh question
needs; the full arrays of a building ran to 6.6 million characters. Pass
full=True for every element, or read one array in windows with
get_usd_attribute(offset=, limit=).
Values are read at time, or at the current frame when it is not given
-- what a render of that frame sees; the reply names both as time and
time_source. An attribute with time samples carries time_samples:
its value differs at other frames. Relationships (a RenderSettings'
camera) are listed with their targets. For the same attributes
across many prims, get_usd_attributes reads them in one call.
Args:
node_path: LOP node path.
prim_path: USD prim path.
full: Return array attributes in full instead of summarised.
traverse_instance_proxies: List the children that live on an
instanceable prim's prototype. Without it such a prim answers
children: [] and is flagged is_instanceable with a
hidden_descendants count, so the empty list is not read as
"nothing inside".
time: Time code (frame) to read at; default the current frame.
attr_patterns: Glob patterns on attribute and relationship names
(e.g. ["resolution", "karma:global:*"]); default all.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| full | No | ||
| time | No | ||
| node_path | Yes | ||
| prim_path | Yes | ||
| attr_patterns | No | ||
| traverse_instance_proxies | No |