PinEntity¶

ピンエンティティ

Animation Binding¶

Name	Type
fg_color	vector3
bg_color	vector3
size	vector2, number

Example¶

var pin = new mapray.PinEntity(viewer.scene);

// Normal Pin
pin.addPin( new mapray.GeoPoint(139.766, 35.6361) );

// Text Pin
pin.addTextPin( "32", new mapray.GeoPoint(139.768, 35.635) );

pin.addTextPin( "A", new mapray.GeoPoint(139.768, 35.636),
    { fg_color: [0.0, 0.0, 1.0], bg_color: [1.0, 0.0, 0.0] } );

pin.addTextPin( "S", new mapray.GeoPoint(139.768, 35.637),
    { size: 50 } );

pin.addTextPin( "E", new mapray.GeoPoint(139.768, 35.639),
    { size: 50, font_family: "Georgia" } );

// Maki Icon Pin
pin.addMakiIconPin( "ferry-15", new mapray.GeoPoint(139.764, 35.6361),
    { size: 150, fg_color: [0.2, 0.2, 0.2], bg_color: [1.0, 1.0, 1.0] } );

pin.addMakiIconPin( "car-15",   new mapray.GeoPoint(139.762, 35.6361),
    { size: 60, fg_color: [1.0, 1.0, 1.0], bg_color: [0.2, 0.2, 0.2] } );

pin.addMakiIconPin( "bus-15",   new mapray.GeoPoint(139.760, 35.6361),
    { size: 40, fg_color: [1.0, 0.3, 0.1], bg_color: [0.1, 0.3, 1.0] } );

pin.addMakiIconPin( "bus-15",   new mapray.GeoPoint(139.759, 35.6361) );

viewer.scene.addEntity(pin);

Extends¶

AbstractPointEntity<TextPinEntry | MakiIconPinEntry>

Constructors¶

new PinEntity()¶

new PinEntity(scene, opts?): PinEntity

Parameters¶

Parameter	Type	Description
`scene`	`Scene`	所属可能シーン
`opts`?	`Option`	オプション集合

Returns¶

PinEntity

Overrides¶

AbstractPointEntity.constructor

Properties¶

CIRCLE_SEP_LENGTH¶

static CIRCLE_SEP_LENGTH: number = 32

DEFAULT_BG_COLOR¶

static DEFAULT_BG_COLOR: Vector3

DEFAULT_FG_COLOR¶

static DEFAULT_FG_COLOR: Vector3

DEFAULT_FONT_FAMILY¶

static DEFAULT_FONT_FAMILY: string = "sans-serif"

DEFAULT_SIZE¶

static DEFAULT_SIZE: Vector2

MAX_IMAGE_WIDTH¶

static MAX_IMAGE_WIDTH: number = 4096

SAFETY_PIXEL_MARGIN¶

static readonly SAFETY_PIXEL_MARGIN: 1 = 1

_altitude_mode¶

protected _altitude_mode: AltitudeMode = AltitudeMode.ABSOLUTE

高度モード

Inherited from¶

AbstractPointEntity._altitude_mode

_anchor_mode¶

protected _anchor_mode: boolean = false

アンカーモード

Inherited from¶

AbstractPointEntity._anchor_mode

_animation¶

protected _animation: any

今のところ Entity (基底クラス) 自体のアニメーション可能パラメータと子孫は存在しないので animation には何も追加しない

Inherited from¶

AbstractPointEntity._animation

_attributions?¶

protected optional _attributions: Attributions = undefined

Inherited from¶

AbstractPointEntity._attributions

_bake_target¶

protected _bake_target: BakeTarget = Entity.BakeTarget.GROUND_AND_STRUCTURE

Inherited from¶

AbstractPointEntity._bake_target

_entries¶

protected _entries: (TextPinEntry | MakiIconPinEntry)[]

要素管理

Inherited from¶

AbstractPointEntity._entries

_need_to_create_regions¶

protected _need_to_create_regions: boolean = false

再生成が必要であることを示すフラグ

Inherited from¶

AbstractPointEntity._need_to_create_regions

_pickable¶

protected _pickable: boolean = true

Viewer.pick() の対象とするかどうか

Inherited from¶

AbstractPointEntity._pickable

_render_type¶

protected _render_type: RenderType = Entity.RenderType.NORMAL

Inherited from¶

AbstractPointEntity._render_type

_stencil_flag¶

protected _stencil_flag: boolean = false

Inherited from¶

AbstractPointEntity._stencil_flag

