Class GisApi

java.lang.Object

nl.bimbase.bimworks.client.apis.SubApi

nl.bimbase.bimworks.client.apis.GisApi

public class GisApi
extends SubApi

GIS related API calls

Constructor Summary

Constructors

Constructor	Description
GisApi(BimWorksClient bimWorksClient)

Method Summary

Modifier and Type	Method	Description
InputStream	downloadCityGml(Set<UUID> versionUuids, nl.bimbase.bimworks.CityGmlFileType cityGmlType, nl.bimbase.bimworks.CityGmlExportSettings exportSettings)	Download a CityGML or CityJSON representation of a set of Versions
nl.bimbase.bimworks.common.api.geometry.GeoReference	extractGeoReference(UUID versionUuid, String epsgCode)	Extract a GeoReference from the IFC model based on the given EPSG code.
String	generate3DTilesUrl(UUID nodeUuid)	Generate a 3D Tiles URL.
nl.bimbase.bimworks.common.api.geometry.GeoReference	getGeoReference(UUID versionUuid)	Get the stored GeoReference of a Version
com.fasterxml.jackson.databind.node.ArrayNode	listModelsForGis()	Deprecated.
void	setGeoReference(UUID versionUuid, nl.bimbase.bimworks.common.api.geometry.GeoReference geoReference)	Store a new GeoReference.

Methods inherited from class nl.bimbase.bimworks.client.apis.SubApi

getBimWorksClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GisApi

public GisApi(BimWorksClient bimWorksClient)

Method Details

getGeoReference

public nl.bimbase.bimworks.common.api.geometry.GeoReference getGeoReference(UUID versionUuid)
                                                                     throws BimWorksException

Get the stored GeoReference of a Version

Parameters:

versionUuid - The UUID of the Version

Returns:

A GeoReference. GeoReferences in BIM.works are always stored in EPSG:4326 (also known as WGS84), so you'll always get back a GeoReference in that CRS.

Throws:

BimWorksException

setGeoReference

public void setGeoReference(UUID versionUuid,
 nl.bimbase.bimworks.common.api.geometry.GeoReference geoReference)
                     throws BimWorksException

Store a new GeoReference. This is stored in BIM.works as meta-data and does not modify the IFC model in any way.

Parameters:

versionUuid - The UUID of the Version

geoReference - The new GeoReference

Throws:

BimWorksException

extractGeoReference

public nl.bimbase.bimworks.common.api.geometry.GeoReference extractGeoReference(UUID versionUuid,
 String epsgCode)
                                                                         throws BimWorksException

Extract a GeoReference from the IFC model based on the given EPSG code. This API call does not modify anything in the BIM.works repository. Generally when the results of this calls are satisfying to the caller, the results are passed on to the setGeoReference(UUID, GeoReference) call, but that is not required

Parameters:

versionUuid - The UUID of the Version

epsgCode - The epsgCode, must be in the following format: "EPSG:1234"

Returns:

The GeoReference is one could successfully be extracted

Throws:

BimWorksException

downloadCityGml

public InputStream downloadCityGml(Set<UUID> versionUuids,
 nl.bimbase.bimworks.CityGmlFileType cityGmlType,
 nl.bimbase.bimworks.CityGmlExportSettings exportSettings)
                            throws BimWorksException

Download a CityGML or CityJSON representation of a set of Versions

Parameters:

versionUuids - The UUIDS of the versions

cityGmlType - The type. Currently only CITY_GML_2_0 and CITY_JSON_1_0_0 are implemented

exportSettings - Additional settings

Returns:

An InputStream, responsibility for closing the stream is on the caller

Throws:

BimWorksException

generate3DTilesUrl

public String generate3DTilesUrl(UUID nodeUuid)
                          throws BimWorksException

Generate a 3D Tiles URL. Warning The returned URL does not have any for of authentication, so be careful sharing this URL as it gives unlimited and irrevocable access to the models below the given Node

Parameters:

nodeUuid -

Returns:

Throws:

BimWorksException

listModelsForGis

public com.fasterxml.jackson.databind.node.ArrayNode listModelsForGis()
                                                               throws BimWorksException

Deprecated.

Returns:

Throws:

BimWorksException