Skip to main content

OpenUSDPrimBinding

Object

A reified binding from a semantic vertex to one prim address in one layer. It has its own identity because a relationship carries no property bag and the association needs provenance and a validity window. Its properties describe the association - where it points, what it expects to find, whether it may drive pose - never intrinsic prim facts. A binding with hasLODItem edges is a level-of-detail root; an item binding is owned through its root.

type OpenUSDPrimBinding implements GraphNode {
  connectedDataSourceId: String
  coordinateFrame: CoordinateFrame
  coordinateFrameId: String
  dateCreated: DateTime
  dateUpdated: DateTime
  description: String
  exactType: String
  hasLODHeuristic(filter: OpenUSDLODHeuristicFilter): [OpenUSDLODHeuristic]
  hasLODItem(filter: OpenUSDPrimBindingFilter): [OpenUSDPrimBinding]
  id: String!
  isAuthoritativeForPose: Boolean
  isLODBoundingVolumeOf(filter: OpenUSDLODHeuristicFilter): [OpenUSDLODHeuristic]
  isLODItemOf(filter: OpenUSDPrimBindingFilter): [OpenUSDPrimBinding]
  isPrimBindingOf(filter: EntityFilter): [IsPrimBindingOfUnion]
  lodDefaultIndex: Int
  lodIndex: Int
  lodOverrideIndex: Int
  lodOverrideMode: String
  lodValidThroughIndex: Int
  mappingKey: String
  name: String
  primPath: String
  primTypeName: String
  purpose: String
  requiredAPISchemas: [String]
  resolvesInLayer(filter: OpenUSDLayerFilter, transitive: Boolean = false): OpenUSDLayer
  resolvesInLayerEdges: [ResolvesInLayerEdge]
  type: [String]
  validFrom: DateTime
  validThrough: DateTime
  variantSelections: GraphQLJSON
}

Implements​

Fields​

FieldTypeDescription
connectedDataSourceIdString
coordinateFrameCoordinateFrameThe coordinate-frame registry entry coordinateFrameId names. Null when the binding names no frame, and null - not an error - when it names one the registry does not hold: a stale frame id is data, and it must not fail a list of a thousand bindings.
coordinateFrameIdStringAn id in the coordinate-frame registry. Opaque to the graph - see coordinateFrame for the frame itself.
dateCreatedDateTime
dateUpdatedDateTime
descriptionString
exactTypeString
hasLODHeuristic[OpenUSDLODHeuristic]The level-of-detail selection policies of this root binding. Several per root, one per consumer domain, so thresholds cannot be flattened onto the binding.
Arguments: filter: OpenUSDLODHeuristicFilter
hasLODItem[OpenUSDPrimBinding]The immediate level-of-detail items of this root binding, in no guaranteed order - sort by lodIndex.
Arguments: filter: OpenUSDPrimBindingFilter
idString!
isAuthoritativeForPoseBooleanWhether this binding is the one allowed to drive the entity's pose. At most one binding per entity should claim it.
isLODBoundingVolumeOf[OpenUSDLODHeuristic]The heuristics whose extent this binding's prim governs.
Arguments: filter: OpenUSDLODHeuristicFilter
isLODItemOf[OpenUSDPrimBinding]The roots that use this binding as a level-of-detail item. Item bindings are shared - a thousand roots may name the same three items.
Arguments: filter: OpenUSDPrimBindingFilter
isPrimBindingOf[IsPrimBindingOfUnion]What this binding represents - a Thing, a Place, a Point, a Person - or a joint, whose binding names the authored physics-joint prim.
Arguments: filter: EntityFilter
lodDefaultIndexIntLevel-of-detail roots only - the item index to show when no heuristic applies.
lodIndexIntLevel-of-detail items only - the item's position in its root's list, 0 being the most detailed.
lodOverrideIndexIntThe item index to force when lodOverrideMode selects one.
lodOverrideModeStringIn USD's spelling - inherited, noOverride, indexedLOD, noLOD or allLOD.
lodValidThroughIndexIntThe last level-of-detail index at which this binding's prim exists. Absent means every level. A joint's or a wheel's prim is typically authored at level 0 only.
mappingKeyString
nameString
primPathStringAbsolute SdfPath of the bound prim in the composed layer.
primTypeNameStringWhat the binding expects to find at primPath, e.g. Xform.
purposeStringUSD purpose token in USD's spelling - default, render, proxy or guide.
requiredAPISchemas[String]The API schemas the prim at primPath is expected to have applied.
resolvesInLayerOpenUSDLayerThe layer this binding resolves through. Open a stage with it as the root layer under the resolver context and schema profile it names, then evaluate the binding against the composed prim at primPath.
Arguments: filter: OpenUSDLayerFilter, transitive: Boolean = false
resolvesInLayerEdges[ResolvesInLayerEdge]
type[String]
validFromDateTimeStart of the binding's validity window.
validThroughDateTimeEnd of the binding's validity window.
variantSelectionsGraphQLJSONThe variant selections to apply when composing, as a JSON object of variant set to selection.

Used by​