import {
Check,
Color,
defined,
destroyObject,
Cesium3DTileColorBlendMode,
Cesium3DTileFeature,
Cesium3DTilePass,
Cesium3DTileset,
Cesium3DTileStyle,
PerformanceDisplay,
ResourceCache,
ScreenSpaceEventHandler,
ScreenSpaceEventType,
} from "@cesium/engine";
import knockout from "../ThirdParty/knockout.js";
function getPickTileset(viewModel) {
return function (e) {
const pick = viewModel._scene.pick(e.position);
if (defined(pick) && pick.primitive instanceof Cesium3DTileset) {
viewModel.tileset = pick.primitive;
}
viewModel.pickActive = false;
};
}
function selectTilesetOnHover(viewModel, value) {
if (value) {
viewModel._eventHandler.setInputAction(function (e) {
const pick = viewModel._scene.pick(e.endPosition);
if (defined(pick) && pick.primitive instanceof Cesium3DTileset) {
viewModel.tileset = pick.primitive;
}
}, ScreenSpaceEventType.MOUSE_MOVE);
} else {
viewModel._eventHandler.removeInputAction(ScreenSpaceEventType.MOUSE_MOVE);
// Restore hover-over selection to its current value
// eslint-disable-next-line no-self-assign
viewModel.picking = viewModel.picking;
}
}
const stringOptions = {
maximumFractionDigits: 3,
};
function formatMemoryString(memorySizeInBytes) {
const memoryInMegabytes = memorySizeInBytes / 1048576;
if (memoryInMegabytes < 1.0) {
return memoryInMegabytes.toLocaleString(undefined, stringOptions);
}
return Math.round(memoryInMegabytes).toLocaleString();
}
function getStatistics(tileset, isPick) {
if (!defined(tileset)) {
return "";
}
const statistics = isPick
? tileset._statisticsPerPass[Cesium3DTilePass.PICK]
: tileset._statisticsPerPass[Cesium3DTilePass.RENDER];
// Since the pick pass uses a smaller frustum around the pixel of interest,
// the statistics will be different than the normal render pass.
let s = '
';
s +=
// --- Rendering statistics
`- Visited: ${statistics.visited.toLocaleString()}
` +
// Number of commands returned is likely to be higher than the number of tiles selected
// because of tiles that create multiple commands.
`- Selected: ${statistics.selected.toLocaleString()}
` +
// Number of commands executed is likely to be higher because of commands overlapping
// multiple frustums.
`- Commands: ${statistics.numberOfCommands.toLocaleString()}
`;
s += "
";
if (!isPick) {
s += '';
s +=
// --- Cache/loading statistics
`- Requests: ${statistics.numberOfPendingRequests.toLocaleString()}
` +
`- Attempted: ${statistics.numberOfAttemptedRequests.toLocaleString()}
` +
`- Processing: ${statistics.numberOfTilesProcessing.toLocaleString()}
` +
`- Content Ready: ${statistics.numberOfTilesWithContentReady.toLocaleString()}
` +
// Total number of tiles includes tiles without content, so "Ready" may never reach
// "Total." Total also will increase when a tile with a tileset JSON content is loaded.
`- Total: ${statistics.numberOfTilesTotal.toLocaleString()}
`;
s += "
";
s += '';
s +=
// --- Features statistics
`- Features Selected: ${statistics.numberOfFeaturesSelected.toLocaleString()}
` +
`- Features Loaded: ${statistics.numberOfFeaturesLoaded.toLocaleString()}
` +
`- Points Selected: ${statistics.numberOfPointsSelected.toLocaleString()}
` +
`- Points Loaded: ${statistics.numberOfPointsLoaded.toLocaleString()}
` +
`- Triangles Selected: ${statistics.numberOfTrianglesSelected.toLocaleString()}
`;
s += "
";
s += '';
s +=
// --- Styling statistics
`- Tiles styled: ${statistics.numberOfTilesStyled.toLocaleString()}
` +
`- Features styled: ${statistics.numberOfFeaturesStyled.toLocaleString()}
`;
s += "
";
s += '';
s +=
// --- Optimization statistics
`- Children Union Culled: ${statistics.numberOfTilesCulledWithChildrenUnion.toLocaleString()}
`;
s += "
";
s += '';
s +=
// --- Memory statistics
`- Geometry Memory (MB): ${formatMemoryString(
statistics.geometryByteLength
)}
` +
`- Texture Memory (MB): ${formatMemoryString(
statistics.texturesByteLength
)}
` +
`- Batch Table Memory (MB): ${formatMemoryString(
statistics.batchTableByteLength
)}
`;
s += "
";
}
return s;
}
function getResourceCacheStatistics() {
const statistics = ResourceCache.statistics;
return `
- Geometry Memory (MB): ${formatMemoryString(
statistics.geometryByteLength
)}
- Texture Memory (MB): ${formatMemoryString(
statistics.texturesByteLength
)}
`;
}
const colorBlendModes = [
{
text: "Highlight",
value: Cesium3DTileColorBlendMode.HIGHLIGHT,
},
{
text: "Replace",
value: Cesium3DTileColorBlendMode.REPLACE,
},
{
text: "Mix",
value: Cesium3DTileColorBlendMode.MIX,
},
];
const highlightColor = new Color(1.0, 1.0, 0.0, 0.4);
const scratchColor = new Color();
const oldColor = new Color();
/**
* The view model for {@link Cesium3DTilesInspector}.
* @alias Cesium3DTilesInspectorViewModel
* @constructor
*
* @param {Scene} scene The scene instance to use.
* @param {HTMLElement} performanceContainer The container for the performance display
*/
function Cesium3DTilesInspectorViewModel(scene, performanceContainer) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.object("scene", scene);
Check.typeOf.object("performanceContainer", performanceContainer);
//>>includeEnd('debug');
const that = this;
const canvas = scene.canvas;
this._eventHandler = new ScreenSpaceEventHandler(canvas);
this._scene = scene;
this._performanceContainer = performanceContainer;
this._canvas = canvas;
this._performanceDisplay = new PerformanceDisplay({
container: performanceContainer,
});
this._statisticsText = "";
this._pickStatisticsText = "";
this._resourceCacheStatisticsText = "";
this._editorError = "";
/**
* Gets or sets the flag to enable performance display. This property is observable.
*
* @type {boolean}
* @default false
*/
this.performance = false;
/**
* Gets or sets the flag to show statistics. This property is observable.
*
* @type {boolean}
* @default true
*/
this.showStatistics = true;
/**
* Gets or sets the flag to show pick statistics. This property is observable.
*
* @type {boolean}
* @default true
*/
this.showPickStatistics = true;
/**
* Gets or sets the flag to show resource cache statistics. This property is
* observable.
*
* @type {boolean}
* @default false
*/
this.showResourceCacheStatistics = false;
/**
* Gets or sets the flag to show the inspector. This property is observable.
*
* @type {boolean}
* @default true
*/
this.inspectorVisible = true;
/**
* Gets or sets the flag to show the tileset section. This property is observable.
*
* @type {boolean}
* @default false
*/
this.tilesetVisible = false;
/**
* Gets or sets the flag to show the display section. This property is observable.
*
* @type {boolean}
* @default false
*/
this.displayVisible = false;
/**
* Gets or sets the flag to show the update section. This property is observable.
*
* @type {boolean}
* @default false
*/
this.updateVisible = false;
/**
* Gets or sets the flag to show the logging section. This property is observable.
*
* @type {boolean}
* @default false
*/
this.loggingVisible = false;
/**
* Gets or sets the flag to show the style section. This property is observable.
*
* @type {boolean}
* @default false
*/
this.styleVisible = false;
/**
* Gets or sets the flag to show the tile info section. This property is observable.
*
* @type {boolean}
* @default false
*/
this.tileDebugLabelsVisible = false;
/**
* Gets or sets the flag to show the optimization info section. This property is observable.
*
* @type {boolean}
* @default false;
*/
this.optimizationVisible = false;
/**
* Gets or sets the JSON for the tileset style. This property is observable.
*
* @type {string}
* @default '{}'
*/
this.styleString = "{}";
/**
* Gets or sets the JSON for the tileset enableDebugWireframe attribute. This property is observable.
*
* @type {boolean}
* @default false
*/
this.hasEnabledWireframe = false;
this._tileset = undefined;
this._feature = undefined;
this._tile = undefined;
knockout.track(this, [
"performance",
"inspectorVisible",
"_statisticsText",
"_pickStatisticsText",
"_resourceCacheStatisticsText",
"_editorError",
"showPickStatistics",
"showStatistics",
"showResourceCacheStatistics",
"tilesetVisible",
"displayVisible",
"updateVisible",
"loggingVisible",
"styleVisible",
"optimizationVisible",
"tileDebugLabelsVisible",
"styleString",
"_feature",
"_tile",
"_tileset",
"hasEnabledWireframe",
]);
this._properties = knockout.observable({});
/**
* Gets the names of the properties in the tileset. This property is observable.
* @type {string[]}
* @readonly
*/
this.properties = [];
knockout.defineProperty(this, "properties", function () {
const names = [];
const properties = that._properties();
for (const prop in properties) {
if (properties.hasOwnProperty(prop)) {
names.push(prop);
}
}
return names;
});
const dynamicScreenSpaceError = knockout.observable();
knockout.defineProperty(this, "dynamicScreenSpaceError", {
get: function () {
return dynamicScreenSpaceError();
},
set: function (value) {
dynamicScreenSpaceError(value);
if (defined(that._tileset)) {
that._tileset.dynamicScreenSpaceError = value;
}
},
});
/**
* Gets or sets the flag to enable dynamic screen space error. This property is observable.
*
* @type {boolean}
* @default false
*/
this.dynamicScreenSpaceError = false;
const colorBlendMode = knockout.observable();
knockout.defineProperty(this, "colorBlendMode", {
get: function () {
return colorBlendMode();
},
set: function (value) {
colorBlendMode(value);
if (defined(that._tileset)) {
that._tileset.colorBlendMode = value;
that._scene.requestRender();
}
},
});
/**
* Gets or sets the color blend mode. This property is observable.
*
* @type {Cesium3DTileColorBlendMode}
* @default Cesium3DTileColorBlendMode.HIGHLIGHT
*/
this.colorBlendMode = Cesium3DTileColorBlendMode.HIGHLIGHT;
const showOnlyPickedTileDebugLabel = knockout.observable();
const picking = knockout.observable();
knockout.defineProperty(this, "picking", {
get: function () {
return picking();
},
set: function (value) {
picking(value);
if (value) {
that._eventHandler.setInputAction(function (e) {
const picked = scene.pick(e.endPosition);
if (picked instanceof Cesium3DTileFeature) {
// Picked a feature
that.feature = picked;
that.tile = picked.content.tile;
} else if (defined(picked) && defined(picked.content)) {
// Picked a tile
that.feature = undefined;
that.tile = picked.content.tile;
} else {
// Picked nothing
that.feature = undefined;
that.tile = undefined;
}
if (!defined(that._tileset)) {
return;
}
if (
showOnlyPickedTileDebugLabel &&
defined(picked) &&
defined(picked.content)
) {
let position;
if (scene.pickPositionSupported) {
position = scene.pickPosition(e.endPosition);
if (defined(position)) {
that._tileset.debugPickPosition = position;
}
}
that._tileset.debugPickedTile = picked.content.tile;
} else {
that._tileset.debugPickedTile = undefined;
}
that._scene.requestRender();
}, ScreenSpaceEventType.MOUSE_MOVE);
} else {
that.feature = undefined;
that.tile = undefined;
that._eventHandler.removeInputAction(ScreenSpaceEventType.MOUSE_MOVE);
}
},
});
/**
* Gets or sets the flag to enable picking. This property is observable.
*
* @type {boolean}
* @default true
*/
this.picking = true;
const colorize = knockout.observable();
knockout.defineProperty(this, "colorize", {
get: function () {
return colorize();
},
set: function (value) {
colorize(value);
if (defined(that._tileset)) {
that._tileset.debugColorizeTiles = value;
that._scene.requestRender();
}
},
});
/**
* Gets or sets the flag to colorize tiles. This property is observable.
*
* @type {boolean}
* @default false
*/
this.colorize = false;
const wireframe = knockout.observable();
knockout.defineProperty(this, "wireframe", {
get: function () {
return wireframe();
},
set: function (value) {
wireframe(value);
if (defined(that._tileset)) {
that._tileset.debugWireframe = value;
that._scene.requestRender();
}
},
});
/**
* Gets or sets the flag to draw with wireframe. This property is observable.
*
* @type {boolean}
* @default false
*/
this.wireframe = false;
const showBoundingVolumes = knockout.observable();
knockout.defineProperty(this, "showBoundingVolumes", {
get: function () {
return showBoundingVolumes();
},
set: function (value) {
showBoundingVolumes(value);
if (defined(that._tileset)) {
that._tileset.debugShowBoundingVolume = value;
that._scene.requestRender();
}
},
});
/**
* Gets or sets the flag to show bounding volumes. This property is observable.
*
* @type {boolean}
* @default false
*/
this.showBoundingVolumes = false;
const showContentBoundingVolumes = knockout.observable();
knockout.defineProperty(this, "showContentBoundingVolumes", {
get: function () {
return showContentBoundingVolumes();
},
set: function (value) {
showContentBoundingVolumes(value);
if (defined(that._tileset)) {
that._tileset.debugShowContentBoundingVolume = value;
that._scene.requestRender();
}
},
});
/**
* Gets or sets the flag to show content volumes. This property is observable.
*
* @type {boolean}
* @default false
*/
this.showContentBoundingVolumes = false;
const showRequestVolumes = knockout.observable();
knockout.defineProperty(this, "showRequestVolumes", {
get: function () {
return showRequestVolumes();
},
set: function (value) {
showRequestVolumes(value);
if (defined(that._tileset)) {
that._tileset.debugShowViewerRequestVolume = value;
that._scene.requestRender();
}
},
});
/**
* Gets or sets the flag to show request volumes. This property is observable.
*
* @type {boolean}
* @default false
*/
this.showRequestVolumes = false;
const freezeFrame = knockout.observable();
knockout.defineProperty(this, "freezeFrame", {
get: function () {
return freezeFrame();
},
set: function (value) {
freezeFrame(value);
if (defined(that._tileset)) {
that._tileset.debugFreezeFrame = value;
that._scene.debugShowFrustumPlanes = value;
that._scene.requestRender();
}
},
});
/**
* Gets or sets the flag to suspend updates. This property is observable.
*
* @type {boolean}
* @default false
*/
this.freezeFrame = false;
knockout.defineProperty(this, "showOnlyPickedTileDebugLabel", {
get: function () {
return showOnlyPickedTileDebugLabel();
},
set: function (value) {
showOnlyPickedTileDebugLabel(value);
if (defined(that._tileset)) {
that._tileset.debugPickedTileLabelOnly = value;
that._scene.requestRender();
}
},
});
/**
* Gets or sets the flag to show debug labels only for the currently picked tile. This property is observable.
*
* @type {boolean}
* @default false
*/
this.showOnlyPickedTileDebugLabel = false;
const showGeometricError = knockout.observable();
knockout.defineProperty(this, "showGeometricError", {
get: function () {
return showGeometricError();
},
set: function (value) {
showGeometricError(value);
if (defined(that._tileset)) {
that._tileset.debugShowGeometricError = value;
that._scene.requestRender();
}
},
});
/**
* Gets or sets the flag to show tile geometric error. This property is observable.
*
* @type {boolean}
* @default false
*/
this.showGeometricError = false;
const showRenderingStatistics = knockout.observable();
knockout.defineProperty(this, "showRenderingStatistics", {
get: function () {
return showRenderingStatistics();
},
set: function (value) {
showRenderingStatistics(value);
if (defined(that._tileset)) {
that._tileset.debugShowRenderingStatistics = value;
that._scene.requestRender();
}
},
});
/**
* Displays the number of commands, points, triangles and features used per tile. This property is observable.
*
* @type {boolean}
* @default false
*/
this.showRenderingStatistics = false;
const showMemoryUsage = knockout.observable();
knockout.defineProperty(this, "showMemoryUsage", {
get: function () {
return showMemoryUsage();
},
set: function (value) {
showMemoryUsage(value);
if (defined(that._tileset)) {
that._tileset.debugShowMemoryUsage = value;
that._scene.requestRender();
}
},
});
/**
* Displays the memory used per tile. This property is observable.
*
* @type {boolean}
* @default false
*/
this.showMemoryUsage = false;
const showUrl = knockout.observable();
knockout.defineProperty(this, "showUrl", {
get: function () {
return showUrl();
},
set: function (value) {
showUrl(value);
if (defined(that._tileset)) {
that._tileset.debugShowUrl = value;
that._scene.requestRender();
}
},
});
/**
* Gets or sets the flag to show the tile url. This property is observable.
*
* @type {boolean}
* @default false
*/
this.showUrl = false;
const maximumScreenSpaceError = knockout.observable();
knockout.defineProperty(this, "maximumScreenSpaceError", {
get: function () {
return maximumScreenSpaceError();
},
set: function (value) {
value = Number(value);
if (!isNaN(value)) {
maximumScreenSpaceError(value);
if (defined(that._tileset)) {
that._tileset.maximumScreenSpaceError = value;
}
}
},
});
/**
* Gets or sets the maximum screen space error. This property is observable.
*
* @type {number}
* @default 16
*/
this.maximumScreenSpaceError = 16;
const dynamicScreenSpaceErrorDensity = knockout.observable();
knockout.defineProperty(this, "dynamicScreenSpaceErrorDensity", {
get: function () {
return dynamicScreenSpaceErrorDensity();
},
set: function (value) {
value = Number(value);
if (!isNaN(value)) {
dynamicScreenSpaceErrorDensity(value);
if (defined(that._tileset)) {
that._tileset.dynamicScreenSpaceErrorDensity = value;
}
}
},
});
/**
* Gets or sets the dynamic screen space error density. This property is observable.
*
* @type {number}
* @default 0.00278
*/
this.dynamicScreenSpaceErrorDensity = 0.00278;
/**
* Gets or sets the dynamic screen space error density slider value.
* This allows the slider to be exponential because values tend to be closer to 0 than 1.
* This property is observable.
*
* @type {number}
* @default 0.00278
*/
this.dynamicScreenSpaceErrorDensitySliderValue = undefined;
knockout.defineProperty(this, "dynamicScreenSpaceErrorDensitySliderValue", {
get: function () {
return Math.pow(dynamicScreenSpaceErrorDensity(), 1 / 6);
},
set: function (value) {
dynamicScreenSpaceErrorDensity(Math.pow(value, 6));
},
});
const dynamicScreenSpaceErrorFactor = knockout.observable();
knockout.defineProperty(this, "dynamicScreenSpaceErrorFactor", {
get: function () {
return dynamicScreenSpaceErrorFactor();
},
set: function (value) {
value = Number(value);
if (!isNaN(value)) {
dynamicScreenSpaceErrorFactor(value);
if (defined(that._tileset)) {
that._tileset.dynamicScreenSpaceErrorFactor = value;
}
}
},
});
/**
* Gets or sets the dynamic screen space error factor. This property is observable.
*
* @type {number}
* @default 4.0
*/
this.dynamicScreenSpaceErrorFactor = 4.0;
const pickTileset = getPickTileset(this);
const pickActive = knockout.observable();
knockout.defineProperty(this, "pickActive", {
get: function () {
return pickActive();
},
set: function (value) {
pickActive(value);
if (value) {
that._eventHandler.setInputAction(
pickTileset,
ScreenSpaceEventType.LEFT_CLICK
);
} else {
that._eventHandler.removeInputAction(ScreenSpaceEventType.LEFT_CLICK);
}
},
});
const pointCloudShading = knockout.observable();
knockout.defineProperty(this, "pointCloudShading", {
get: function () {
return pointCloudShading();
},
set: function (value) {
pointCloudShading(value);
if (defined(that._tileset)) {
that._tileset.pointCloudShading.attenuation = value;
}
},
});
/**
* Gets or sets the flag to enable point cloud shading. This property is observable.
*
* @type {boolean}
* @default false
*/
this.pointCloudShading = false;
const geometricErrorScale = knockout.observable();
knockout.defineProperty(this, "geometricErrorScale", {
get: function () {
return geometricErrorScale();
},
set: function (value) {
value = Number(value);
if (!isNaN(value)) {
geometricErrorScale(value);
if (defined(that._tileset)) {
that._tileset.pointCloudShading.geometricErrorScale = value;
}
}
},
});
/**
* Gets or sets the geometric error scale. This property is observable.
*
* @type {number}
* @default 1.0
*/
this.geometricErrorScale = 1.0;
const maximumAttenuation = knockout.observable();
knockout.defineProperty(this, "maximumAttenuation", {
get: function () {
return maximumAttenuation();
},
set: function (value) {
value = Number(value);
if (!isNaN(value)) {
maximumAttenuation(value);
if (defined(that._tileset)) {
that._tileset.pointCloudShading.maximumAttenuation =
value === 0 ? undefined : value;
}
}
},
});
/**
* Gets or sets the maximum attenuation. This property is observable.
*
* @type {number}
* @default 0
*/
this.maximumAttenuation = 0;
const baseResolution = knockout.observable();
knockout.defineProperty(this, "baseResolution", {
get: function () {
return baseResolution();
},
set: function (value) {
value = Number(value);
if (!isNaN(value)) {
baseResolution(value);
if (defined(that._tileset)) {
that._tileset.pointCloudShading.baseResolution =
value === 0 ? undefined : value;
}
}
},
});
/**
* Gets or sets the base resolution. This property is observable.
*
* @type {number}
* @default 0
*/
this.baseResolution = 0;
const eyeDomeLighting = knockout.observable();
knockout.defineProperty(this, "eyeDomeLighting", {
get: function () {
return eyeDomeLighting();
},
set: function (value) {
eyeDomeLighting(value);
if (defined(that._tileset)) {
that._tileset.pointCloudShading.eyeDomeLighting = value;
}
},
});
/**
* Gets or sets the flag to enable eye dome lighting. This property is observable.
*
* @type {boolean}
* @default false
*/
this.eyeDomeLighting = false;
const eyeDomeLightingStrength = knockout.observable();
knockout.defineProperty(this, "eyeDomeLightingStrength", {
get: function () {
return eyeDomeLightingStrength();
},
set: function (value) {
value = Number(value);
if (!isNaN(value)) {
eyeDomeLightingStrength(value);
if (defined(that._tileset)) {
that._tileset.pointCloudShading.eyeDomeLightingStrength = value;
}
}
},
});
/**
* Gets or sets the eye dome lighting strength. This property is observable.
*
* @type {number}
* @default 1.0
*/
this.eyeDomeLightingStrength = 1.0;
const eyeDomeLightingRadius = knockout.observable();
knockout.defineProperty(this, "eyeDomeLightingRadius", {
get: function () {
return eyeDomeLightingRadius();
},
set: function (value) {
value = Number(value);
if (!isNaN(value)) {
eyeDomeLightingRadius(value);
if (defined(that._tileset)) {
that._tileset.pointCloudShading.eyeDomeLightingRadius = value;
}
}
},
});
/**
* Gets or sets the eye dome lighting radius. This property is observable.
*
* @type {number}
* @default 1.0
*/
this.eyeDomeLightingRadius = 1.0;
/**
* Gets or sets the pick state
*
* @type {boolean}
* @default false
*/
this.pickActive = false;
const skipLevelOfDetail = knockout.observable();
knockout.defineProperty(this, "skipLevelOfDetail", {
get: function () {
return skipLevelOfDetail();
},
set: function (value) {
skipLevelOfDetail(value);
if (defined(that._tileset)) {
that._tileset.skipLevelOfDetail = value;
}
},
});
/**
* Gets or sets the flag to determine if level of detail skipping should be applied during the traversal.
* This property is observable.
* @type {boolean}
* @default true
*/
this.skipLevelOfDetail = true;
const skipScreenSpaceErrorFactor = knockout.observable();
knockout.defineProperty(this, "skipScreenSpaceErrorFactor", {
get: function () {
return skipScreenSpaceErrorFactor();
},
set: function (value) {
value = Number(value);
if (!isNaN(value)) {
skipScreenSpaceErrorFactor(value);
if (defined(that._tileset)) {
that._tileset.skipScreenSpaceErrorFactor = value;
}
}
},
});
/**
* Gets or sets the multiplier defining the minimum screen space error to skip. This property is observable.
* @type {number}
* @default 16
*/
this.skipScreenSpaceErrorFactor = 16;
const baseScreenSpaceError = knockout.observable();
knockout.defineProperty(this, "baseScreenSpaceError", {
get: function () {
return baseScreenSpaceError();
},
set: function (value) {
value = Number(value);
if (!isNaN(value)) {
baseScreenSpaceError(value);
if (defined(that._tileset)) {
that._tileset.baseScreenSpaceError = value;
}
}
},
});
/**
* Gets or sets the screen space error that must be reached before skipping levels of detail. This property is observable.
* @type {number}
* @default 1024
*/
this.baseScreenSpaceError = 1024;
const skipLevels = knockout.observable();
knockout.defineProperty(this, "skipLevels", {
get: function () {
return skipLevels();
},
set: function (value) {
value = Number(value);
if (!isNaN(value)) {
skipLevels(value);
if (defined(that._tileset)) {
that._tileset.skipLevels = value;
}
}
},
});
/**
* Gets or sets the constant defining the minimum number of levels to skip when loading tiles. This property is observable.
* @type {number}
* @default 1
*/
this.skipLevels = 1;
const immediatelyLoadDesiredLevelOfDetail = knockout.observable();
knockout.defineProperty(this, "immediatelyLoadDesiredLevelOfDetail", {
get: function () {
return immediatelyLoadDesiredLevelOfDetail();
},
set: function (value) {
immediatelyLoadDesiredLevelOfDetail(value);
if (defined(that._tileset)) {
that._tileset.immediatelyLoadDesiredLevelOfDetail = value;
}
},
});
/**
* Gets or sets the flag which, when true, only tiles that meet the maximum screen space error will ever be downloaded.
* This property is observable.
* @type {boolean}
* @default false
*/
this.immediatelyLoadDesiredLevelOfDetail = false;
const loadSiblings = knockout.observable();
knockout.defineProperty(this, "loadSiblings", {
get: function () {
return loadSiblings();
},
set: function (value) {
loadSiblings(value);
if (defined(that._tileset)) {
that._tileset.loadSiblings = value;
}
},
});
/**
* Gets or sets the flag which determines whether siblings of visible tiles are always downloaded during traversal.
* This property is observable
* @type {boolean}
* @default false
*/
this.loadSiblings = false;
this._style = undefined;
this._shouldStyle = false;
this._definedProperties = [
"properties",
"dynamicScreenSpaceError",
"colorBlendMode",
"picking",
"colorize",
"wireframe",
"showBoundingVolumes",
"showContentBoundingVolumes",
"showRequestVolumes",
"freezeFrame",
"maximumScreenSpaceError",
"dynamicScreenSpaceErrorDensity",
"baseScreenSpaceError",
"skipScreenSpaceErrorFactor",
"skipLevelOfDetail",
"skipLevels",
"immediatelyLoadDesiredLevelOfDetail",
"loadSiblings",
"dynamicScreenSpaceErrorDensitySliderValue",
"dynamicScreenSpaceErrorFactor",
"pickActive",
"showOnlyPickedTileDebugLabel",
"showGeometricError",
"showRenderingStatistics",
"showMemoryUsage",
"showUrl",
"pointCloudShading",
"geometricErrorScale",
"maximumAttenuation",
"baseResolution",
"eyeDomeLighting",
"eyeDomeLightingStrength",
"eyeDomeLightingRadius",
];
this._removePostRenderEvent = scene.postRender.addEventListener(function () {
that._update();
});
if (!defined(this._tileset)) {
selectTilesetOnHover(this, true);
}
}
Object.defineProperties(Cesium3DTilesInspectorViewModel.prototype, {
/**
* Gets the scene
* @memberof Cesium3DTilesInspectorViewModel.prototype
* @type {Scene}
* @readonly
*/
scene: {
get: function () {
return this._scene;
},
},
/**
* Gets the performance container
* @memberof Cesium3DTilesInspectorViewModel.prototype
* @type {HTMLElement}
* @readonly
*/
performanceContainer: {
get: function () {
return this._performanceContainer;
},
},
/**
* Gets the statistics text. This property is observable.
* @memberof Cesium3DTilesInspectorViewModel.prototype
* @type {string}
* @readonly
*/
statisticsText: {
get: function () {
return this._statisticsText;
},
},
/**
* Gets the pick statistics text. This property is observable.
* @memberof Cesium3DTilesInspectorViewModel.prototype
* @type {string}
* @readonly
*/
pickStatisticsText: {
get: function () {
return this._pickStatisticsText;
},
},
/**
* Gets the resource cache statistics text. This property is observable.
* @memberof Cesium3DTilesInspectorViewModel.prototype
* @type {string}
* @readonly
*/
resourceCacheStatisticsText: {
get: function () {
return this._resourceCacheStatisticsText;
},
},
/**
* Gets the available blend modes
* @memberof Cesium3DTilesInspectorViewModel.prototype
* @type {Object[]}
* @readonly
*/
colorBlendModes: {
get: function () {
return colorBlendModes;
},
},
/**
* Gets the editor error message
* @memberof Cesium3DTilesInspectorViewModel.prototype
* @type {string}
* @readonly
*/
editorError: {
get: function () {
return this._editorError;
},
},
/**
* Gets or sets the tileset of the view model.
* @memberof Cesium3DTilesInspectorViewModel.prototype
* @type {Cesium3DTileset}
*/
tileset: {
get: function () {
return this._tileset;
},
set: function (tileset) {
this._tileset = tileset;
this._style = undefined;
this.styleString = "{}";
this.feature = undefined;
this.tile = undefined;
if (defined(tileset)) {
const that = this;
// This is here for backwards compatibility. It can be removed when Cesium3DTileset.readyPromise is fully deprecated.
tileset._readyPromise.then(function (t) {
if (!that.isDestroyed()) {
that._properties(t.properties);
}
});
// update tileset with existing settings
const settings = [
"colorize",
"wireframe",
"showBoundingVolumes",
"showContentBoundingVolumes",
"showRequestVolumes",
"freezeFrame",
"showOnlyPickedTileDebugLabel",
"showGeometricError",
"showRenderingStatistics",
"showMemoryUsage",
"showUrl",
];
const length = settings.length;
for (let i = 0; i < length; ++i) {
const setting = settings[i];
//eslint-disable-next-line no-self-assign
this[setting] = this[setting];
}
// update view model with existing tileset settings
this.maximumScreenSpaceError = tileset.maximumScreenSpaceError;
this.dynamicScreenSpaceError = tileset.dynamicScreenSpaceError;
this.dynamicScreenSpaceErrorDensity =
tileset.dynamicScreenSpaceErrorDensity;
this.dynamicScreenSpaceErrorFactor =
tileset.dynamicScreenSpaceErrorFactor;
this.colorBlendMode = tileset.colorBlendMode;
this.skipLevelOfDetail = tileset.skipLevelOfDetail;
this.skipScreenSpaceErrorFactor = tileset.skipScreenSpaceErrorFactor;
this.baseScreenSpaceError = tileset.baseScreenSpaceError;
this.skipLevels = tileset.skipLevels;
this.immediatelyLoadDesiredLevelOfDetail =
tileset.immediatelyLoadDesiredLevelOfDetail;
this.loadSiblings = tileset.loadSiblings;
this.hasEnabledWireframe = tileset._enableDebugWireframe;
const pointCloudShading = tileset.pointCloudShading;
this.pointCloudShading = pointCloudShading.attenuation;
this.geometricErrorScale = pointCloudShading.geometricErrorScale;
this.maximumAttenuation = pointCloudShading.maximumAttenuation
? pointCloudShading.maximumAttenuation
: 0.0;
this.baseResolution = pointCloudShading.baseResolution
? pointCloudShading.baseResolution
: 0.0;
this.eyeDomeLighting = pointCloudShading.eyeDomeLighting;
this.eyeDomeLightingStrength =
pointCloudShading.eyeDomeLightingStrength;
this.eyeDomeLightingRadius = pointCloudShading.eyeDomeLightingRadius;
this._scene.requestRender();
} else {
this._properties({});
}
this._statisticsText = getStatistics(tileset, false);
this._pickStatisticsText = getStatistics(tileset, true);
this._resourceCacheStatisticsText = getResourceCacheStatistics();
selectTilesetOnHover(this, false);
},
},
/**
* Gets the current feature of the view model.
* @memberof Cesium3DTilesInspectorViewModel.prototype
* @type {Cesium3DTileFeature}
*/
feature: {
get: function () {
return this._feature;
},
set: function (feature) {
if (this._feature === feature) {
return;
}
const currentFeature = this._feature;
if (defined(currentFeature) && !currentFeature.content.isDestroyed()) {
// Restore original color to feature that is no longer selected
if (!this.colorize && defined(this._style)) {
currentFeature.color = defined(this._style.color)
? this._style.color.evaluateColor(currentFeature, scratchColor)
: Color.WHITE;
} else {
currentFeature.color = oldColor;
}
this._scene.requestRender();
}
if (defined(feature)) {
// Highlight new feature
Color.clone(feature.color, oldColor);
feature.color = highlightColor;
this._scene.requestRender();
}
this._feature = feature;
},
},
/**
* Gets the current tile of the view model
* @memberof Cesium3DTilesInspectorViewModel.prototype
* @type {Cesium3DTile}
*/
tile: {
get: function () {
return this._tile;
},
set: function (tile) {
if (this._tile === tile) {
return;
}
const currentTile = this._tile;
if (
defined(currentTile) &&
!currentTile.isDestroyed() &&
!hasFeatures(currentTile.content)
) {
// Restore original color to tile that is no longer selected
currentTile.color = oldColor;
this._scene.requestRender();
}
if (defined(tile) && !hasFeatures(tile.content)) {
// Highlight new tile
Color.clone(tile.color, oldColor);
tile.color = highlightColor;
this._scene.requestRender();
}
this._tile = tile;
},
},
});
function hasFeatures(content) {
if (!defined(content)) {
return false;
}
if (content.featuresLength > 0) {
return true;
}
const innerContents = content.innerContents;
if (defined(innerContents)) {
const length = innerContents.length;
for (let i = 0; i < length; ++i) {
if (!hasFeatures(innerContents[i])) {
return false;
}
}
return true;
}
return false;
}
/**
* Toggles the pick tileset mode
*/
Cesium3DTilesInspectorViewModel.prototype.togglePickTileset = function () {
this.pickActive = !this.pickActive;
};
/**
* Toggles the inspector visibility
*/
Cesium3DTilesInspectorViewModel.prototype.toggleInspector = function () {
this.inspectorVisible = !this.inspectorVisible;
};
/**
* Toggles the visibility of the tileset section
*/
Cesium3DTilesInspectorViewModel.prototype.toggleTileset = function () {
this.tilesetVisible = !this.tilesetVisible;
};
/**
* Toggles the visibility of the display section
*/
Cesium3DTilesInspectorViewModel.prototype.toggleDisplay = function () {
this.displayVisible = !this.displayVisible;
};
/**
* Toggles the visibility of the update section
*/
Cesium3DTilesInspectorViewModel.prototype.toggleUpdate = function () {
this.updateVisible = !this.updateVisible;
};
/**
* Toggles the visibility of the logging section
*/
Cesium3DTilesInspectorViewModel.prototype.toggleLogging = function () {
this.loggingVisible = !this.loggingVisible;
};
/**
* Toggles the visibility of the style section
*/
Cesium3DTilesInspectorViewModel.prototype.toggleStyle = function () {
this.styleVisible = !this.styleVisible;
};
/**
* Toggles the visibility of the tile Debug Info section
*/
Cesium3DTilesInspectorViewModel.prototype.toggleTileDebugLabels = function () {
this.tileDebugLabelsVisible = !this.tileDebugLabelsVisible;
};
/**
* Toggles the visibility of the optimization section
*/
Cesium3DTilesInspectorViewModel.prototype.toggleOptimization = function () {
this.optimizationVisible = !this.optimizationVisible;
};
/**
* Trims tile cache
*/
Cesium3DTilesInspectorViewModel.prototype.trimTilesCache = function () {
if (defined(this._tileset)) {
this._tileset.trimLoadedTiles();
}
};
/**
* Compiles the style in the style editor.
*/
Cesium3DTilesInspectorViewModel.prototype.compileStyle = function () {
const tileset = this._tileset;
if (!defined(tileset) || this.styleString === JSON.stringify(tileset.style)) {
return;
}
this._editorError = "";
try {
if (this.styleString.length === 0) {
this.styleString = "{}";
}
this._style = new Cesium3DTileStyle(JSON.parse(this.styleString));
this._shouldStyle = true;
this._scene.requestRender();
} catch (err) {
this._editorError = err.toString();
}
// set feature again so pick coloring is set
this.feature = this._feature;
this.tile = this._tile;
};
/**
* Handles key press events on the style editor.
*/
Cesium3DTilesInspectorViewModel.prototype.styleEditorKeyPress = function (
sender,
event
) {
if (event.keyCode === 9) {
//tab
event.preventDefault();
const textArea = event.target;
const start = textArea.selectionStart;
const end = textArea.selectionEnd;
let newEnd = end;
const selected = textArea.value.slice(start, end);
const lines = selected.split("\n");
const length = lines.length;
let i;
if (!event.shiftKey) {
for (i = 0; i < length; ++i) {
lines[i] = ` ${lines[i]}`;
newEnd += 2;
}
} else {
for (i = 0; i < length; ++i) {
if (lines[i][0] === " ") {
if (lines[i][1] === " ") {
lines[i] = lines[i].substr(2);
newEnd -= 2;
} else {
lines[i] = lines[i].substr(1);
newEnd -= 1;
}
}
}
}
const newText = lines.join("\n");
textArea.value =
textArea.value.slice(0, start) + newText + textArea.value.slice(end);
textArea.selectionStart = start !== end ? start : newEnd;
textArea.selectionEnd = newEnd;
} else if (event.ctrlKey && (event.keyCode === 10 || event.keyCode === 13)) {
//ctrl + enter
this.compileStyle();
}
return true;
};
/**
* Updates the values of view model
* @private
*/
Cesium3DTilesInspectorViewModel.prototype._update = function () {
const tileset = this._tileset;
if (this.performance) {
this._performanceDisplay.update();
}
if (defined(tileset)) {
if (tileset.isDestroyed()) {
this.tile = undefined;
this.feature = undefined;
this.tileset = undefined;
return;
}
const style = tileset.style;
if (this._style !== tileset.style) {
if (this._shouldStyle) {
tileset.style = this._style;
this._shouldStyle = false;
} else {
this._style = style;
this.styleString = JSON.stringify(style.style, null, " ");
}
}
}
if (this.showStatistics) {
this._statisticsText = getStatistics(tileset, false);
this._pickStatisticsText = getStatistics(tileset, true);
this._resourceCacheStatisticsText = getResourceCacheStatistics();
}
};
/**
* @returns {boolean} true if the object has been destroyed, false otherwise.
*/
Cesium3DTilesInspectorViewModel.prototype.isDestroyed = function () {
return false;
};
/**
* Destroys the widget. Should be called if permanently
* removing the widget from layout.
*/
Cesium3DTilesInspectorViewModel.prototype.destroy = function () {
this._eventHandler.destroy();
this._removePostRenderEvent();
const that = this;
this._definedProperties.forEach(function (property) {
knockout.getObservable(that, property).dispose();
});
return destroyObject(this);
};
/**
* Generates an HTML string of the statistics
*
* @function
* @param {Cesium3DTileset} tileset The tileset
* @param {boolean} isPick Whether this is getting the statistics for the pick pass
* @returns {string} The formatted statistics
*/
Cesium3DTilesInspectorViewModel.getStatistics = getStatistics;
export default Cesium3DTilesInspectorViewModel;