BM3DTileset

A3D Tiles tileset，用于流式處理大量異構三維地理空間數據集。

new BM3DTileset(options)

Parameters:

options (Object)

Name	Description
options.url `(Resource \| String \| Promise.<Resource> \| Promise.<String>)`	tileset json文件的URL。
options.show `Boolean` default `true`	確定是否顯示顎化集。
options.modelMatrix `Matrix4` default `Matrix4.IDENTITY`	一個4x4變換矩陣，它轉換tileset的根瓦片。
options.shadows `ShadowMode` default `ShadowMode.ENABLED`	確定tileset是投射還是接收來自每個光源的陰影。
options.maximumScreenSpaceError `Number` default `16`	用于驅動細節細化級別的最大屏幕空間錯誤。
options.maximumMemoryUsage `Number` default `512`	tileset可以使用的最大內存量（MB）。
options.cullWithChildrenBounds `Boolean` default `true`	優化選項。是否使用其子對象邊界體積的聯合來剔除瓦片。
options.cullRequestsWhileMoving `Boolean` default `true`	優化選項。不要請求可能因為相機的移動而返回時未使用的磁貼。
options.cullRequestsWhileMovingMultiplier `Number` default `60.0`	優化選項。移動時剔除請求時使用的乘數。較大的是更具侵略性的剔除，較小的是不具侵略性的剔除。
options.preloadWhenHidden `Boolean` default `false`	當`tileset.show`為`false`時預加載瓦片。加載瓦片，就像瓦片集可見但不呈現它們一樣。
options.preloadFlightDestinations `Boolean` default `true`	優化選項。當相機正在飛行時，在相機的飛行目的地預加載磁貼。
options.preferLeaves `Boolean` default `false`	優化選項。最好先裝樹葉。
options.dynamicScreenSpaceError `Boolean` default `false`	優化選項。減少離相機較遠的磁貼的屏幕空間錯誤。
options.dynamicScreenSpaceErrorDensity `Number` default `0.00278`	密度用于調整動態屏幕空間誤差，類似于霧密度。
options.dynamicScreenSpaceErrorFactor `Number` default `4.0`	用于增加計算出的動態屏幕空間誤差的系數。
options.dynamicScreenSpaceErrorHeightFalloff `Number` default `0.25`	密度開始下降時的蒂勒塞特高度的比率。
options.progressiveResolutionHeightFraction `Number` default `0.3`	優化選項。如果介于（0.0，0.5）之間，將首先優先考慮降低屏幕分辨率`progressiveResolutionHeightFraction*screenHeight`的屏幕空間誤差或高于該誤差的瓦片。這有助于在繼續加載全分辨率磁貼時快速放下磁貼層。
options.foveatedScreenSpaceError `Boolean` default `true`	優化選項。通過臨時提高屏幕邊緣周圍的瓦片的屏幕空間錯誤，將在屏幕中心加載瓦片的優先級排序。加載`BM3DTileset#foveatedConeSize`所確定的屏幕中心的所有磁貼后，屏幕空間錯誤恢復正常。
options.foveatedConeSize `Number` default `0.1`	優化選項。當`BM3DTileset#foveatedScreenSpaceError`為真時使用，以控制用于確定延遲的瓦片的圓錐體大小。此圓錐體內的瓦片將立即加載。錐體外的平鋪可能會根據它們在錐體外的距離及其屏幕空間錯誤而延遲。這由`BM3DTileset#foveatedInterpolationCallback`和`BM3DTileset#foveatedMinimumScreenSpaceErrorRelaxation`控制。將此值設置為0.0表示圓錐體將是由相機位置及其視圖方向形成的線。將此設置為1.0意味著圓錐體包含相機的整個視場，禁用效果。
options.foveatedMinimumScreenSpaceErrorRelaxation `Number` default `0.0`	優化選項。當`BM3DTileset#foveatedScreenSpaceError`為真時，用于控制凹錐外瓦片的起始屏幕空間誤差松弛。屏幕空間錯誤將根據提供的`BM3DTileset#foveatedInterpolationCallback`從tileset值開始升高到`BM3DTileset#maximumScreenSpaceError`。
options.foveatedInterpolationCallback `BM3DTileset~foveatedInterpolationCallback` default `Math.lerp`	優化選項。當`BM3DTileset#foveatedScreenSpaceError`為真時，用于控制在中央凹錐體外增加瓦片屏幕空間誤差的程度，在`BM3DTileset#foveatedMinimumScreenSpaceErrorRelaxation`和`BM3DTileset#maximumScreenSpaceError`之間插入。
options.foveatedTimeDelay `Number` default `0.2`	優化選項。當`BM3DTileset#foveatedScreenSpaceError`為真時使用，以秒為單位控制延遲瓦片開始加載之前相機停止移動后的等待時間。此時間延遲可防止攝像機移動時在屏幕邊緣周圍請求平鋪。將此設置為0.0將立即請求任何給定視圖中的所有瓦片。
options.skipLevelOfDetail `Boolean` default `true`	優化選項。確定遍歷期間是否應應用細節級別跳過。
options.baseScreenSpaceError `Number` default `1024`	當`skipLevelOfDetail`為`true`時，在跳過詳細級別之前必須達到的屏幕空間錯誤。
options.skipScreenSpaceErrorFactor `Number` default `16`	當`skipLevelOfDetail`為`true`時，定義要跳過的最小屏幕空間錯誤的乘數。與`skipLevels`一起使用，以確定要加載的瓦片。
options.skipLevels `Number` default `1`	當`skipLevelOfDetail`為`true`時，定義加載瓦片時要跳過的最小級別數的常量。為0時，不跳過任何級別。與`skipScreenSpaceErrorFactor`一起使用，以確定要加載的瓦片。
options.immediatelyLoadDesiredLevelOfDetail `Boolean` default `false`	當`skipLevelOfDetail`為`true`時，將只下載滿足最大屏幕空間錯誤的磁貼。跳過因子被忽略，只加載所需的瓦片。
options.loadSiblings `Boolean` default `false`	當`skipLevelOfDetail`為`true`時，確定遍歷期間是否始終下載可見瓦片的同級。
options.clippingPlanes `ClippingPlaneCollection`	`ClippingPlaneCollection`用于選擇性地禁用呈現tileset。
options.classificationType `ClassificationType`	確定地形、三維瓦片或兩者都將按此瓦片集分類。有關限制和限制的詳細信息，請參見`BM3DTileset#classificationType`。
options.ellipsoid `Ellipsoid` default `Ellipsoid.WGS84`	決定球體大小和形狀的橢球體。
options.pointCloudShading `Object`	用于構建`PointCloudShading`對象的選項，以根據幾何誤差和照明控制點衰減。
options.imageBasedLightingFactor `Cartesian2` default `new Cartesian2(1.0, 1.0)`	縮放來自地球、天空、大氣和星空盒的漫反射和鏡面反射基于圖像的照明。
options.lightColor `Cartesian3`	用來給模型加陰影的陽光的顏色和強度。
options.luminanceAtZenith `Number` default `0.2`	太陽在天頂的亮度，單位為千克燭光每平方米，用于此模型的程序環境地圖。
options.sphericalHarmonicCoefficients `Array.<Cartesian3>`	三階球面諧波系數用于圖像光的漫反射顏色。
options.specularEnvironmentMaps `String`	KTX文件的一個URL，其中包含鏡面照明和卷積鏡面mipmap的立方體映射。
options.debugHeatmapTilePropertyName `String`	要作為heatmap著色的瓦片變量。所有渲染的瓦片將根據彼此指定的變量值著色。
options.debugFreezeFrame `Boolean` default `false`	僅用于調試。確定是否只應使用最后一幀的瓦片進行渲染。
options.debugColorizeTiles `Boolean` default `false`	僅用于調試。如果為真，則為每個瓦片指定隨機顏色。
options.debugWireframe `Boolean` default `false`	僅用于調試。如果為真，則將每個瓦片的內容渲染為線框。
options.debugShowBoundingVolume `Boolean` default `false`	僅用于調試。如果為真，則渲染每個瓦片的邊界體積。
options.debugShowContentBoundingVolume `Boolean` default `false`	僅用于調試。如果為真，則渲染每個瓦片內容的邊界體積。
options.debugShowViewerRequestVolume `Boolean` default `false`	僅用于調試。如果為true，則為每個瓦片呈現查看器請求卷。
options.debugShowGeometricError `Boolean` default `false`	僅用于調試。如果為真，則繪制標簽以指示每個瓦片的幾何錯誤。
options.debugShowRenderingStatistics `Boolean` default `false`	僅用于調試。如果為真，則繪制標簽以指示每個瓦片的命令、點、三角形和特征的數量。
options.debugShowMemoryUsage `Boolean` default `false`	僅用于調試。如果為真，則繪制標簽以指示每個瓦片使用的紋理和幾何內存（兆字節）。
options.debugShowUrl `Boolean` default `false`	僅用于調試。如果為true，則繪制標簽以指示每個瓦片的URL。