_visibility¶

protected _visibility: boolean = true

表示状態を示すフラグ

Inherited from¶

AbstractPointEntity._visibility

event_emitter¶

protected event_emitter: null | EventEmitter<EventMap, unknown>

Inherited from¶

AbstractPointEntity.event_emitter

scene¶

readonly scene: Scene

所属可能シーン

Inherited from¶

AbstractPointEntity.scene

visualizer¶

protected visualizer: EntityVisualizer

Inherited from¶

AbstractPointEntity.visualizer

Accessors¶

altitude_mode¶

get altitude_mode(): AltitudeMode

高度モード取得

set altitude_mode(value): void

高度モード設定

Parameters¶

Parameter	Type
`value`	`AltitudeMode`

Returns¶

AltitudeMode

anchor_mode¶

get anchor_mode(): boolean

アンカーモード。

隠面処理により本来表示されない状況であっても、最前面に描画を行いマウスピックも可能となるような描画モード。現在は、隠面処理により本来表示されない部分は半透明で描画されます。

このプロパティを有効にする場合は、下記の問題点に注意する必要があります。 - 透明・半透明モデルに適用することは想定されていません。透明・半透明モデルに対してこのプロパティを有効にすると表示が乱れる可能性があります。 - アンカーモードのエンティティどうしの前後判定はzソートにより実装されており、ピクセル単位の前後判定は行われません。

Returns¶

boolean

animation¶

get animation(): any

アニメーションパラメータ設定

Returns¶

any

bake_target¶

get bake_target(): BakeTarget

set bake_target(bake_target): void

Parameters¶

Parameter	Type
`bake_target`	`BakeTarget`

Returns¶

BakeTarget

num_entries¶

get num_entries(): number

Entry数を取得

Returns¶

number

render_type¶

get render_type(): RenderType

set render_type(render_type): void

Parameters¶

Parameter	Type
`render_type`	`RenderType`

Returns¶

RenderType

stencil_flag¶

get stencil_flag(): boolean

Returns¶

boolean

visibility¶

get visibility(): boolean

可視性フラグを取得

Returns¶

boolean

Methods¶

addMakiIconPin()¶

addMakiIconPin(id, position, props?): MakiIconPinEntry

Add Maki Icon Pin

Parameters¶

Parameter	Type	Description
`id`	`string`	ID of Maki Icon
`position`	`GeoPoint`	位置
`props`?	`MakiIconPinEntryOption`	プロパティ

Returns¶

MakiIconPinEntry

追加したEntry

addPin()¶

addPin(position, props?): TextPinEntry

Add Pin

Parameters¶

Parameter	Type	Description
`position`	`GeoPoint`	位置
`props`?	`AbstractPinEntryOption`	プロパティ

Returns¶

TextPinEntry

追加したEntry

addTextPin()¶

addTextPin(text, position, props?): TextPinEntry

Add Text Pin

Parameters¶

Parameter	Type	Description
`text`	`string`	ピンに表示されるテキスト
`position`	`GeoPoint`	位置
`props`?	`TextPinEntryOption`	プロパティ

Returns¶

TextPinEntry

追加したEntry

clearVisualizer()¶

clearVisualizer(): void

Returns¶

void

Inherited from¶

AbstractPointEntity.clearVisualizer

getAttributions()¶

getAttributions(): undefined | Attributions

Attributions 取得

Returns¶

undefined | Attributions

Inherited from¶

AbstractPointEntity.getAttributions

getBounds()¶

getBounds(): GeoRegion

すべてのEntryのバウンディングを算出

Returns¶

GeoRegion

バウンディング情報を持ったGeoRegion

Inherited from¶

AbstractPointEntity.getBounds

getDefaultVisualizer()¶

protected getDefaultVisualizer(): EntityVisualizer

Returns¶

EntityVisualizer

Inherited from¶

AbstractPointEntity.getDefaultVisualizer

getEntry()¶

getEntry(index): TextPinEntry | MakiIconPinEntry

指定された index の Entry を取得

Parameters¶

Parameter	Type	Description
`index`	`number`

Returns¶

TextPinEntry | MakiIconPinEntry

Inherited from¶

AbstractPointEntity.getEntry

getEntryById()¶

getEntryById(id): undefined | TextPinEntry | MakiIconPinEntry

ID を指定して Entry を取得

Parameters¶

Parameter	Type	Description
`id`	`string`	ID

Returns¶

undefined | TextPinEntry | MakiIconPinEntry

id が一致した Entry。（なければ undefined を返す）。

