Skip to main content

Keep_Out_Constraint

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

Body must not intersect a volume.

Propose a change

Hierarchy​

Parent classes: Spatial_Constraint

Subclasses: none, this is a leaf class.

Facts​

FactValue
URIhttps://mapped.com/schema/mapped/1.0/openusd#Keep_Out_Constraint
SourceMapped
ProtobufKEEP_OUT_CONSTRAINT
DeprecatedNo

Properties​

PropertyTypeRequiredDefaultDescription
clearanceMetersdoubleRequired separation in metres. Keep-out constraints only.

exactType is always Keep_Out_Constraint.

Inherited properties (15)
PropertyTypeRequiredDefaultDescription
connectorIdsArray<string>The ids of the connectors associated with the entity.
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.
dateCreateddateTimeDatetime when it is created.
dateUpdateddateTimeDatetime when it is updated last time.
descriptionstring
diagnosticCodestringStable code emitted when the constraint is violated.
idstringYesA globally unique ID in Mapped services.
namestring
organizationIdstringYesThe id of the organization that owns the entity.
toleranceMetersdoubleNumerical and contact tolerance in metres.
validFromdateTimeStart of validity.
validThroughdateTimeEnd of validity.

Relationships​

No relationships of its own.

Inherited relationships (4)
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.
contributesPropertyMetahasPropertyContributedFrom0..*transitive, canonical
Mapped's internal relationship indicating that a vertex is contributing a property/value to another vertex.

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