WaterPolygonEntity¶
多角形エンティティ
Animation Binding¶
| Name | Type |
|---|---|
| color | vector3 |
| opacity | number |
| height | number |
Extends¶
Constructors¶
new WaterPolygonEntity()¶
new WaterPolygonEntity(
scene,opts?):WaterPolygonEntity
Parameters¶
| Parameter | Type | Description |
|---|---|---|
scene |
Scene |
所属可能シーン |
opts? |
Option |
オプション集合 |
Returns¶
Overrides¶
AbstractPolygonEntity.constructor
Properties¶
_altitude_mode¶
protected_altitude_mode:AltitudeMode=AltitudeMode.ABSOLUTE
高度モード
Inherited from¶
AbstractPolygonEntity._altitude_mode
_anchor_mode¶
protected_anchor_mode:boolean=false
アンカーモード
Inherited from¶
AbstractPolygonEntity._anchor_mode
_animation¶
protected_animation:any
今のところ Entity (基底クラス) 自体のアニメーション可能パラメータと 子孫は存在しないので animation には何も追加しない
Inherited from¶
AbstractPolygonEntity._animation
_attributions?¶
protectedoptional_attributions:Attributions=undefined
Inherited from¶
AbstractPolygonEntity._attributions
_bake_target¶
protected_bake_target:BakeTarget=Entity.BakeTarget.GROUND_AND_STRUCTURE
Inherited from¶
AbstractPolygonEntity._bake_target
_need_to_create_regions¶
protected_need_to_create_regions:boolean=false
再生成が必要であることを示すフラグ
Inherited from¶
AbstractPolygonEntity._need_to_create_regions
_pickable¶
protected_pickable:boolean=true
Viewer.pick() の対象とするかどうか
Inherited from¶
AbstractPolygonEntity._pickable
_producer¶
protected_producer:PrimitiveProducer|FlakePrimitiveProducer
Inherited from¶
AbstractPolygonEntity._producer
_render_type¶
protected_render_type:RenderType=Entity.RenderType.NORMAL
Inherited from¶
AbstractPolygonEntity._render_type
_stencil_flag¶
protected_stencil_flag:boolean=false
Inherited from¶
AbstractPolygonEntity._stencil_flag
_visibility¶
protected_visibility:boolean=true
表示状態を示すフラグ
Inherited from¶
AbstractPolygonEntity._visibility
event_emitter¶
protectedevent_emitter:null|EventEmitter<object,unknown>
Inherited from¶
AbstractPolygonEntity.event_emitter
scene¶
readonlyscene:Scene
所属可能シーン
Inherited from¶
visualizer¶
protectedvisualizer:EntityVisualizer
Inherited from¶
AbstractPolygonEntity.visualizer
Accessors¶
altitude_mode¶
getaltitude_mode():AltitudeMode
高度モード取得
setaltitude_mode(value):void
高度モード設定
Parameters¶
| Parameter | Type |
|---|---|
value |
AltitudeMode |
Returns¶
anchor_mode¶
getanchor_mode():boolean
アンカーモード。
隠面処理により本来表示されない状況であっても、最前面に描画を行いマウスピックも可能となるような描画モード。 現在は、隠面処理により本来表示されない部分は半透明で描画されます。
このプロパティを有効にする場合は、下記の問題点に注意する必要があります。 - 透明・半透明モデルに適用することは想定されていません。透明・半透明モデルに対してこのプロパティを有効にすると表示が乱れる可能性があります。 - アンカーモードのエンティティどうしの前後判定はzソートにより実装されており、ピクセル単位の前後判定は行われません。
Returns¶
boolean
animation¶
getanimation():any
アニメーションパラメータ設定
Returns¶
any
bake_target¶
getbake_target():BakeTarget
setbake_target(bake_target):void
Parameters¶
| Parameter | Type |
|---|---|
bake_target |
BakeTarget |
Returns¶
boundaries¶
getboundaries():Boundary[]
Returns¶
Boundary[]
render_type¶
getrender_type():RenderType
setrender_type(render_type):void
Parameters¶
| Parameter | Type |
|---|---|
render_type |
RenderType |
Returns¶
stencil_flag¶
getstencil_flag():boolean
Returns¶
boolean
visibility¶
getvisibility():boolean
可視性フラグを取得
Returns¶
boolean
Methods¶
addInnerBoundary()¶
addInnerBoundary(
points):Boundary
内側境界を追加
points は [lon_0, lat_0, alt_0, lon_1, lat_1, alt_1, ...] のような形式で配列を与える。
Parameters¶
| Parameter | Type | Description |
|---|---|---|
points |
number[] |
頂点の配列 |
Returns¶
Inherited from¶
AbstractPolygonEntity.addInnerBoundary
addOuterBoundary()¶
addOuterBoundary(
points):Boundary
外側境界を追加
points は [lon_0, lat_0, alt_0, lon_1, lat_1, alt_1, ...] のような形式で配列を与える。
Parameters¶
| Parameter | Type | Description |
|---|---|---|
points |
number[] |
頂点の配列 |
Returns¶
Inherited from¶
AbstractPolygonEntity.addOuterBoundary
changeHeight()¶
changeHeight(
height):void
Parameters¶
| Parameter | Type |
|---|---|
height |
number |
Returns¶
void
clearVisualizer()¶
clearVisualizer():
void
Returns¶
void
Inherited from¶
AbstractPolygonEntity.clearVisualizer
convertFromPolygonEntity()¶
staticconvertFromPolygonEntity(polygon_entity,opt?):WaterPolygonEntity
PolygonEntity を WaterPolygonEntity に変換します。
Parameters¶
| Parameter | Type | Description |
|---|---|---|
polygon_entity |
PolygonEntity |
変換元 PolygonEntity |
opt? |
LoadOption |
WaterPolygonEntity 生成オプション |
Returns¶
WaterPolygonEntity
createProducer()¶
protectedcreateProducer():object
Returns¶
object
is_flake_mode¶
is_flake_mode:
boolean
producer¶
producer:
PrimitiveProducer|FlakePrimitiveProducer
Overrides¶
AbstractPolygonEntity.createProducer
getAttributions()¶
getAttributions():
undefined|Attributions
Attributions 取得
Returns¶
undefined | Attributions
Inherited from¶
AbstractPolygonEntity.getAttributions
getBoundaryAt()¶
Experimental
getBoundaryAt(
index):Boundary
境界を取得
Parameters¶
| Parameter | Type |
|---|---|
index |
number |
Returns¶
Inherited from¶
AbstractPolygonEntity.getBoundaryAt
getBoundaryCount()¶
Experimental
getBoundaryCount():
number
境界数を取得
Returns¶
number
Inherited from¶
AbstractPolygonEntity.getBoundaryCount
getBounds()¶
getBounds():
GeoRegion
すべての頂点のバウンディングを算出
Returns¶
バウンディング情報を持ったGeoRegion
Inherited from¶
AbstractPolygonEntity.getBounds
getDefaultVisualizer()¶
protectedgetDefaultVisualizer():EntityVisualizer
Returns¶
Inherited from¶
AbstractPolygonEntity.getDefaultVisualizer
getFlakePrimitiveProducer()¶
getFlakePrimitiveProducer():
undefined|FlakePrimitiveProducer
Returns¶
undefined | FlakePrimitiveProducer
Inherited from¶
AbstractPolygonEntity.getFlakePrimitiveProducer
getHeight()¶
getHeight():
undefined|number
Returns¶
undefined | number
getMaterial()¶
protectedgetMaterial(render_target):EntityMaterial
Parameters¶
| Parameter | Type |
|---|---|
render_target |
RenderTarget |
Returns¶
Overrides¶
AbstractPolygonEntity.getMaterial
getPrimitiveProducer()¶
getPrimitiveProducer():
undefined|PrimitiveProducer
Returns¶
undefined | PrimitiveProducer
Inherited from¶
AbstractPolygonEntity.getPrimitiveProducer
getTriangleIndices()¶
Experimental
getTriangleIndices():
undefined|number[]
三角形リストを生成
Returns¶
undefined | number[]
Inherited from¶
AbstractPolygonEntity.getTriangleIndices
getVisualizer()¶
getVisualizer():
EntityVisualizer
Returns¶
Inherited from¶
AbstractPolygonEntity.getVisualizer
isAttached()¶
isAttached():
boolean
Returns¶
boolean
Inherited from¶
AbstractPolygonEntity.isAttached
isPickable()¶
isPickable():
boolean
このEntityが Viewer.pick() による選択対象であるかを取得する。
Returns¶
boolean
Inherited from¶
AbstractPolygonEntity.isPickable
loadWaterPolygonGeoJSON()¶
staticloadWaterPolygonGeoJSON(scene,resources,opt?):Promise<WaterPolygonEntity[]>
WaterPolygonEntity をシーンにロードします。
Parameters¶
| Parameter | Type | Description |
|---|---|---|
scene |
Scene |
シーン |
resources |
string[] | Resource[] |
WaterPolygonEntity 読み込み URL |
opt? |
LoadOption |
WaterPolygonEntity 生成オプション |
Returns¶
Promise<WaterPolygonEntity[]>
WaterPolygonEntity[]
onChangeAltitudeMode()¶
onChangeAltitudeMode(
_prev_mode):void
Parameters¶
| Parameter | Type |
|---|---|
_prev_mode |
AltitudeMode |
Returns¶
void
Inherited from¶
AbstractPolygonEntity.onChangeAltitudeMode
removeAllBoundaries()¶
Experimental
removeAllBoundaries():
void
境界を全て削除
Returns¶
void
Inherited from¶
AbstractPolygonEntity.removeAllBoundaries
removeBoundary()¶
Experimental
removeBoundary(
boundary):boolean
境界を削除
Parameters¶
| Parameter | Type |
|---|---|
boundary |
Boundary |
Returns¶
boolean
Inherited from¶
AbstractPolygonEntity.removeBoundary
setAnchorMode()¶
Experimental
setAnchorMode(
anchor_mode):void
アンカーモードを設定。
Parameters¶
| Parameter | Type | Description |
|---|---|---|
anchor_mode |
boolean |
Returns¶
void
Inherited from¶
AbstractPolygonEntity.setAnchorMode
See¶
setAttributions()¶
setAttributions(
attributions):void
Attributions 設定
Parameters¶
| Parameter | Type |
|---|---|
attributions |
undefined | Attributions |
Returns¶
void
Inherited from¶
AbstractPolygonEntity.setAttributions
setPickable()¶
setPickable(
pickable):void
このEntityを Viewer.pick() による選択対象とするかを設定する。
Parameters¶
| Parameter | Type | Description |
|---|---|---|
pickable |
boolean |
選択可能か否か |
Returns¶
void
Inherited from¶
AbstractPolygonEntity.setPickable
setVisibility()¶
setVisibility(
visibility):void
可視性フラグを設定
Parameters¶
| Parameter | Type | Description |
|---|---|---|
visibility |
boolean |
可視性フラグ |
Returns¶
void
Inherited from¶
AbstractPolygonEntity.setVisibility
setVisualizer()¶
setVisualizer(
visualizer):void
Parameters¶
| Parameter | Type |
|---|---|
visualizer |
EntityVisualizer |
Returns¶
void
Inherited from¶
AbstractPolygonEntity.setVisualizer
setZIndex()¶
setZIndex(
z_index):void
Z-Indexを設定。 大きいほど手前に表示される。(アンカーモード時のみ有効)
Parameters¶
| Parameter | Type |
|---|---|
z_index |
number |
Returns¶
void
Inherited from¶
AbstractPolygonEntity.setZIndex
setupAnimationBindingBlock()¶
protectedsetupAnimationBindingBlock():void
アニメーションの BindingBlock を初期化
Returns¶
void
Inherited from¶
AbstractPolygonEntity.setupAnimationBindingBlock
setupByJson()¶
protectedsetupByJson(json):void
Parameters¶
| Parameter | Type |
|---|---|
json |
Json |
Returns¶
void
Inherited from¶
AbstractPolygonEntity.setupByJson
use_stencil()¶
use_stencil():
boolean
Returns¶
boolean