Inherited from¶

AbstractPointEntity.getEntryById

getFlakePrimitiveProducer()¶

getFlakePrimitiveProducer(): undefined | FlakePrimitiveProducer

FlakePrimitiveProducer インタフェースを取得

FlakePrimitiveProducer インタフェースを取得するためにシーンレンダラーが呼び出す。 FlakePrimitiveProducer インタフェースが実装されていなければ undefined を返す。

既定の実装は undefined を返す。

Returns¶

undefined | FlakePrimitiveProducer

FlakePrimitiveProducer インタフェース

Inherited from¶

AbstractPointEntity.getFlakePrimitiveProducer

getPrimitiveProducer()¶

getPrimitiveProducer(): PrimitiveProducer

Returns¶

PrimitiveProducer

Overrides¶

AbstractPointEntity.getPrimitiveProducer

getVisualizer()¶

getVisualizer(): EntityVisualizer

Returns¶

EntityVisualizer

Inherited from¶

AbstractPointEntity.getVisualizer

isAttached()¶

isAttached(): boolean

Returns¶

boolean

Inherited from¶

AbstractPointEntity.isAttached

isPickable()¶

isPickable(): boolean

このEntityが Viewer.pick() による選択対象であるかを取得する。

Returns¶

boolean

Inherited from¶

AbstractPointEntity.isPickable

onChangeAltitudeMode()¶

protected onChangeAltitudeMode(prev_mode): void

Parameters¶

Parameter	Type
`prev_mode`	`AltitudeMode`

Returns¶

void

Overrides¶

AbstractPointEntity.onChangeAltitudeMode

removeEntry()¶

removeEntry(entry): boolean

指定されたEntryを削除

Parameters¶

Parameter	Type	Description
`entry`	`TextPinEntry` \| `MakiIconPinEntry`	Entry

Returns¶

boolean

削除できれば true

Overrides¶

AbstractPointEntity.removeEntry

setAnchorMode()¶

Experimental

setAnchorMode(anchor_mode): void

アンカーモードを設定。

Parameters¶

Parameter	Type	Description
`anchor_mode`	`boolean`

Returns¶

void

Inherited from¶

AbstractPointEntity.setAnchorMode

See¶

mapray.Entity.anchor_mode

setAttributions()¶

setAttributions(attributions): void

Attributions 設定

Parameters¶

Parameter	Type
`attributions`	`undefined` \| `Attributions`

Returns¶

void

Inherited from¶

AbstractPointEntity.setAttributions

setBGColor()¶

setBGColor(color): void

アイコン背景の色を設定

Parameters¶

Parameter	Type	Description
`color`	`Vector3`	アイコン背景の色

Returns¶

void

setFGColor()¶

setFGColor(color): void

アイコンの色を設定

Parameters¶

Parameter	Type	Description
`color`	`Vector3`	アイコンの色

Returns¶

void

setFontFamily()¶

setFontFamily(font_family): void

テキストアイコンのフォントを設定

Parameters¶

Parameter	Type	Description
`font_family`	`string`	フォントファミリー

Returns¶

void

setPickable()¶

setPickable(pickable): void

このEntityを Viewer.pick() による選択対象とするかを設定する。

Parameters¶

Parameter	Type	Description
`pickable`	`boolean`	選択可能か否か

Returns¶

void

Inherited from¶

AbstractPointEntity.setPickable

setSize()¶

setSize(size): void

アイコンのピクセルサイズを指定

Parameters¶

Parameter	Type	Description
`size`	`Vector2`	アイコンのピクセルサイズ

Returns¶

void

setVisibility()¶

setVisibility(visibility): void

可視性フラグを設定

Parameters¶

Parameter	Type	Description
`visibility`	`boolean`	可視性フラグ

Returns¶

void

Inherited from¶

AbstractPointEntity.setVisibility

setVisualizer()¶

setVisualizer(visualizer): void

Parameters¶

Parameter	Type
`visualizer`	`EntityVisualizer`

Returns¶

void

Inherited from¶

AbstractPointEntity.setVisualizer

setZIndex()¶

setZIndex(z_index): void

Z-Indexを設定。大きいほど手前に表示される。（アンカーモード時のみ有効）

Parameters¶

Parameter	Type
`z_index`	`number`

Returns¶

void

Inherited from¶

AbstractPointEntity.setZIndex

use_stencil()¶

use_stencil(): boolean

Returns¶

boolean

Inherited from¶

AbstractPointEntity.use_stencil