eludi.github.io

find_related_entities

Find objects — optionally filtered by layer or geometric type — that have a specific spatial relationship to a reference. The reference is an existing object id, a bare {x,y} point, or an explicit on-the-fly geometry using the same {closed, contours} shape get_object_geometry returns. relation uses the standard OGC/DE-9IM spatial-predicate terms (as in PostGIS/Shapely) and is one or more of: "contains" (reference fully encloses the match), "within" (reference lies fully inside the match), "overlapping" (the two share genuine area — covers both OGC "Overlaps" and "Crosses", since which one applies depends on incidental drawing choices like whether a door is a closed rectangle or an open line), "touches" (touch, or nearly touch within adjacentTolerance, without truly overlapping — e.g. two rooms sharing a wall, or a door opening spanning a wall), "close" (within closeDistance but not touching — conceptually like PostGIS ST_DWithin, not a named DE-9IM predicate), "disjoint" (none of the above). Never returns the reference object itself. adjacentTolerance may be omitted — it then defaults to a small multiple of the document's own modeling tolerance, tight enough to only catch geometry that was actually snapped together. closeDistance is more open-ended: since the document's world-coordinate unit has no fixed real-world correspondence (see get_document_info), it should usually be supplied explicitly, scaled to match this document's own units — inspect a few object sizes via get_object_info first to judge that scale — though it falls back to a multiple of the document's primary grid spacing when available. Each match includes layer and area (for a closed match) alongside id/type/label, so a follow-up get_object_info call is often unnecessary. A "touches" match additionally includes contact: { type: "point"|"edge", length?, points }, describing the actual contact geometry — this matters because a single shared corner point (type "point") is a much weaker signal than a rea…

Page: /precidra-viewer/

Input schema

{
  "type": "object",
  "properties": {
    "entity": {
      "type": "object",
      "description": "EntityRef: { id } or { x, y } or { closed, contours }"
    },
    "relation": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "disjoint",
          "close",
          "touches",
          "overlapping",
          "contains",
          "within"
        ]
      },
      "minItems": 1,
      "description": "One or more of: disjoint, close, touches, overlapping, contains, within"
    },
    "layer": {
      "type": "string",
      "description": "Restrict matches to this layer"
    },
    "type": {
      "type": "string",
      "description": "Restrict matches to this geometric type (see get_object_info)"
    },
    "closeDistance": {
      "type": "number",
      "description": "Required if relation includes \"close\" and no grid is available to default from"
    },
    "adjacentTolerance": {
      "type": "number",
      "description": "Optional if relation includes \"touches\" — defaults to a small multiple of the modeling tolerance"
    }
  },
  "required": [
    "entity",
    "relation"
  ],
  "additionalProperties": false
}