Class TileSet3DLayer

Creates a TileSet3DLayer that can visualize 3D tiles in a LuciadRIA Map. Supported models include:

• OGC3DTilesModel
• HSPCTilesModel

The bounds of the layer. Those bounds are derived from those of the model, after applying the transformation provided through transformation, if any. If no transformation is given, then the bounds are the same as the ones from the model. In the case of 3D Tiles, it is recommended to use these bounds rather than the model bounds, so that the final reference and position can be captured.

In the case where this mesh is set as a drape Target, this parameter sets the upper bound angle of slopes that will receive draping content. By default, slopes between 0° (flat surfaces) and 90° (vertical walls) will receive draping content. If set, slopes between 0° and the drapeSLopeAngle will be draped. Must be between 0° and 90°.

Default

90°.
Copy

Since

2022.1

The time tiles will take to fade in / out when changing their visibility, in milliseconds. If set to 0, tiles will be popping as they are loaded on screen (fading disabled). The longer it is, the longer tiles will be going from fully transparent to fully visible.

Since

2020.0

The ID property of the layer. This is the data property that is used to identify objects within the layer.

A property that indicates if draping content that is set to be draped on meshes should be draped on the mesh in this layer.

Default

false.
Copy

Since

2022.1

A property that hints the map whether not to treat this mesh as part of the terrain. It is recommended to set this to true for all reality meshes (meshes that contain captures of the real world), and set to false for any other tileset 3D layers, such as CAD models, BIM models or any other data type that does not contain terrain as part of it. Default value is true.

Since

2020.0

Indicates the current status of tile loading.

Since

2023.0

The TileLoadingStrategy used by this layer.

Default is HSPC.

The styling object used for this layer with Mesh data.

The model of this layer.

The occlusion style can be used to visualize 3D objects when they are obscured by other objects, for example to highlight a building. When set the occluded part of the object will always be visible with the outline and/or color configured on the OcclusionStyle.

More information can be found in the howto article Highlighting mesh and point cloud data.

Note: This styling is only applied when the 3D object is obscured by objects from the same layer or from layers that are beneath the layer containing the mesh. Objects from layers higher up in the layer tree are not taken into account. Additionally, the occlusion style is not applied to parts of the mesh that are obscured by the mesh itself (for example buildings in a reality mesh).

Default

null the 3D object will not be visible when occluded by another layer.
Copy

Since

2020.1

The orientedBox is a tight-fitting 3D box around the dataset. The reference of this box is either the reference of the model, or the output reference of transformation, if a transformation has been set on this layer.

Since

2020.0

When set an outline with the specified parameters will be drawn on the edges of the 3D object. Note that when a point cloud is not dense, an outline can be visible around individual points.

More information can be found in the howto article Highlighting mesh and point cloud data.

Default

null no outline is drawn around the 3D object.
Copy

Since

2020.1

Settings that affect the layer's performance.

Since

2023.0

The styling object used for this layer with PointCloud data.

The quality factor active for the layer. The quality factor along with the geometry error is used to decide if a given tile should be displayed at certain scales. It's a non-zero, positive value. The default value is 1.0.

The distance quality factor information. With this it is possible to alter the quality factor in the distance. For instance, specifying options like :

Will make the layer :

• Use its quality factor closer to 50m
• Interpolate between its quality factor and the far quality between 50 and 900m
• Use a quality factor of qualityFactor * 0.2 farther than 900m away

Since

2020.1

Determines whether the layer is selectable. This means that, if possible, individual 3D models from the data can be selected. This will only be possible if the TileSet3DLayerConstructorOptions.idProperty option is set.

Similar to TileSet3DLayer.occlusionStyle but the occlusion effect will only apply to objects that are currently selected on the map.

More information can be found in the howto article Using occlusion and outline styles for selected features.

Note: This styling is only applied when the selected 3D object is obscured by objects from the same layer or from layers that are beneath the layer containing the mesh. Objects from layers higher up in the layer tree are not taken into account. Additionally, the occlusion style is not applied to parts of the mesh that are obscured by the mesh itself (for example buildings in a reality mesh).

