3.11.0 Migration GuideΒΆ
This release includes several API cleanups, refactorings and changes which will be addressed in the following. This document includes general information about the changes necessary for the migration and a detailed list of API changes.
API Changes
The following list contain API additions, changes and removals which might be subject for migration efforts. Most alterations were performed to provide a more streamlined experience when working with the API and come only with minimal need for manual intervention from application developers.
ContextAPI
- changeMaterial
- createMaterial
- getMaterialData
- getMaterials
- measurePointsByDistance
- removeMaterial
- requestXRScanshot
ViewerAPI
- changeGlobalHeatmapConfig
- changeHeatmap
- changePointCloud
- changeXREdgeCompare
- createHeatmap
- createPointCloud
- getGlobalHeatmapConfig
- getHeatmapColorSchemeLegend
- getHeatmapData
- getHeatmaps
- getPointCloudData
- getPointClouds
- getXREdgeCompareProperties
- removeHeatmap
- removePointCloud
- requestXRAutoDetectScores
Events
- MaterialChangedEvent
- MaterialCreatedEvent
- MaterialRemovedEvent
- ViewerHeatmapChangedEvent
- ViewerHeatmapConfigChangedEvent
- ViewerHeatmapCreatedEvent
- ViewerHeatmapRemovedEvent
- ViewerPointCloudChangedEvent
- ViewerPointCloudCreatedEvent
- ViewerPointCloudRemovedEvent
- ViewerXREdgeCompareChangedEvent
Types
- MaterialProperties
- DistanceConstraintMatch
- XRAnchorOptions
- XRScanshot
- CustomHeatmapColorScheme
- HeatmapConfig
- HeatmapProperties
- CloudPoint
- PointCloudProperties
- XRAutoDetectScore
- XREdgeCompareProperties
Enums
- AnimationTargetType
- HeatmapColorScheme
- HeatmapKernel
- TransparencyMode
- XRAutoDetectViewportEnclosure
- XREdgeCompareMode
- ComparisonGroup
- DrawingMode
- EventType
- MeasurementTargetClass
- SettingStrings
- ViewerSettingStrings
- XRCapability
ComparisonGroup
DrawingMode
EventType
- MATERIAL_CHANGED
- MATERIAL_CREATED
- MATERIAL_REMOVED
- VIEWER_HEATMAP_CHANGED
- VIEWER_HEATMAP_CONFIG_CHANGED
- VIEWER_HEATMAP_CREATED
- VIEWER_HEATMAP_REMOVED
- VIEWER_POINT_CLOUD_CHANGED
- VIEWER_POINT_CLOUD_CREATED
- VIEWER_POINT_CLOUD_REMOVED
- VIEWER_XR_EDGE_COMPARE_CHANGED