BIM.works SDKs - v3.0.0-b.115
    Preparing search index...

    API Namespace Gis is used for GIS related API calls.

    Index

    Constructors

    Methods

    • Download one or multiple models serialized to CityGML

      Parameters

      Returns Promise<string>

    • Parameters

      • versionUuids: string[]

        A list of Version UUID

      • fileType: string

        Can be either CITY_GML_3_0 or CITY_JSON_2_0_0

      • settings: CityGML3ExportSettings

        The settings for this export

      Returns Promise<string>

    • Extract the GeoReference from the given Version by using the IfcMapConversion object, this is only available in IFC4 and later. This is the recommended way to extract geo references. Note, this to persist this extracted EPSG code on the model, subsequently use setGeoReference

      Parameters

      • versionUuid: string

      Returns Promise<GeoReferenceExtractionResult>

    • Extract the GeoReference from the given Version by using the IfcMapConversion information from a Pset, this is a fallback method in Ifc2x3 and not recommended to use. Note, this to persist this extracted EPSG code on the model, subsequently use setGeoReference

      Parameters

      • versionUuid: string

      Returns Promise<GeoReferenceExtractionResult>

    • Extract the GeoReference from the given Version by using a specific EPSG code. This method assumes that the LocalPlacement of IfcSite was used to write the x/y coordinates of the given EPSG system This method is not the recommended to extract geo refererences from models because it requires external data (the EPSG code) to extract the information and because it makes working with models in local coordinates confusing because of the large numbers
      Note, this to persist this extracted EPSG code on the model, subsequently use setGeoReference

      Parameters

      • versionUuid: string
      • epsgCode: string

      Returns Promise<GeoReferenceExtractionResult>

    • Extract the GeoReference from the given Version by using the latitude/longitude stored as attributes on the IfcSite object. This is not the recommended way to extract geo references from models because it's generally not accurately exported. Note, this to persist this extracted EPSG code on the model, subsequently use setGeoReference

      Parameters

      • versionUuid: string

      Returns Promise<GeoReferenceExtractionResult>

    • Extract the GeoReference from the given Version by using a specific WKT string. This can be useful for CRS definitions that do not exist in the EPSG database. This method assumes that the LocalPlacement of IfcSite was used to write the x/y coordinates of the given EPSG system This method is not the recommended to extract geo refererences from models because it requires external data (the EPSG code) to extract the information and because it makes working with models in local coordinates confusing because of the large numbers
      Note, this to persist this extracted EPSG code on the model, subsequently use setGeoReference

      Parameters

      • versionUuid: string
      • wkt: string

      Returns Promise<GeoReferenceExtractionResult>

    • Generate a 3D Tiles URL for all models in a specific Node or for a set of Version UUIDs. Also the content available on this URL is dynamic, when models are added/removed to/from this node, it will be reflected in the tile stream

      A URL is valid for 90 days and cannot be revoked.

      Parameters

      • settings: TilesSettings

        A settings object that specifies which models to load and other settings

      Returns Promise<string>

      A URL that serves the 3D Tileset

    • Get the GeoReference that is currently stored on the given Version. placedPoints adds where the model's origin and the centre of its bounds land on the earth (GeoReferenceResult.zero_point, GeoReferenceResult.bounds_centre).

      Parameters

      • versionUuid: string
      • OptionaltargetEpsg: string | null
      • Optionaloptions: { placedPoints?: boolean }

      Returns Promise<GeoReferenceResult | null>

    • The georeference the Version carries in its IFC data, raw: the IfcMapConversion of its 3D model context with its IfcProjectedCRS (map_conversion, null when there is none), whether it can be edited with the BUL statement GEOREFERENCE (supported, reason), and the WGS 84 value an upload of the file stores (map_conversion.geo_reference). Lengths are in the map unit (crs.map_unit_metres, null = project unit).

      Parameters

      • versionUuid: string

      Returns Promise<MapConversionResult>

    • Set/update the GeoReference of the given Version. rotationNorth says which north geoReference.rotation is from: "GRID", against the grid of originalEpsg (an IfcMapConversion's rotation), or "TRUE". Omitted, the server stores none, and the rotation counts as grid-relative when the version has an original EPSG, else as true north.

      Parameters

      • versionUuid: string
      • geoReference: GeoReference
      • anchorPoint: Vector3d
      • OptionaloriginalEpsg: string
      • OptionalrotationNorth: "GRID" | "TRUE"

      Returns Promise<unknown>