Examples

var tileset = scene.primitives.add(new bmgl.BM3DTileset({
     url : 'http://localhost:8002/tilesets/Seattle/tileset.json'
}));

// Common setting for the skipLevelOfDetail optimization
var tileset = scene.primitives.add(new bmgl.BM3DTileset({
     url : 'http://localhost:8002/tilesets/Seattle/tileset.json',
     skipLevelOfDetail : true,
     baseScreenSpaceError : 1024,
     skipScreenSpaceErrorFactor : 16,
     skipLevels : 1,
     immediatelyLoadDesiredLevelOfDetail : false,
     loadSiblings : false,
     cullWithChildrenBounds : true
}));

// Common settings for the dynamicScreenSpaceError optimization
var tileset = scene.primitives.add(new bmgl.BM3DTileset({
     url : 'http://localhost:8002/tilesets/Seattle/tileset.json',
     dynamicScreenSpaceError : true,
     dynamicScreenSpaceErrorDensity : 0.00278,
     dynamicScreenSpaceErrorFactor : 4.0,
     dynamicScreenSpaceErrorHeightFalloff : 0.25
}));

Throws

DeveloperError : tileset必須是0.0或1.0版的3D平鋪。

See:

3D Tiles specification

Members

allTilesLoaded : Event

觸發的事件指示已加載滿足此幀的屏幕空間錯誤的所有磁貼。此視圖的tileset已完全加載。

