@vcmap/core
    Preparing search index...

    Function getHeightInfo

    • Parameters

      Returns
          | {
              groundLevelOrMinHeight: number;
              heightReference: NONE;
              layout: GeometryLayout;
              perPositionHeight: boolean;
          } & ExtrusionHeightInfo
          | { heightReference: CLAMP_TO_GROUND; layout: GeometryLayout }
          | {
              clampOrigin?: [number, number];
              groundLevel?: number;
              heightAboveGround?: number;
              heightReference: RELATIVE_TO_GROUND;
              layout: GeometryLayout;
              perPositionHeight: boolean;
          } & ExtrusionHeightInfo
          | { heightReference: CLAMP_TO_TERRAIN; layout: GeometryLayout }
          | {
              clampOrigin?: [number, number];
              groundLevel?: number;
              heightAboveGround?: number;
              heightReference: RELATIVE_TO_TERRAIN;
              layout: GeometryLayout;
              perPositionHeight: boolean;
          } & ExtrusionHeightInfo
          | { heightReference: CLAMP_TO_3D_TILE; layout: GeometryLayout }
          | {
              clampOrigin?: [number, number];
              groundLevel?: number;
              heightAboveGround?: number;
              heightReference: RELATIVE_TO_3D_TILE;
              layout: GeometryLayout;
              perPositionHeight: boolean;
          } & ExtrusionHeightInfo

      • {
            groundLevelOrMinHeight: number;
            heightReference: NONE;
            layout: GeometryLayout;
            perPositionHeight: boolean;
        } & ExtrusionHeightInfo
        • groundLevelOrMinHeight: number

          the level above or below mean sea level (minZ value or ground_level or 0)

        • heightReference: NONE
        • layout: GeometryLayout
        • perPositionHeight: boolean

          true if not all z values are identical, e.g no ground level was provided and no or only one storey was provided

      • { heightReference: CLAMP_TO_GROUND; layout: GeometryLayout }
      • {
            clampOrigin?: [number, number];
            groundLevel?: number;
            heightAboveGround?: number;
            heightReference: RELATIVE_TO_GROUND;
            layout: GeometryLayout;
            perPositionHeight: boolean;
        } & ExtrusionHeightInfo
        • OptionalclampOrigin?: [number, number]
        • OptionalgroundLevel?: number

          the level above or below mean sea level

        • OptionalheightAboveGround?: number
        • heightReference: RELATIVE_TO_GROUND
        • layout: GeometryLayout
        • perPositionHeight: boolean

          true if not all z values are identical, e.g no height above ground was provided and no or only one storey was provided

      • { heightReference: CLAMP_TO_TERRAIN; layout: GeometryLayout }
      • {
            clampOrigin?: [number, number];
            groundLevel?: number;
            heightAboveGround?: number;
            heightReference: RELATIVE_TO_TERRAIN;
            layout: GeometryLayout;
            perPositionHeight: boolean;
        } & ExtrusionHeightInfo
        • OptionalclampOrigin?: [number, number]
        • OptionalgroundLevel?: number

          the level above or below mean sea level

        • OptionalheightAboveGround?: number
        • heightReference: RELATIVE_TO_TERRAIN
        • layout: GeometryLayout
        • perPositionHeight: boolean

          true if not all z values are identical, e.g no height above ground was provided and no or only one storey was provided

      • { heightReference: CLAMP_TO_3D_TILE; layout: GeometryLayout }
      • {
            clampOrigin?: [number, number];
            groundLevel?: number;
            heightAboveGround?: number;
            heightReference: RELATIVE_TO_3D_TILE;
            layout: GeometryLayout;
            perPositionHeight: boolean;
        } & ExtrusionHeightInfo
        • OptionalclampOrigin?: [number, number]
        • OptionalgroundLevel?: number

          the level above or below mean sea level

        • OptionalheightAboveGround?: number
        • heightReference: RELATIVE_TO_3D_TILE
        • layout: GeometryLayout
        • perPositionHeight: boolean

          true if not all z values are identical, e.g no height above ground was provided and no or only one storey was provided