GroundPolylinePrimitive

GroundPolyLinePrimitive表示覆蓋在地形上的多段線或Scene中的三維瓦片。

僅用于包含GroundPolylineGeometry的幾何狀態。

new GroundPolylinePrimitive(options)

Parameters:

options (Object)

Name	Description
options.geometryInstances `(Array \| GeometryInstance)`	包含GroundPolyLineGeometry的幾何條件
options.appearance `Appearance`	用于渲染多段線的外觀。默認為A`PolylineMaterialAppearance`上的白色`Material`。
options.show `Boolean` default `true`	確定是否顯示此基元。
options.interleave `Boolean` default `false`	當`true`時，幾何頂點屬性交錯，這可以稍微提高渲染性能，但增加加載時間。
options.releaseGeometryInstances `Boolean` default `true`	當`true`時，原語不保留對輸入`geometryInstances`的引用以保存內存。
options.allowPicking `Boolean` default `true`	當`true`時，每個幾何體實例只能使用`Scene#pick`進行選擇。當`false`時，保存GPU內存。
options.asynchronous `Boolean` default `true`	確定在準備就緒之前是異步創建基元還是阻止創建基元。如果為false，則必須首先調用initiaterrainheights（）。
options.classificationType `ClassificationType` default `ClassificationType.BOTH`	確定地形、三維瓦片還是兩者都要分類。
options.debugShowBoundingVolume `Boolean` default `false`	僅用于調試。確定是否顯示此基元的命令的邊界球。
options.debugShowShadowVolume `Boolean` default `false`	僅用于調試。確定是否繪制基本體中每個幾何體的陰影體積。必須在創建時為`true`才能生效。

Example

// 1. Draw a polyline on terrain with a basic color material

var instance = new bmgl.GeometryInstance({
  geometry : new bmgl.GroundPolylineGeometry({
     positions : bmgl.Cartesian3.fromDegreesArray([
         -112.1340164450331, 36.05494287836128,
         -112.08821010582645, 36.097804071380715
     ]),
     width : 4.0
  }),
  id : 'object returned when this instance is picked and to get/set per-instance attributes'
});

scene.groundPrimitives.add(new bmgl.GroundPolylinePrimitive({
  geometryInstances : instance,
  appearance : new bmgl.PolylineMaterialAppearance()
}));

// 2. Draw a looped polyline on terrain with per-instance color and a distance display condition.
// Distance display conditions for polylines on terrain are based on an approximate terrain height
// instead of true terrain height.

var instance = new bmgl.GeometryInstance({
  geometry : new bmgl.GroundPolylineGeometry({
     positions : bmgl.Cartesian3.fromDegreesArray([
         -112.1340164450331, 36.05494287836128,
         -112.08821010582645, 36.097804071380715,
         -112.13296079730024, 36.168769146801104
     ]),
     loop : true,
     width : 4.0
  }),
  attributes : {
     color : bmgl.ColorGeometryInstanceAttribute.fromColor(bmgl.Color.fromCssColorString('green').withAlpha(0.7)),
     distanceDisplayCondition : new bmgl.DistanceDisplayConditionGeometryInstanceAttribute(1000, 30000)
  },
  id : 'object returned when this instance is picked and to get/set per-instance attributes'
});

scene.groundPrimitives.add(new bmgl.GroundPolylinePrimitive({
  geometryInstances : instance,
  appearance : new bmgl.PolylineColorAppearance()
}));

Members

(readonly) allowPicking : Boolean

當true時，每個幾何體實例只能使用Scene#pick進行選擇。當false時，保存GPU內存。

Default Value: true

appearance : Appearance

Appearance用于對該原語進行著色。每個幾何體實例都以相同的外觀著色。一些外觀，如PolylineColorAppearance允許為每個實例提供唯一的屬性。

Default Value: undefined

(readonly) asynchronous : Boolean

確定是否將在Web工作者上創建和批處理幾何體實例。

Default Value: true

classificationType : ClassificationType

確定地形、三維瓦片還是兩者都要分類。

Default Value: ClassificationType.BOTH

debugShowBoundingVolume : Boolean

此屬性僅用于調試；它既不用于生產，也不進行優化。

為基本體中的每個draw命令繪制邊界球體。

Default Value: false

(readonly) debugShowShadowVolume : Boolean

此屬性僅用于調試；它既不用于生產，也不進行優化。

如果為真，則為基本體中的每個幾何體繪制陰影體積。

Default Value: false

(readonly) geometryInstances : (Array|GeometryInstance)

使用此基元渲染的幾何體實例。在構造基元時，如果options.releaseGeometryInstances是true，則可能是undefined。

在呈現基元后更改此屬性沒有效果。

Default Value: undefined

(readonly) interleave : Boolean

確定幾何體頂點屬性是否交錯，這可以稍微提高渲染性能。

Default Value: false

(readonly) ready : Boolean

確定基元是否已完成并準備好呈現。如果此屬性為真，則下次調用GroundPolylinePrimitive#update時將呈現原語。

(readonly) readyPromise : Promise.<GroundPolylinePrimitive>

獲取解決基元何時準備呈現的承諾。

(readonly) releaseGeometryInstances : Boolean

當true時，原語不保留對輸入geometryInstances的引用以保存內存。

Default Value: true

show : Boolean

確定是否顯示基元。這會影響基本體中的所有幾何體實例。

Default Value: true

Methods

(static) initializeTerrainHeights() → {Promise}

初始化最小和最大地形高度。只有在同步創建groundPolyLinePrimitive時才需要調用此函數。

(static) isSupported(scene) → {Boolean}

檢查給定的場景是否支持groundPolyLinePrimitive。GroundPolyLinePrimitives需要支持WebGL“深度”紋理擴展。

Parameters:

scene (Scene) 當前場景。

destroy()

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

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

Example

e = e && e.destroy();

Throws

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

See:

GroundPolylinePrimitive#isDestroyed

getGeometryInstanceAttributes(id) → {Object}

返回GeometryInstance的每個實例可修改屬性。

Parameters:

id (*) GeometryInstance的ID。

Example

var attributes = primitive.getGeometryInstanceAttributes('an id');
attributes.color = bmgl.ColorGeometryInstanceAttribute.toValue(bmgl.Color.AQUA);
attributes.show = bmgl.ShowGeometryInstanceAttribute.toValue(true);

Throws

DeveloperError : 必須在調用GetGeometryInstanceAttributes之前調用Update。

isDestroyed() → {Boolean}

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

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

See:

GroundPolylinePrimitive#destroy

update()

當Viewer或BMWidget渲染場景以獲取渲染此原語所需的繪制命令時調用。

不要直接調用此函數。這只是為了列出渲染場景時可能傳播的異常：

Throws

DeveloperError : 對于同步groundPolyLinePrimitives，必須調用groundPolyLinePrimitives.InitializerRainHeights（），然后等待返回的Promise解析。
DeveloperError : 所有幾何實例都必須具有顏色屬性才能將PolyLineColorAppearance與GroundPolyLinePrimitive一起使用。