此事件在渲染場景后在幀的末尾觸發。

Default Value: new Event()

See:

BM3DTileset#tilesLoaded

Example:

tileset.allTilesLoaded.addEventListener(function() {
    console.log('All tiles are loaded');
});

(readonly) asset : Object

獲取tileset的資源對象屬性，該屬性包含有關tileset的元數據。

請參閱3D瓦片規格中的asset schema reference了解完整的屬性集。

(readonly) basePath : String

tileset json文件中非絕對路徑相對于的基本路徑。

Deprecated: true

baseScreenSpaceError : Number

跳過詳細級別之前必須達到的屏幕空間錯誤。

僅在BM3DTileset#skipLevelOfDetail為true時使用。

Default Value: 1024

(readonly) boundingSphere : BoundingSphere

Tileset的邊界球。

Example:

var tileset = viewer.scene.primitives.add(new bmgl.BM3DTileset({
    url : 'http://localhost:8002/tilesets/Seattle/tileset.json'
}));

tileset.readyPromise.then(function(tileset) {
    // Set the camera to view the newly added tileset
    viewer.camera.viewBoundingSphere(tileset.boundingSphere, new bmgl.HeadingPitchRange(0, -0.5, 0));
});

(readonly) classificationType : ClassificationType

確定地形、三維瓦片或兩者都將按此瓦片集分類。

此選項僅適用于包含成批3D模型、幾何數據或矢量數據的數據集。即使未定義，矢量數據和幾何數據也必須渲染為分類，并且默認在地形和其他3D瓦片瓦片集上渲染。

當為批處理的3D模型平鋪集啟用時，對GLTF有一些要求/限制：

