Keep_Out_Constraint
Mapped https://mapped.com/schema/mapped/1.0/openusd#Keep_Out_Constraint
Body must not intersect a volume.
Hierarchy
Parent classes: Spatial_Constraint
Subclasses: none, this is a leaf class.
Facts
| Fact | Value |
|---|---|
| URI | https://mapped.com/schema/mapped/1.0/openusd#Keep_Out_Constraint |
| Source | Mapped |
| Protobuf | KEEP_OUT_CONSTRAINT |
| Deprecated | No |
Properties
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
clearanceMeters | double | Required separation in metres. Keep-out constraints only. |
exactType is always Keep_Out_Constraint.
Inherited properties (15)
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
connectorIds | Array<string> | The ids of the connectors associated with the entity. | ||
constraintEnabled | boolean | Yes | Explicit opt-in switch. | |
constraintHardness | string | Yes | Strength of the constraint: HARD, SOFT or ADVISORY. | |
constraintMode | string | Yes | What a consumer does when the constraint is not satisfied: VALIDATE_ONLY, PROJECT, TRUNCATE or REJECT. Geometric modes must target a Representation. | |
coordinateFrameId | string | Opaque 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. | ||
dateCreated | dateTime | Datetime when it is created. | ||
dateUpdated | dateTime | Datetime when it is updated last time. | ||
description | string | |||
diagnosticCode | string | Stable code emitted when the constraint is violated. | ||
id | string | Yes | A globally unique ID in Mapped services. | |
name | string | |||
organizationId | string | Yes | The id of the organization that owns the entity. | |
toleranceMeters | double | Numerical and contact tolerance in metres. | ||
validFrom | dateTime | Start of validity. | ||
validThrough | dateTime | End of validity. |
Relationships
No relationships of its own.
Inherited relationships (4)
| Relationship | Targets | Inverse | Cardinality | Notes |
|---|---|---|---|---|
constrains | Thing, Place | hasConstraint | 0..* | The entity that opted into this constraint. |
constrainsAgainst | Meta | isConstraintTarget | 1..1 | transitive, 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. |
constrainsSubject | Meta | isSubjectOfConstraint | 1..1 | transitive, canonical The body the constraint applies to. Exactly one in v1. |
contributesProperty | Meta | hasPropertyContributedFrom | 0..* | 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.