Class HSPCTilesModel

An 3D tileset model connects to an HSPC dataset to retrieve tiles for a TileSet3DLayer. Its constructor should not be called directly. Instead, use the static create method:

  const url = "http://datamonster.myvr.net/mMap/data/pointcloud/APR/SanFrancisco/tree.hspc";
  // Create a model for the HSPC dataset
  HSPCTilesModel.create(url).then(function(model) {
    //Create a layer for the model
    const layer = new TileSet3DLayer(model);
    //Add the layer to the map
    map.layerTree.addChild(layer);
  });

Supported versions

HSPC version 22 or older is supported. HSPC Pack files are also supported

Limitations

  • Datasets with all supported EPSG references are supported. See the projection-epsg property in your hspcInfo.json file.
  • We do recommend to process your HSPC data in EPSG:4978 (3D geocentric coordinates) for optimal performance.
  • If the dataset has no georeference, it might still be loaded as geocentric based on a heuristic, as often the georeference information is missing.
  • If the dataset has no georeference and the data looks non-referenced, you must use a transformation on your TileSet3DLayer to position the data in the world.

Hierarchy

  • HSPCTilesModel

Implements

Constructors

constructor

Accessors

bounds coordinateType credentials modelDescriptor orientedBox reference requestHeaders requestParameters url urlParams

Methods

create

Constructors

Private constructor

Accessors

bounds

  • get bounds(): Bounds

  • Bounds of the model, in the model reference. If the model has no reference, it will default to a cartesian 3D reference.

    Returns Bounds

coordinateType

credentials

  • get credentials(): boolean

  • Indicates whether credentials should be included with HTTP requests.

    Set this to true if the server requires credentials, like HTTP basic authentication headers or cookies. You should disable credentials if the server is configured to allow cross-origin requests from all domains (Acces-Control-Allow-Origin=*). If the server allows CORS requests from all domains, the browser will block all requests where credentials=true.

    Once set, all subsequent HTTP requests will use the newly set value.

    The default value is false.

    Returns boolean

  • set credentials(value): void

  • Parameters

    • value: boolean

    Returns void

modelDescriptor

orientedBox

  • get orientedBox(): OrientedBox

  • The orientedBox is a read-only attribute that contains a tight-fitting 3D box around the dataset. The OrientedBox is defined in the same reference as this model.

    Returns OrientedBox

    Since

    2020.0

reference

requestHeaders

  • get requestHeaders(): null | HttpRequestHeaders

  • Headers to send with every HTTP request.

    An object literal that represents the headers to send with every HTTP request. The property names represent HTTP header names, the property values represent the HTTP header values. This property can be set dynamically (post-construction). Once set, all subsequent HTTP requests will use the newly set headers.

    Note that when custom headers are being sent to a server on another domain, the server will have to properly respond to pre-flight CORS requests (a HTTP OPTION request sent by the browser before doing the actual request). The server has to indicate that the header can be used in the actual request, by including it in the pre-flight's Access-Control-Allow-Headers response header.

    The default value is null.

    Returns null | HttpRequestHeaders

  • set requestHeaders(value): void

  • Parameters

    Returns void

requestParameters

  • get requestParameters(): null | HttpRequestParameters

  • Custom request parameters to send along with 3DTiles requests. The object literal can contain simple key/value pairs. Accepted values are strings, numbers and booleans. A ProgrammingError will be thrown if values of another type are used. Values must not be URL encoded.

    Assignments of other values than object literals to requestParameters will throw an Error. Clearing the parameters can be done by assigning null or an empty object literal to requestParameters.

    Returns null | HttpRequestParameters

    Since

    2021.0

  • set requestParameters(value): void

  • Parameters

    Returns void

url

  • get url(): string

  • The URL of this HSPC Tiles tileset model. It is the URL where the "tree.hspc" resides.

    For example, "http://datamonster.myvr.net/mMap/data/pointcloud/APR/SanFrancisco/tree.hspc".

    Returns string

urlParams

  • get urlParams(): string

  • The parameter string of model's URL.

    Returns string

Methods

Static create

Settings

Member Visibility

Theme