位置和{批處理ID語義是必需的。
具有相同批處理ID的所有索引都必須占用索引緩沖區的連續部分。
忽略所有著色器和技術。生成的明暗器只需將位置乘以模型視圖投影矩陣。
唯一支持的擴展名是bmgl{rtc和web3d{量化{屬性。
只支持一個節點。
每個節點僅支持一個網格。
每個網格僅支持一個基元。

Default Value: undefined

Experimental

This feature is using part of the 3D Tiles spec that is not final and is subject to change without BM's standard deprecation policy.

clippingPlanes : ClippingPlaneCollection

ClippingPlaneCollection用于選擇性地禁用呈現tileset。

colorBlendAmount : Number

定義當BM3DTileset#colorBlendMode為MIX時用于在源顏色和要素顏色之間進行線性插值的值。值為0.0將生成源顏色，值為1.0將生成功能顏色，其中任何值之間的值將導致源顏色和功能顏色的混合。

Default Value: 0.5

colorBlendMode : BM3DTileColorBlendMode

定義從BMAPI或聲明性樣式設置的每個要素顏色如何與原始要素的源顏色（例如gltf材質或瓦片中的每個點顏色）混合。

Default Value: BM3DTileColorBlendMode.HIGHLIGHT

cullRequestsWhileMoving : Boolean

優化選項。不要請求可能因為相機的移動而返回時未使用的磁貼。

Default Value: true

cullRequestsWhileMovingMultiplier : Number

優化選項。移動時剔除請求時使用的乘數。較大的是更具侵略性的剔除，較小的是不具侵略性的剔除。

Default Value: 60.0

debugColorizeTiles : Boolean

此屬性僅用于調試；它不是為生產使用而優化的。

為真時，為每個瓦片指定隨機顏色。這對于可視化哪些功能屬于哪些瓦片很有用，特別是在父瓦片的功能可能與子瓦片的功能交錯的情況下，使用附加優化。

Default Value: false

debugFreezeFrame : Boolean

此屬性僅用于調試；它不是為生產使用而優化的。

確定是否只應使用最后一幀的瓦片進行渲染。這會有效地將tileset“凍結”到上一幀，以便可以縮小并查看渲染的內容。

Default Value: false

debugShowBoundingVolume : Boolean

此屬性僅用于調試；它不是為生產使用而優化的。

如果為真，則渲染每個可見瓦片的邊界體積。如果瓦片具有內容邊界體積或為空，則邊界體積為白色；否則，它為紅色。不符合屏幕空間錯誤并且仍在細化到其后代的瓦片是黃色的。

Default Value: false

debugShowContentBoundingVolume : Boolean

此屬性僅用于調試；它不是為生產使用而優化的。

如果為真，則渲染每個可見瓦片內容的邊界體積。如果瓦片具有內容邊界體積，則邊界體積為藍色；否則為紅色。

Default Value: false

debugShowGeometricError : Boolean

此屬性僅用于調試；它不是為生產使用而優化的。

為真時，繪制標簽以指示每個瓦片的幾何誤差。

Default Value: false

debugShowMemoryUsage : Boolean

此屬性僅用于調試；它不是為生產使用而優化的。

為真時，繪制標簽以指示每個瓦片的幾何圖形和紋理內存使用情況。

Default Value: false

debugShowRenderingStatistics : Boolean

此屬性僅用于調試；它不是為生產使用而優化的。

為真時，繪制標簽以指示每個瓦片的命令、點、三角形和特征的數量。

Default Value: false

debugShowUrl : Boolean

此屬性僅用于調試；它不是為生產使用而優化的。

為真時，繪制標簽以指示每個瓦片的URL。

Default Value: false

debugShowViewerRequestVolume : Boolean

此屬性僅用于調試；它不是為生產使用而優化的。

如果為真，則為每個瓦片呈現查看器請求量。

Default Value: false

debugWireframe : Boolean

此屬性僅用于調試；它不是為生產使用而優化的。

如果為真，則將每個瓦片的內容呈現為線框。

Default Value: false

dynamicScreenSpaceError : Boolean

優化選項。Tileset是否應根據動態屏幕空間錯誤進行優化。較遠的瓦片將比較近的瓦片以較低的細節進行渲染。這可以通過渲染較少的瓦片和發出較少的請求來提高性能，但可能會導致遠處瓦片的視覺質量略有下降。該算法偏向于“街景”，即攝像機靠近蒂勒塞特的地平面并注視地平線。此外，對于框和區域等緊密擬合的邊界體積，結果更準確。

Default Value: false

dynamicScreenSpaceErrorDensity : Number

確定用于調整動態屏幕空間錯誤的密度的標量，類似于Fog。增加該值會增加所有瓦片的最大屏幕空間誤差，但會以非線性方式增加。誤差從0.0開始呈指數增長，直到達到中點，然后漸進地接近1.0。這有一種效果，即在較近的瓦片中保持較高的細節，而在較遠的瓦片中保持較低的細節，所有瓦片超過一定距離，其誤差大致為1.0。

動態誤差在[0.0，1.0]范圍內，并乘以dynamicScreenSpaceErrorFactor產生最終動態誤差。然后，從瓦片的實際屏幕空間錯誤中減去該動態錯誤。

遞增dynamicScreenSpaceErrorDensity具有將誤差中點移近相機的效果。它類似于將霧移近攝像機。

Default Value: 0.00278

dynamicScreenSpaceErrorFactor : Number

一種用于增加動態屏幕空間誤差的塊的屏幕空間誤差的因子。隨著此值的增加，渲染所需的瓦片將減少，并且距離中的瓦片的細節也將降低。如果設置為零，功能將被禁用。

Default Value: 4.0

dynamicScreenSpaceErrorHeightFalloff : Number

密度開始下降時的蒂勒塞特高度的比率。如果相機低于此高度，將應用完全計算的密度，否則密度將下降。這在街景上具有更高密度的效果。

有效值介于0.0和1.0之間。

Default Value: 0.25

(readonly) ellipsoid : Ellipsoid

獲取描述球體形狀的橢球體。

(readonly) extras : *

返回tileset json頂層的extras屬性，該屬性包含特定于應用程序的元數據。如果不存在，則返回undefined。

See:

Extras in the 3D Tiles specification.

foveatedConeSize : Number

優化選項。當BM3DTileset#foveatedScreenSpaceError為真時使用，以控制用于確定延遲的瓦片的圓錐體大小。此圓錐體內的瓦片將立即加載。錐體外的瓦片可能會根據它們在錐體外的距離和BM3DTileset#foveatedInterpolationCallback和BM3DTileset#foveatedMinimumScreenSpaceErrorRelaxation延遲。將此值設置為0.0表示圓錐體將是由相機位置及其視圖方向形成的線。將其設置為1.0意味著圓錐體包含相機的整個視場，基本上禁用了效果。

Default Value: 0.3

foveatedInterpolationCallback : BM3DTileset~foveatedInterpolationCallback

獲取一個函數，該函數將更新瓦片的中心屏幕空間錯誤。

foveatedMinimumScreenSpaceErrorRelaxation : Number

優化選項。當BM3DTileset#foveatedScreenSpaceError為真時，用于控制凹錐外瓦片的起始屏幕空間誤差松弛。屏幕空間錯誤將根據提供的BM3DTileset#foveatedInterpolationCallback從該值開始升高到BM3DTileset#maximumScreenSpaceError。

Default Value: 0.0

foveatedScreenSpaceError : Boolean

優化選項。通過臨時提高屏幕邊緣周圍的瓦片的屏幕空間錯誤，將在屏幕中心加載瓦片的優先級排序。加載BM3DTileset#foveatedConeSize所確定的屏幕中心的所有磁貼后，屏幕空間錯誤恢復正常。

Default Value: true

foveatedTimeDelay : Number

優化選項。當BM3DTileset#foveatedScreenSpaceError為真時使用，以秒為單位控制延遲瓦片開始加載之前相機停止移動后的等待時間。此時間延遲可防止攝像機移動時在屏幕邊緣周圍請求平鋪。將此設置為0.0將立即請求任何給定視圖中的所有瓦片。

Default Value: 0.2

imageBasedLightingFactor : Cartesian2

BMGL增加了來自地球、天空、大氣和星空盒的照明。該笛卡爾坐標用于將這些源的最終漫反射和鏡面照明貢獻縮放為最終顏色。值為0.0將禁用這些光源。

Default Value: Cartesian2(1.0, 1.0)

immediatelyLoadDesiredLevelOfDetail : Boolean

如果為真，則只下載滿足最大屏幕空間錯誤的磁貼。跳過因子被忽略，只加載所需的瓦片。

僅在BM3DTileset#skipLevelOfDetail為true時使用。

Default Value: false

initialTilesLoaded : Event

觸發的事件指示已加載滿足此幀的屏幕空間錯誤的所有磁貼。當加載初始視圖中的所有瓦片時，將觸發一次此事件。

此事件在渲染場景后在幀的末尾觸發。

Default Value: new Event()

See:

BM3DTileset#allTilesLoaded

Example:

tileset.initialTilesLoaded.addEventListener(function() {
    console.log('Initial tiles are loaded');
});

lightColor : Cartesian3

用來給模型加陰影的陽光的顏色和強度。

例如，通過設置model.imageBasedLightingFactor = new Cartesian2(0.0, 0.0)禁用其他光源將使模型更暗。在這里，增加光源的強度將使模型更亮。

Default Value: undefined

loadProgress : Event

為指示加載新瓦片的進度而觸發的事件。當請求新瓦片、請求的瓦片下載完成以及已處理下載的瓦片并準備好呈現時，將觸發此事件。

掛起的瓦片請求數numberOfPendingRequests和瓦片處理數numberOfTilesProcessing傳遞給事件偵聽器。

此事件在場景渲染后在幀的末尾觸發。

Default Value: new Event()

Example:

tileset.loadProgress.addEventListener(function(numberOfPendingRequests, numberOfTilesProcessing) {
    if ((numberOfPendingRequests === 0) && (numberOfTilesProcessing === 0)) {
        console.log('Stopped loading');
        return;
    }

    console.log('Loading: requests: ' + numberOfPendingRequests + ', processing: ' + numberOfTilesProcessing);
});

loadSiblings : Boolean

確定遍歷期間是否始終下載可見平鋪的同級。這可能有助于確保在查看器向左/向右旋轉時瓦片已經可用。

僅在BM3DTileset#skipLevelOfDetail為true時使用。

Default Value: false

luminanceAtZenith : Number

太陽在天頂的亮度，單位為千克燭光每平方米，用于此模型的程序環境地圖。未定義BM3DTileset#specularEnvironmentMaps和BM3DTileset#sphericalHarmonicCoefficients時使用。

Default Value: 0.2

maximumMemoryUsage : Number

可用于緩存磁貼的最大GPU內存量（以MB為單位）。該值是根據加載的瓦片的幾何體、紋理和批處理表紋理估計的。對于點云，該值還包括每個點的元數據。

未在視圖中的瓦片將卸載以強制執行此操作。

如果減小該值會導致卸載瓦片，則會在下一幀卸載瓦片。

如果需要尺寸大于maximumMemoryUsage的磁貼來滿足由BM3DTileset#maximumScreenSpaceError確定的所需屏幕空間錯誤，對于當前視圖，則加載磁貼的內存使用將超過maximumMemoryUsage。例如，如果最大值為256 MB，但需要300 MB的磁貼來滿足屏幕空間錯誤，則可以加載300 MB的磁貼。當這些瓦片離開視野時，它們將被卸載。

Default Value: 512

See:

BM3DTileset#totalMemoryUsageInBytes

maximumScreenSpaceError : Number

用于驅動細節細化級別的最大屏幕空間錯誤。此值有助于確定瓦片何時細化為其后代，因此在平衡性能和視覺質量方面起主要作用。瓦片的屏幕空間誤差大致等于如果在瓦片位置渲染半徑等于瓦片的幾何誤差的球體時將繪制的像素寬度。如果此值超過maximumScreenSpaceError，則瓦片將細化為其后代。

取決于Tileset，maximumScreenSpaceError可能需要進行調整以實現正確的平衡。較高的值提供更好的性能，但視覺質量較低。

Default Value: 16

modelMatrix : Matrix4

轉換整個tileset的4x4轉換矩陣。

Default Value: Matrix4.IDENTITY

Example:

// Adjust a tileset's height from the globe's surface.
var heightOffset = 20.0;
var boundingSphere = tileset.boundingSphere;
var cartographic = bmgl.Cartographic.fromCartesian(boundingSphere.center);
var surface = bmgl.Cartesian3.fromRadians(cartographic.longitude, cartographic.latitude, 0.0);
var offset = bmgl.Cartesian3.fromRadians(cartographic.longitude, cartographic.latitude, heightOffset);
var translation = bmgl.Cartesian3.subtract(offset, surface, new bmgl.Cartesian3());
tileset.modelMatrix = bmgl.Matrix4.fromTranslation(translation);

pointCloudShading : PointCloudShading

基于幾何誤差和眼罩照明控制點大小的選項。

preferLeaves : Boolean

優化選項。最好先裝樹葉。

Default Value: false

preloadFlightDestinations : Boolean

優化選項。當相機在飛行中時，在相機的飛行目的地取瓦片。

Default Value: true

preloadWhenHidden : Boolean

當tileset.show為false時預加載瓦片。加載瓦片，就像瓦片集可見但不呈現它們一樣。

Default Value: false

progressiveResolutionHeightFraction : Number

優化選項。如果介于（0.0，0.5）之間，將首先優先考慮降低屏幕分辨率progressiveResolutionHeightFraction*screenHeight的屏幕空間誤差或高于該誤差的瓦片。這有助于在繼續加載全分辨率磁貼時快速放下磁貼層。

Default Value: 0.3

(readonly) properties : Object

獲取Tileset的屬性字典對象，該對象包含有關每個功能屬性的元數據。

請參閱3D瓦片規格中的properties schema reference了解完整的屬性集。

See:

Example:

console.log('Maximum building height: ' + tileset.properties.height.maximum);
console.log('Minimum building height: ' + tileset.properties.height.minimum);

(readonly) ready : Boolean

當true時，將加載tileset的根瓦片，并準備渲染tileset。這將設置為true在BM3DTileset#readyPromise解決之前。

Default Value: false

(readonly) readyPromise : Promise.<BM3DTileset>

獲取在加載tileset的根瓦片并且tileset準備好呈現時將解決的承諾。

此承諾在第一幀中呈現Tileset之前在幀的末尾解決。

Example:

tileset.readyPromise.then(function(tileset) {
    // tile.properties is not defined until readyPromise resolves.
    var properties = tileset.properties;
    if (bmgl.defined(properties)) {
        for (var name in properties) {
            console.log(properties[name]);
        }
    }
});

(readonly) root : BM3DTile

根瓦片。

shadows : ShadowMode

確定tileset是投射還是接收來自每個光源的陰影。

啟用陰影會影響性能。投射陰影的平鋪集必須渲染兩次，一次從相機渲染，一次從燈光渲染。

陰影僅在Viewer#shadows為true時呈現。

Default Value: ShadowMode.ENABLED

show : Boolean

確定是否顯示顎化集。

Default Value: true

skipLevelOfDetail : Boolean

優化選項。確定遍歷期間是否應應用細節級別跳過。

替換優化遍歷的常見策略是將樹的所有級別存儲在內存中，并要求在父級可以優化之前加載所有子級。通過這種優化，可以完全跳過樹的級別，并且可以將孩子與父母一起呈現。使用此優化時，tileset需要的內存顯著減少。

Default Value: true

skipLevels : Number

常量定義加載瓦片時要跳過的最小級別數。為0時，不跳過任何級別。例如，如果瓦片是級別1，則不會加載任何瓦片，除非其級別大于2。

僅在BM3DTileset#skipLevelOfDetail為true時使用。

Default Value: 1

skipScreenSpaceErrorFactor : Number

乘數定義要跳過的最小屏幕空間錯誤。例如，如果瓦片的屏幕空間錯誤為100，則不會加載任何瓦片，除非它們是葉或屏幕空間錯誤<= 100 / skipScreenSpaceErrorFactor。

僅在BM3DTileset#skipLevelOfDetail為true時使用。

Default Value: 16

specularEnvironmentMaps : String

KTX文件的一個URL，其中包含鏡面照明和卷積鏡面mipmap的立方體映射。

See:

BM3DTileset#sphericalHarmonicCoefficients

sphericalHarmonicCoefficients : Array.<Cartesian3>

用于基于圖像的照明的漫反射顏色的三階球諧系數。當undefined時，使用根據大氣顏色計算的漫射輻照度。

有九個Cartesian3系數。系數的順序為：L ₀₀，L _1-1，L ₁₀，L ₁₁，L _2-2，L _2-1，L ₂₀，L ₂₁，L ₂₂

這些值可以通過使用的cmgen工具預處理環境圖來獲得。這還將生成可提供給 BM3DTileset#specularEnvironmentMaps的KTX文件。

style : BM3DTileStyle

使用3D Tiles Styling language定義的樣式應用于瓦片集中的每個要素。

分配undefined刪除樣式，這將在未應用樣式時將瓦片集的視覺外觀恢復為其默認值。

在引發BM3DTileset#tileVisible事件之前將樣式應用于瓦片，因此tileVisible中的代碼可以在應用樣式后手動設置要素的適當關系（例如顏色和顯示）。分配新樣式后，任何手動設置的屬性都會被覆蓋。

Default Value: undefined

See:

3D Tiles Styling language

Example:

tileset.style = new bmgl.BM3DTileStyle({
   color : {
       conditions : [
           ['${Height} >= 100', 'color("purple", 0.5)'],
           ['${Height} >= 50', 'color("red")'],
           ['true', 'color("blue")']
       ]
   },
   show : '${Height} > 0',
   meta : {
       description : '"Building id ${id} has height ${Height}."'
   }
});

tileFailed : Event

觸發的事件指示未能加載瓦片的內容。

如果沒有事件監聽器，錯誤消息將記錄到控制臺。

傳遞給偵聽器的錯誤對象包含兩個屬性：

url：失敗瓦片的URL。
message：錯誤消息。

Default Value: new Event()

Example:

tileset.tileFailed.addEventListener(function(error) {
    console.log('An error occurred loading tile: ' + error.url);
    console.log('Error: ' + error.message);
});

tileLoad : Event

觸發的事件指示已加載瓦片的內容。

將加載的BM3DTile傳遞給事件偵聽器。

此事件在渲染幀時在tileset遍歷期間觸發，以便對瓦片的更新在同一幀中生效。不要在事件偵聽器期間創建或修改BMGL實體或基元。

Default Value: new Event()

Example:

tileset.tileLoad.addEventListener(function(tile) {
    console.log('A tile was loaded.');
});

(readonly) tilesLoaded : Boolean

當true時，將加載滿足屏幕空間錯誤的所有瓦片。此視圖的tileset已完全加載。

Default Value: false

See:

BM3DTileset#allTilesLoaded

tileUnload : Event

該事件觸發以指示瓦片的內容已卸載。

已卸載的BM3DTile被傳遞到事件偵聽器。

渲染幀時，將在瓦片的內容被卸載之前立即觸發此事件，以便事件偵聽器可以訪問瓦片的內容。在事件偵聽器期間，請勿創建或修改實體或原語。

Default Value: new Event()

See:

Example:

tileset.tileUnload.addEventListener(function(tile) {
    console.log('A tile was unloaded from the cache.');
});

tileVisible : Event

此事件對幀中的每個可見瓦片觸發一次。這可用于手動設置tileset的樣式。

可見BM3DTile傳遞給事件偵聽器。

此事件在渲染幀時在tileset遍歷期間觸發，以便對瓦片的更新在同一幀中生效。不要在事件偵聽器期間創建或修改BMGL實體或基元。

Default Value: new Event()

Examples:

tileset.tileVisible.addEventListener(function(tile) {
    if (tile.content instanceof bmgl.Batched3DModel3DTileContent) {
        console.log('A Batched 3D Model tile is visible.');
    }
});

// Apply a red style and then manually set random colors for every other feature when the tile becomes visible.
tileset.style = new bmgl.BM3DTileStyle({
    color : 'color("red")'
});
tileset.tileVisible.addEventListener(function(tile) {
    var content = tile.content;
    var featuresLength = content.featuresLength;
    for (var i = 0; i < featuresLength; i+=2) {
        content.getFeature(i).color = bmgl.Color.fromRandom();
    }
});

(readonly) timeSinceLoad : Number

返回自加載并首次更新tileset以來的時間（以毫秒為單位）。

(readonly) totalMemoryUsageInBytes : Number

tileset使用的GPU內存總量（字節）。此值是根據加載的瓦片的幾何體、紋理和批處理表紋理估計的。對于點云，該值還包括每個點的元數據。

See:

BM3DTileset#maximumMemoryUsage

(readonly) url : String

tileset json文件的URL。

Methods

(static) loadJson(tilesetUrl) → {Promise.<Object>}

提供一個鉤子來重寫從遠程服務器獲取tileset時用于請求tileset json的方法。

Parameters:

tilesetUrl ((Resource | String)) 要獲取的JSON文件的URL

destroy()

銷毀此對象持有的WebGL資源。銷毀對象允許確定地釋放WebGL資源，而不是依賴垃圾收集器來銷毀此對象。

一旦對象被破壞，就不應使用它；調用除isDestroyed以外的任何函數都將導致DeveloperError異常。因此，將返回值（undefined）賦給對象，如示例中所述。

Example

tileset = tileset && tileset.destroy();

Throws

DeveloperError : 此對象已被銷毀，即調用destroy（）。

See:

BM3DTileset#isDestroyed

hasExtension(extensionName) → {Boolean}

true如果tileset json文件列出了所用擴展名中的擴展名；否則，false。

Parameters:

extensionName (String) 要檢查的擴展名。

isDestroyed() → {Boolean}

如果此對象被破壞，則返回true；否則返回false。

如果此對象被破壞，則不應使用它；調用除isDestroyed以外的任何函數將導致DeveloperError異常。

See:

BM3DTileset#destroy

makeStyleDirty()

將tileset的BM3DTileset#style標記為臟，這將強制所有功能重新評估下一幀中的樣式，每個都可見。

trimLoadedTiles()

卸載上一幀中未選擇的所有磁貼。這可以用于顯式管理瓦片緩存，并將加載的瓦片總數減少到BM3DTileset#maximumMemoryUsage以下。

下一幀將發生Tile卸載，以將所有WebGL刪除調用保留在呈現循環中。

Type Definitions

foveatedInterpolationCallback(p, q, time) → {Number}

優化選項。當BM3DTileset#foveatedScreenSpaceError為真時用作回調，以控制在BM3DTileset#foveatedMinimumScreenSpaceErrorRelaxation和BM3DTileset#maximumScreenSpaceError之間插入的中央凹錐體外的貼片的屏幕空間錯誤增加多少。

Parameters:

p (Number) 要插入的起始值。

q (Number) 要插入的結束值。

time (Number) 插值時間一般在[0.0, 1.0]范圍內。

Default Value: Math.lerp