Skip to main content

OpenUSD_Prim_Binding

Mapped https://mapped.com/schema/mapped/1.0/openusd#OpenUSD_Prim_Binding

A reified binding from a semantic vertex to one prim address in one layer. It exists because relationships carry no property bag and the association needs its own identity, provenance and 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.

Propose a change

Hierarchy​

Parent classes: OpenUSD_Concept

Subclasses: none, this is a leaf class.

Facts​

FactValue
URIhttps://mapped.com/schema/mapped/1.0/openusd#OpenUSD_Prim_Binding
SourceMapped
ProtobufOPEN_USD_PRIM_BINDING
DeprecatedNo

Properties​

PropertyTypeRequiredDefaultDescription
coordinateFrameIdstringOpaque reference into the external coordinate frame registry, matching the Frame_Geometry decision that frames resolve outside the Mapped graph. On a Representation it is optional: absent means the subject entity's own frame.
descriptionstring
isAuthoritativeForPosebooleanYesfalseWhether physical systems may consume this binding for pose. Normally false. At most one authoritative binding per entity and instant; it requires openUSDPurpose default and a coordinateFrameId exactly coincident with the composed prim-local basis.
lodDefaultIndexinteger0Level-of-detail roots only. Index of the item used when no supported heuristic yields a usable result; must name an existing item. Emitted as lod:default:index.
lodIndexintegerLevel-of-detail items only; required when the target of hasLODItem. Authored, zero-based ordering position under the root. Not emitted to USD: the projection authors child order from it. Not the currently selected level.
lodOverrideIndexdoubleRequested index for an indexed override; meaningful only with lodOverrideMode indexedLOD. A number, not an integer: USD permits fractional indices for blending. Emitted as lod:override:index.
lodOverrideModestringOverrides heuristic selection for descendant level-of-detail roots, in USD's spelling: inherited, noOverride, indexedLOD, noLOD or allLOD. Applies UsdLodOverrideAPI to the bound prim; emitted as lod:override:mode.
lodValidThroughIndexintegerCoarsest level-of-detail index at which this binding still resolves, for a prim dropped from collapsed lower-detail assets such as a wheel or an articulated part. Indices increase as detail decreases, so 0 means the binding exists only in the highest-detail item. Absent means the binding is valid wherever its prim path resolves. Assumes validity is contiguous from index 0; a prim absent at one level but present at a coarser one needs a set rather than a ceiling. Distinguished from lodIndex, which identifies an item, and lodDefaultIndex, which selects a fallback.
namestring
openUSDPurposestringUSD purpose token in USD's spelling: default, render, proxy or guide. A render-visibility filter authored on the prim, so it lives on the binding. Render and proxy geometry need no representation class; they are purposes here.
primPathstringYesAbsolute Sdf prim path, e.g. /HallA/Row01/Rack001. Carries USD namespace hierarchy implicitly; the identity of a bound prim is the pair (primPath, resolvesInLayer), never the path alone.
primTypeNamestringComposed prim type the binding requires, e.g. Xform, Mesh, Cube. An expectation checked at resolve time, not an observed fact.
requiredAPISchemasArray<string>API schemas the binding requires on the composed prim, e.g. PhysicsCollisionAPI, LODRootAPI. An expectation, not an observation.
validFromdateTimeStart of validity.
validThroughdateTimeEnd of validity.
variantSelectionsstringVariant selections applied at resolve time, each naming a variantSet and selection on a primPath; primPath omitted means the bound prim. Replaces separate variant-set and variant classes: Mapped selects variants as policy rather than mirroring USD structure.

exactType is always OpenUSD_Prim_Binding.

Inherited properties (5)
PropertyTypeRequiredDefaultDescription
connectorIdsArray<string>The ids of the connectors associated with the entity.
dateCreateddateTimeDatetime when it is created.
dateUpdateddateTimeDatetime when it is updated last time.
idstringYesA globally unique ID in Mapped services.
organizationIdstringYesThe id of the organization that owns the entity.

Relationships​

RelationshipTargetsInverseCardinalityNotes
hasLODHeuristicOpenUSD_LOD_HeuristicisLODHeuristicOf0..*transitive, canonical
Associates a level-of-detail root binding with a heuristic definition; maps to lod:heuristics. Several per root, one per domain.
hasLODItemOpenUSD_Prim_BindingisLODItemOf0..*transitive, canonical
Declares the target binding an immediate level-of-detail item of the source root binding. Authoring information, not emitted as a USD relationship: the projection sorts targets by lodIndex and authors that child order, applying UsdLodRootAPI to the root prim. In v1 an item belongs to exactly one root.
isLODBoundingVolumeOfOpenUSD_LOD_HeuristichasLODBoundingVolume0..*The heuristics governed by this prim's extent.
isLODItemOfOpenUSD_Prim_BindinghasLODItem0..*The level-of-detail root this item belongs to.
isPrimBindingOfOpenUSD_LOD_Heuristic, Entity, Representation, Kinematic_JointhasPrimBinding0..*The entity, representation or heuristic this binding addresses a prim for.
resolvesInLayerOpenUSD_LayerresolvesPrimBinding1..1transitive, canonical
The layer a binding resolves through. Normative: open a stage with this layer as the root layer under the resolver context, load, population and variant policy of its schemaProfile, then evaluate the binding against the composed prim at primPath. Layers are durable; runtime stages are never vertices.
Inherited relationships (1)
RelationshipTargetsInverseCardinalityNotes
contributesPropertyMetahasPropertyContributedFrom0..*transitive, canonical
Mapped's internal relationship indicating that a vertex is contributing a property/value to another vertex.

Referenced by​

Classes whose own relationships point at OpenUSD_Prim_Binding.

Something wrong or missing on this page? Propose a change to OpenUSD_Prim_Binding.