Default

null the selected 3D object(s) will not be visible when occluded by other objects.
Copy

Since

2023.1

Similar to TileSet3DLayer.outlineStyle but the outline effect will only apply to object(s) that are currently selected on the map.

More information can be found in the howto article Using occlusion and outline styles for selected features.

Default

null no outline is drawn around the selected 3D object(s).
Copy

Since

2023.1

Denotes what PaintRepresentations are available for this layer. This usually depends on the type of layer or the painter configuration on the layer

The transformation applied to this Tileset3DLayer. Can be changed to reposition, rotate and scale the entire dataset. This transformation can be used to change the reference of the model. For cases where the model is not-referenced, you will have to set a transformation before you can add this layer to a map.

Note that this will also impact the layer's bounds.

This layer will emit a TransformationChanged event when this transformation property has been changed.

Indicates whether transparent surfaces should be painted transparent.

Enable this if you know your data has transparency, and you want to see it. The transparency can originate from transparent pixels in an rgba texture, transparent colors in a vertex attribute, or transparent colors from a MeshStyle.colorExpression.

Note that this can have a significant performance impact, and as such it is disabled by default. When disabled, transparent surfaces will just be opaque.

Default

<code>false</code>
Copy

Since

2020.1

Erases the cached values of all external properties for the given IDs. Consider calling this method when features with these IDs go out of view. It is especially useful for dynamically changing values. Note that without calling an update, this will result in the default value being used for all properties when these IDs come back in view. You can only erase values for properties that were defined at construction time.

See

• TileSet3DLayerConstructorOptions.properties You can use the "FeaturesInViewChange" event to erase properties for features that left the view only.
• TileSet3DLayer.on

For more information about erasing plugged-in properties: Howto: plugging in properties from external data-sources

Since

2021.0

Indicates whether the specified paint representation is supported for this layer. Not every LayerTreeNode may support all paint representations. E.g. raster layers may not b have a PaintRepresentation.LABEL paint representation.

Updates the values for the external properties you describe with the update parameter. The update parameter looks a lot like the properties descriptor used to create the layer. You provide a set of properties with IDs and updateValues. You can only update values for properties that were defined at construction time.

See

• TileSet3DLayerConstructorOptions.properties You can use the "FeaturesInViewChange" event to send updates for features that are present in the view only.
• TileSet3DLayer.on

Example:

  ogc3dTilesLayer.updateProperties({
    "Temperature": {
      ids: [1, 2, 3],
      //for each id we give a new TemperatureValues, ids that are not updated will remain as is
      values: [25, 27, 28],
    },
    "Maintenance": {
      ids: [9, 10, 12],
      //for each id we provide the same update-value, ids that are not updated are reset to the default value
      value: 1,
    }
  })

Copy

For more information on updating plugged-in properties: Howto: plugging in properties from external data sources

Since

2021.0

Registers a callback function for a given event type.

Called when the transformation on this layer has been changed.

Subscribe on this event to sync your property updates with the changes of features in the view.

  ogc3dTilesLayer.on("FeaturesInViewChange", (idsEnteredView, idsLeftView) => {
    // Possible things to do:
    // - subscribe to the idsEnteredView
    // - remove subscription for idsLeftView
    // - keep track of all idsInView (for updates without this callback)
    // - erase values for idsLeftView (note: all values for all properties are erased at once)
    ogc3dTilesLayer.eraseProperties(idsLeftView);
    // - update values for idsEnteredView
  });

Copy

This event will only get fired if you defined properties at construction time:

See

• TileSet3DLayerConstructorOptions.properties You can use this event to trigger an update or deletion of property values based on the features present in the view
• TileSet3DLayer.eraseProperties

For more information about subscribing to the layer event: Howto: plugging in properties from external data sources

Since

2021.0

Fired when at least one of the performanceHints attribute changed.

Since

2023.0

Fired whenever the loadingStatus attribute changes. For example, whenever new tiles have been loaded or requested.

Since

2023.0