SDK JS
    Preparing search index...

    Interface ClippingPlane

    A single clipping plane, defined geographically.

    The plane passes through ClippingPlane.position with unit normal ClippingPlane.normal in the local East-North-Up frame at that position. Geometry on the side the normal points INTO is KEPT; the other half-space is clipped away.

    // Keep everything NORTH of a line through the given point. `normal` is the
    // local ENU direction of the half-space you keep.
    const northOf: ClippingPlane = {
      position: { lng: -157.82, lat: 21.29 },
      normal: [0, 1, 0],
    };

    // For an axis-aligned cut, planeFromHeadingTilt builds the same thing from a
    // compass heading, which is easier to reason about than a normal vector.
    const southEdge = planeFromHeadingTilt({ lng: -157.82, lat: 21.28 }, 180);
    interface ClippingPlane {
        normal: readonly [number, number, number];
        position: { height?: number; lat: number; lng: number };
    }
    Index

    Properties

    normal position

    Properties

    normal: readonly [number, number, number]

    Unit normal [east, north, up] (local ENU at position, metres) of the KEPT half-space. Need not be exactly unit length — it is normalized internally.

    position: { height?: number; lat: number; lng: number }

    A point the plane passes through. height is metres above the map's rendered ground datum (the height you see geometry drawn at); default 0.

    Settings

    Member Visibility

    On This Page

    Properties