Skip to main content

Spatial_Constraint

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

Abstract. An explicit, parameterised spatial rule. Constraint behaviour applies only where such a vertex exists: without hasConstraint, stateless fusion does not clamp a body to a floor. Takes exactly one subject and one target in v1.

Propose a change

Hierarchy​

Parent classes: OpenUSD_Concept

Subclasses (3):

Facts​

FactValue
URIhttps://mapped.com/schema/mapped/1.0/openusd#Spatial_Constraint
SourceMapped
ProtobufSPATIAL_CONSTRAINT
DeprecatedNo

Properties​

PropertyTypeRequiredDefaultDescription
constraintEnabledbooleanYesExplicit opt-in switch.
constraintHardnessstringYesStrength of the constraint: HARD, SOFT or ADVISORY.
constraintModestringYesWhat a consumer does when the constraint is not satisfied: VALIDATE_ONLY, PROJECT, TRUNCATE or REJECT. Geometric modes must target a Representation.
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
diagnosticCodestringStable code emitted when the constraint is violated.
namestring
toleranceMetersdoubleNumerical and contact tolerance in metres.
validFromdateTimeStart of validity.
validThroughdateTimeEnd of validity.

exactType is Spatial_Constraint or the name of one of its subclasses (4 values).

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
constrainsThing, PlacehasConstraint0..*The entity that opted into this constraint.
constrainsAgainstMetaisConstraintTarget1..1transitive, canonical
The surface, volume or geometry the constraint is evaluated against. Exactly one in v1; must be a Representation when constraintMode is PROJECT, TRUNCATE or REJECT.
constrainsSubjectMetaisSubjectOfConstraint1..1transitive, canonical
The body the constraint applies to. Exactly one in v1.
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 Spatial_Constraint.

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