虛擬場景中所有3D圖形對象和狀態(tài)的容器。 通常，場景不是直接創(chuàng)建的。 而是由
new Scene(options)
BMWidget隱式創(chuàng)建。 contextOptions參數(shù)詳細信息：
默認值為：
{
webgl : {
alpha : false,
depth : true,
stencil : false,
antialias : true,
premultipliedAlpha : true,
preserveDrawingBuffer : false,
failIfMajorPerformanceCaveat : false
},
allowTextureFilterAnisotropic : true
}
webgl屬性對應于用于創(chuàng)建的WebGLContextAttributes對象 WebGL上下文。
webgl.alpha的默認值為false，與標準的WebGL默認值為true相比，可以提高性能。 如果應用程序需要使用alpha混合在其他HTML元素上方合成，請將webgl.alpha設置為true。
其他webgl屬性與WebGLContextAttributes的WebGL默認值匹配。
allowTextureFilterAnisotropic的默認值為true，當支持WebGL擴展時，它將啟用各向異性紋理過濾。 將其設置為false將提高性能，但會損害視覺質量，尤其是對于地平線視圖。
Parameters:
options
(Object)
| Name | Description |
|---|---|
options.canvas
Canvas
|
要為其創(chuàng)建場景的HTML畫布元素。 |
options.contextOptions
Object
|
上下文和WebGL創(chuàng)建屬性。詳見上文。 |
options.creditContainer
Element
|
顯示學分的HTML元素。 |
options.creditViewport
Element
|
顯示信用彈出窗口的HTML元素。如果未指定，則視區(qū)將作為畫布的同級添加。 |
options.mapProjection
MapProjection
default new GeographicProjection()
|
要在二維和哥倫布視圖模式中使用的地圖投影。 |
options.orderIndependentTranslucency
Boolean
default true
|
如果為true，并且配置支持它，則使用與順序無關的半透明。 |
options.scene3DOnly
Boolean
default false
|
如果為真，則優(yōu)化3D模式的內存使用和性能，但禁用使用二維或哥倫布視圖的功能。 |
options.terrainExaggeration
Number
default 1.0
|
用于放大地形的標量。請注意，地形放大不會修改任何其他基本體，因為它們是相對于橢球體定位的。 |
options.shadows
Boolean
default false
|
確定陰影是否由太陽投射。 |
options.mapMode2D
MapMode2D
default MapMode2D.INFINITE_SCROLL
|
確定二維地圖是可旋轉的還是可以沿水平方向無限滾動。 |
options.requestRenderMode
Boolean
default false
|
如果為“真”，則僅在場景中的更改決定需要時才會渲染幀。啟用可以提高應用程序的性能，但需要使用Scene#requestRender在此模式下顯式呈現(xiàn)新幀。在許多情況下，在對API其他部分中的場景進行更改之后，這是必需的。
|
options.maximumRenderTimeChange
Number
default 0.0
|
如果requestrendermode為true，則此值定義請求呈現(xiàn)之前允許的模擬時間的最大更改。 |
Example
// Create scene without anisotropic texture filtering
var scene = new bmgl.Scene({
canvas : canvas,
contextOptions : {
allowTextureFilterAnisotropic : false
}
});Throws
-
DeveloperError : 選項和選項.canvas是必需的。
Members
backgroundColor : Color
背景色，只有在沒有天空框時才可見，即
Scene#skyBox未定義。
-
Default Value:
Color.BLACKSee:
(readonly) camera : Camera
獲取或設置照相機。
(readonly) canvas : Canvas
獲取此場景綁定到的畫布元素。
(readonly) clampToHeightSupported : Boolean
completeMorphOnUserInput : Boolean
確定是否在用戶輸入時立即完成場景轉換動畫。
-
Default Value:
true
debugCommandFilter : function
此屬性僅用于調試；不用于生產。
確定執(zhí)行哪些命令的函數(shù)。如下面的示例所示，函數(shù)接收命令的owner作為參數(shù)，并返回一個布爾值，指示是否應執(zhí)行命令。
默認為undefined，表示執(zhí)行所有命令。
-
Default Value:
undefined
Example:
// Do not execute any commands.
scene.debugCommandFilter = function(command) {
return false;
};
// Execute only the billboard's commands. That is, only draw the billboard.
var billboards = new bmgl.BillboardCollection();
scene.debugCommandFilter = function(command) {
return command.owner === billboards;
};(readonly) debugFrustumStatistics : Object
此屬性僅用于調試；不用于生產。
當Scene.debugShowFrustums為true時，這包含屬性，統(tǒng)計每個截錐執(zhí)行的命令數(shù)。totalCommands是執(zhí)行的命令總數(shù)，忽略重疊。commandsInFrustums是一個具有重復執(zhí)行命令次數(shù)的數(shù)組，例如，有多少命令與兩個或三個截錐重疊。
-
Default Value:
undefined
debugShowCommands : Boolean
此屬性僅用于調試；不用于生產。
當true時，命令隨機著色。這對于性能分析很有用，可以查看場景或模型的哪些部分是命令密集的，并且可以從批處理中受益。
-
Default Value:
false
debugShowDepthFrustum : Number
此屬性僅用于調試；不用于生產。
表示哪個截錐將顯示深度信息。
-
Default Value:
1
debugShowFramesPerSecond : Boolean
此屬性僅用于調試；不用于生產。
顯示每秒幀數(shù)和幀之間的時間。
-
Default Value:
false
debugShowFrustumPlanes : Boolean
此屬性僅用于調試；不用于生產。
當true時，繪制輪廓以顯示相機截錐的邊界
-
Default Value:
false
debugShowFrustums : Boolean
此屬性僅用于調試；不用于生產。
當true時，命令將根據(jù)它們重疊的截錐體進行著色。最近截錐體中的命令為紅色，下一個最近截錐體中的命令為綠色，最遠截錐體中的命令為藍色。如果一個命令與多個截錐重疊，則組合顏色組件，例如，與前兩個截錐重疊的命令為黃色。
-
Default Value:
false
debugShowGlobeDepth : Boolean
此屬性僅用于調試；不用于生產。
顯示所示截錐的深度信息。
-
Default Value:
false
(readonly) drawingBufferHeight : Number
基礎GL上下文的DrawingBufferHeight。
See:
(readonly) drawingBufferWidth : Number
基礎GL上下文的DrawingBufferHeight。
See:
eyeSeparation : Number
與紙板或WebVR一起使用的眼睛間隔距離（米）。
farToNearRatio : Number
多截錐在使用普通深度緩沖器時的遠近比。
該值用于為多個截錐體的每個截錐體創(chuàng)建近、遠值。僅當Scene#logarithmicDepthBuffer為false時使用。當logarithmicDepthBuffer為true時，使用Scene#logarithmicDepthFarToNearRatio。
-
Default Value:
1000.0
focalLength : Number
用于硬紙板或WebVR時的焦距。
fog : Fog
將大氣與遠離相機的幾何體混合以獲得地平線視圖。允許通過渲染較少的幾何圖形和調度較少的地形請求來提高性能。
gamma : Number
用于伽瑪校正的值。這僅在使用高動態(tài)范圍渲染時使用。
-
Default Value:
2.2
globe : Globe
獲取或設置深度測試橢球體。
(readonly) groundPrimitives : PrimitiveCollection
獲取基本體的集合。
highDynamicRange : Boolean
是否使用高動態(tài)范圍渲染。
-
Default Value:
true
highDynamicRangeSupported : Boolean
是否支持高動態(tài)范圍渲染。
-
Default Value:
true
(readonly) id : String
獲取此場景的唯一標識符。
(readonly) imageryLayers : ImageryLayerCollection
獲取將在地球儀上呈現(xiàn)的圖像層的集合。
imagerySplitPosition : Number
獲取或設置圖像拆分器在視區(qū)中的位置。有效值介于0.0和1.0之間。
invertClassification : Boolean
當
false時，3D瓦片將正常呈現(xiàn)。當true時，分類的3D瓦片幾何體將正常呈現(xiàn)，而非分類的3D瓦片幾何體將以乘以Scene#invertClassificationColor的顏色呈現(xiàn)。
-
Default Value:
false
invertClassificationColor : Color
當
Scene#invertClassification為true時，未分類的3D瓦片幾何體的突出顯示顏色。當顏色的alpha小于1.0時，3D瓦片的未分類部分將無法與3D瓦片的分類位置正確混合。
{此外，當顏色的alpha小于1.0時，必須支持WebGL{深度{紋理和擴展{深度WebGL擴展。
-
Default Value:
Color.WHITE
(readonly) invertClassificationSupported : Boolean
如果支持
Scene#invertClassification，則返回true。
(readonly) lastRenderTime : JulianDate
獲取上次呈現(xiàn)場景時的模擬時間。如果尚未渲染場景，則返回未定義。
logarithmicDepthBuffer : Boolean
是否使用對數(shù)深度緩沖區(qū)。啟用此選項將允許在多個截錐中減少截錐，從而提高性能。此屬性依賴于支持的FragmentDepth。
logarithmicDepthFarToNearRatio : Number
使用對數(shù)深度緩沖器時多截錐的遠近比。
該值用于為多個截錐體的每個截錐體創(chuàng)建近、遠值。僅當Scene#logarithmicDepthBuffer為true時使用。當logarithmicDepthBuffer為false時，使用Scene#farToNearRatio。
-
Default Value:
1e9
mapMode2D : MapMode2D
確定二維地圖是可旋轉的還是可以沿水平方向無限滾動。
(readonly) mapProjection : MapProjection
獲取要在二維和哥倫布視圖模式中使用的地圖投影。
-
Default Value:
new GeographicProjection()
(readonly) maximumAliasedLineWidth : Number
此WebGL實現(xiàn)支持的最大混疊線條寬度（以像素為單位）。它至少是一個。
- glGet with
ALIASED_LINE_WIDTH_RANGE.
See:
(readonly) maximumCubeMapSize : Number
此WebGL實現(xiàn)支持的多維數(shù)據(jù)集映射的一條邊的最大長度（以像素為單位）。至少16歲。
- glGet with
GL_MAX_CUBE_MAP_TEXTURE_SIZE.
See:
maximumRenderTimeChange : Number
如果
Scene#requestRenderMode為true，則此值定義請求渲染之前允許的模擬時間的最大更改。值越小，渲染的幀數(shù)越多，值越大，渲染的幀數(shù)越少。如果undefined，對模擬時間的更改將永遠不會請求渲染。此值會影響場景中更改（如照明、實體屬性更新和動畫）的渲染速率。
-
Default Value:
0.5
See:
minimumDisableDepthTestDistance : Number
從相機到禁止對廣告牌、標簽和點進行深度測試的距離，例如，防止對地形進行剪切。當設置為零時，應始終應用深度測試。當小于零時，不得進行深度測試。設置公告牌、標簽或點的DisableDepthTestDistance屬性將覆蓋此值。
-
Default Value:
0.0
mode : SceneMode
獲取或設置場景的當前模式。
-
Default Value:
SceneMode.SCENE3Dmoon : Moon
-
Default Value:
undefined
morphComplete : Event
在完成場景轉換時觸發(fā)的事件。
-
Default Value:
Event()
morphStart : Event
在場景轉換開始時觸發(fā)的事件。
-
Default Value:
Event()
morphTime : Number
當前在二維/哥倫布視圖和三維之間的變形過渡時間，0.0表示二維或哥倫布視圖，1.0表示三維。
-
Default Value:
1.0
nearToFarDistance2D : Number
確定二維中多銹體的每個截錐的均勻深度大?。ㄒ悦诪閱挝唬?。如果靠近表面的原始體或模型顯示Z形戰(zhàn)斗，則減小此值將消除偽影，但會降低性能。另一方面，增加該值將提高性能，但可能導致靠近曲面的基本體之間發(fā)生Z-沖突。
-
Default Value:
1.75e6
(readonly) orderIndependentTranslucency : Boolean
獲取場景是否啟用了順序獨立半透明。請注意，這只反映了最初的構建選項，還有其他因素可能會阻止OIT在給定的系統(tǒng)配置上運行。
(readonly) pickPositionSupported : Boolean
如果支持
Scene#pickPosition函數(shù)，則返回true。
See:
pickTranslucentDepth : Boolean
當
true時，啟用使用深度緩沖區(qū)拾取半透明幾何體。請注意，Scene#useDepthPicking也必須為真，才能使其工作。渲染必須在拾取之間調用。
啟用時性能會降低。有額外的繪圖調用來寫入半透明幾何體的深度。
-
Default Value:
false
Example:
// picking the position of a translucent primitive
viewer.screenSpaceEventHandler.setInputAction(function onLeftClick(movement) {
var pickedFeature = viewer.scene.pick(movement.position);
if (!bmgl.defined(pickedFeature)) {
// nothing picked
return;
}
viewer.scene.render();
var worldPosition = viewer.scene.pickPosition(movement.position);
}, bmgl.ScreenSpaceEventType.LEFT_CLICK);postProcessStages : PostProcessStageCollection
應用于最終渲染的后期處理效果。
(readonly) postRender : Event
獲取將在呈現(xiàn)場景后立即引發(fā)的事件。事件的訂閱服務器接收場景實例作為第一個參數(shù)，當前時間作為第二個參數(shù)。
(readonly) postUpdate : Event
獲取將在場景更新后和渲染場景之前立即引發(fā)的事件。事件的訂閱服務器接收場景實例作為第一個參數(shù)，當前時間作為第二個參數(shù)。
(readonly) preRender : Event
獲取將在場景更新后立即在場景呈現(xiàn)前引發(fā)的事件。事件的訂閱服務器接收場景實例作為第一個參數(shù)，當前時間作為第二個參數(shù)。
(readonly) preUpdate : Event
獲取將在更新或呈現(xiàn)場景之前引發(fā)的事件。事件的訂閱服務器接收場景實例作為第一個參數(shù)，當前時間作為第二個參數(shù)。
(readonly) primitives : PrimitiveCollection
獲取基元的集合。
(readonly) renderError : Event
獲取在
render函數(shù)中引發(fā)錯誤時將引發(fā)的事件。場景實例和拋出的錯誤是傳遞給事件處理程序的唯一兩個參數(shù)。默認情況下，在引發(fā)此事件后不會重新引發(fā)錯誤，但可以通過設置rethrowRenderErrors屬性來更改錯誤。
requestRenderMode : Boolean
當
true時，僅當場景中的更改決定需要時才會渲染幀。啟用可以提高應用程序的性能，但需要使用Scene#requestRender在此模式下顯式呈現(xiàn)新幀。在許多情況下，在對API其他部分中的場景進行更改之后，這是必需的。
-
Default Value:
false
See:
rethrowRenderErrors : Boolean
在
render中發(fā)生的異常始終被捕獲，以便引發(fā)renderError事件。如果此屬性為true，則在引發(fā)事件后重新引發(fā)錯誤。如果此屬性為假，則在引發(fā)事件后，render函數(shù)將正常返回。
-
Default Value:
false
(readonly) sampleHeightSupported : Boolean
(readonly) scene3DOnly : Boolean
獲取該場景是否優(yōu)化為僅用于三維查看。
(readonly) screenSpaceCameraController : ScreenSpaceCameraController
獲取用于處理相機輸入的控制器。
shadowMap : ShadowMap
場景中的陰影圖。啟用后，模型、基本體和球體可以投射和接收陰影。默認情況下，陰影貼圖的光源是太陽。
skyAtmosphere : SkyAtmosphere
天空的大氣吸引了全世界。
-
Default Value:
undefined
skyBox : SkyBox
SkyBox用于繪制星星。
-
Default Value:
undefined
See:
specularEnvironmentMaps : String
KTX文件的URL，其中包含用于PBR模型基于圖像的照明的鏡面環(huán)境貼圖和卷積mipmap。
(readonly) specularEnvironmentMapsSupported : Boolean
如果支持鏡面環(huán)境貼圖，則返回
true。
sphericalHarmonicCoefficients : Array.<Cartesian3>
基于圖像的PBR模型光照的球面諧波系數(shù)。
sun : Sun
-
Default Value:
undefined
sunBloom : Boolean
啟用時在太陽上使用“布盧姆”過濾器。
-
Default Value:
true
sunColor : Cartesian3
獲取或設置太陽發(fā)出的光的顏色。
-
Default Value:
Cartesian3(1.8, 1.85, 2.0)
terrainExaggeration : Number
獲取用于放大地形的標量。
terrainProvider : TerrainProvider
地形提供者為地球儀提供表面幾何圖形。
(readonly) terrainProviderChanged : Event
獲取在地形提供程序更改時引發(fā)的事件
useDepthPicking : Boolean
當
true時，使用深度緩沖區(qū)啟用拾取。
-
Default Value:
true
useWebVR : Boolean
當
true時，將場景分割為兩個具有左右眼立體視圖的視區(qū)。用于紙板和網(wǎng)絡虛擬現(xiàn)實。
-
Default Value:
false
Methods
cartesianToCanvasCoordinates(position, result) → {Cartesian2}
將笛卡爾坐標中的位置轉換為畫布坐標。這通常用于將HTML元素放置在與場景中的對象相同的屏幕位置。
Parameters:
Example
// Output the canvas position of longitude/latitude (0, 0) every time the mouse moves.
var scene = widget.scene;
var ellipsoid = scene.globe.ellipsoid;
var position = bmgl.Cartesian3.fromDegrees(0.0, 0.0);
var handler = new bmgl.ScreenSpaceEventHandler(scene.canvas);
handler.setInputAction(function(movement) {
console.log(scene.cartesianToCanvasCoordinates(position));
}, bmgl.ScreenSpaceEventType.MOUSE_MOVE);
沿大地測量面法向將給定的笛卡爾坐標位置鉗制到場景幾何體。返回夾緊位置，如果沒有要夾緊的場景幾何圖形，則返回
undefined。可用于將對象夾持到場景中的球體、三維平鋪或基本體上。此功能僅限于當前視圖中呈現(xiàn)的球形瓦片和三維瓦片。鉗制到所有其他基本體，而不管它們的可見性如何。
Parameters:
objectsToExclude
(Array.<Object>)
基本體、實體或三維平鋪特征的列表，不夾在其中。
width
(Number)
(default 0.1)
交叉口體積的寬度（米）。
Example
// Clamp an entity to the underlying scene geometry
var position = entity.position.getValue(bmgl.JulianDate.now());
entity.position = viewer.scene.clampToHeight(position);Throws
-
DeveloperError : ClampToHeight僅在3D模式下受支持。
-
DeveloperError : ClampToHeight需要深度紋理支持。檢查支架高度。
使用場景中三維平鋪的最大細節(jié)級別，啟動異步
Scene#clampToHeight查詢Cartesian3位置數(shù)組。返回在查詢完成時解決的承諾。每個位置都在適當?shù)奈恢眠M行了修改。如果由于在該位置無法對幾何圖形進行采樣而無法夾緊某個位置，或者發(fā)生其他錯誤，則陣列中的元素將設置為“未定義”。
Parameters:
objectsToExclude
(Array.<Object>)
基本體、實體或三維平鋪特征的列表，不夾在其中。
width
(Number)
(default 0.1)
交叉口體積的寬度（米）。
Example
var cartesians = [
entities[0].position.getValue(bmgl.JulianDate.now()),
entities[1].position.getValue(bmgl.JulianDate.now())
];
var promise = viewer.scene.clampToHeightMostDetailed(cartesians);
promise.then(function(updatedCartesians) {
entities[0].position = updatedCartesians[0];
entities[1].position = updatedCartesians[1];
}Throws
-
DeveloperError : ClampToHeightMostDetailed僅在3D模式下受支持。
-
DeveloperError : ClamptoHeightMostDetailed需要深度紋理支持。檢查支架高度。
See:
立即完成活動轉換。
銷毀此對象持有的WebGL資源。銷毀對象允許確定地釋放WebGL資源，而不是依賴垃圾收集器來銷毀此對象。
一旦對象被破壞，就不應使用它；調用除
一旦對象被破壞，就不應使用它；調用除
isDestroyed以外的任何函數(shù)都將導致DeveloperError異常。因此，將返回值（undefined）賦給對象，如示例中所述。
Throws
-
DeveloperError : 此對象已被銷毀，即調用destroy（）。
See:
返回特定窗口坐標位置上所有基元的對象列表，每個對象都包含“primitive”屬性。還可以根據(jù)基本體的類型設置其他屬性，并可用于進一步標識拾取的對象。列表中的基本體按它們在場景中的視覺順序（前后）排序。
Parameters:
limit
(Number)
如果提供，在收集了這么多鎬后停止鉆孔。
width
(Number)
(default 3)
拾取矩形的寬度。
height
(Number)
(default 3)
拾取矩形的高度。
Throws
-
DeveloperError : WindowPosition未定義。
See:
確定是否支持壓縮紋理格式。
Parameters:
format
(String)
紋理格式?？梢允歉袷矫騑ebGL擴展名，例如S3TC或WebGL_compressed_texture_S3TC。
See:
異步將場景轉換為二維。
Parameters:
duration
(Number)
(default 2.0)
過渡動畫完成所需的時間量（秒）。
異步將場景轉換為3D。
Parameters:
duration
(Number)
(default 2.0)
過渡動畫完成所需的時間量（秒）。
異步將場景轉換為Columbus視圖。
Parameters:
duration
(Number)
(default 2.0)
過渡動畫完成所需的時間量（秒）。
返回一個具有“primitive”屬性的對象，該屬性包含場景中特定窗口坐標處的第一個（頂部）primitive；如果該位置上沒有任何內容，則返回未定義的。其他屬性可能會根據(jù)基本體的類型進行設置，并可用于進一步標識拾取的對象。
當拾取3D Tiles-Tileset的功能時，pick返回BM3DTileFeature對象。
Parameters:
width
(Number)
(default 3)
拾取矩形的寬度。
height
(Number)
(default 3)
拾取矩形的高度。
Example
// On mouse over, color the feature yellow.
handler.setInputAction(function(movement) {
var feature = scene.pick(movement.endPosition);
if (feature instanceof bmgl.BM3DTileFeature) {
feature.color = bmgl.Color.YELLOW;
}
}, bmgl.ScreenSpaceEventType.MOUSE_MOVE);
返回從深度緩沖區(qū)和窗口位置重建的笛卡爾位置。
從二維深度緩沖區(qū)重建的位置可能與三維和哥倫布視圖重建的位置略有不同。這是由于透視投影和正交投影的深度值分布不同造成的。
設置Scene#pickTranslucentDepth至true以包括半透明基本體的深度；否則，這基本上是通過半透明基本體選取的。
Parameters:
Throws
-
DeveloperError : 不支持從深度緩沖區(qū)選取。檢查支持的選擇位置。
返回給定制圖位置處的場景幾何體高度，如果沒有要采樣的場景幾何體，則返回
undefined。輸入位置的高度被忽略。可用于將對象夾持到場景中的球體、三維平鋪或基本體上。此函數(shù)僅對當前視圖中渲染的球形瓦片和三維瓦片的高度進行采樣。從所有其他基本體采樣高度，而不考慮它們的可見性。
Parameters:
objectsToExclude
(Array.<Object>)
不從中采樣高度的基本體、實體或三維平鋪特征列表。
width
(Number)
(default 0.1)
交叉口體積的寬度（米）。
Example
var position = new bmgl.Cartographic(-1.31968, 0.698874);
var height = viewer.scene.sampleHeight(position);
console.log(height);Throws
-
DeveloperError : 只有在3D模式下才支持sampleheight。
-
DeveloperError : 樣品瓶需要深度紋理支持。檢查支持的樣本權重。
使用場景中三維平鋪的最大細節(jié)級別，啟動異步
Scene#sampleHeight查詢Cartographic位置數(shù)組。輸入位置的高度將被忽略。返回在查詢完成時解決的承諾。每個點的高度都會在適當?shù)奈恢眠M行修改。如果由于無法在該位置對幾何圖形進行采樣而無法確定高度，或發(fā)生其他錯誤，則高度設置為“未定義”。
Parameters:
objectsToExclude
(Array.<Object>)
不從中采樣高度的基本體、實體或三維平鋪特征列表。
width
(Number)
(default 0.1)
交叉口體積的寬度（米）。
Example
var positions = [
new bmgl.Cartographic(-1.31968, 0.69887),
new bmgl.Cartographic(-1.10489, 0.83923)
];
var promise = viewer.scene.sampleHeightMostDetailed(positions);
promise.then(function(updatedPosition) {
// positions[0].height and positions[1].height have been updated.
// updatedPositions is just a reference to positions.
}Throws
-
DeveloperError : 只有在3D模式下才支持sampleheight mostdetailed。
-
DeveloperError : sampleHeightmostDetailed需要深度紋理支持。檢查支持的樣本權重。