Class PinEntity

ピンエンティティ

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);

Hierarchy

AbstractPointEntity<TextPinEntry | MakiIconPinEntry>
- PinEntity

Constructors

constructor

new PinEntity(scene: mapray.Scene, opts?: mapray.PinEntity.Option): PinEntity
Parameters
- scene: mapray.Scene
  
  所属可能シーン
- Optional opts: mapray.PinEntity.Option
  
  オプション集合
Returns PinEntity
Overrides AbstractPointEntity.constructor
- Defined in packages/mapray/src/PinEntity.ts:76

Properties

`Protected` _altitude_mode

_altitude_mode: AltitudeMode = AltitudeMode.ABSOLUTE

高度モード

`Protected` _anchor_mode

_anchor_mode: boolean = false

アンカーモード

`Protected` _animation

_animation: any = ...

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

`Protected` _entries

_entries: (TextPinEntry | MakiIconPinEntry)[]

要素管理

`Protected` _need_to_create_regions

_need_to_create_regions: boolean = false

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

`Private` _parent_props

_parent_props: ParentPinEntryProps = {}

`Protected` _pickable

_pickable: boolean = true

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

`Private` _primitive_producer

_primitive_producer: mapray.PinEntity.PrimitiveProducer

`Protected` _visibility

_visibility: boolean = true

表示状態を示すフラグ

`Readonly` scene

scene: mapray.Scene

所属可能シーン

`Static` CIRCLE_SEP_LENGTH

CIRCLE_SEP_LENGTH: number = 32

`Static` DEFAULT_BG_COLOR

DEFAULT_BG_COLOR: Vector3 = ...

`Static` DEFAULT_FG_COLOR

DEFAULT_FG_COLOR: Vector3 = ...

`Static` DEFAULT_FONT_FAMILY

DEFAULT_FONT_FAMILY: string = "sans-serif"

`Static` DEFAULT_SIZE

DEFAULT_SIZE: Vector2 = ...

`Static` MAX_IMAGE_WIDTH

MAX_IMAGE_WIDTH: number = 4096

`Static` `Readonly` SAFETY_PIXEL_MARGIN

SAFETY_PIXEL_MARGIN: 1 = 1

Accessors

altitude_mode

get altitude_mode(): AltitudeMode
高度モード取得

Returns AltitudeMode
Inherited from AbstractPointEntity.altitude_mode
- Defined in packages/mapray/src/Entity.ts:141
set altitude_mode(value: AltitudeMode): void
高度モード設定
Parameters
- value: AltitudeMode
Returns void
Inherited from AbstractPointEntity.altitude_mode
- Defined in packages/mapray/src/Entity.ts:128

animation

get animation(): any
アニメーションパラメータ設定

Returns any
Inherited from AbstractPointEntity.animation
- Defined in packages/mapray/src/Entity.ts:122

visibility

get visibility(): boolean
可視性フラグを取得

Returns boolean
Inherited from AbstractPointEntity.visibility
- Defined in packages/mapray/src/Entity.ts:81

Methods

`Private` _getMaterial

_getMaterial(render_target: RenderTarget): object
専用マテリアルを取得
Parameters
- render_target: RenderTarget
Returns object
- Defined in packages/mapray/src/PinEntity.ts:259

`Private` _setValueProperty

_setValueProperty(name: string, value: string): void
プロパティを設定
Parameters
- name: string
- value: string
Returns void
- Defined in packages/mapray/src/PinEntity.ts:285

`Private` _setVector2Property

_setVector2Property(name: string, value: Vector2): void
Vector2プロパティを設定
Parameters
- name: string
- value: Vector2
Returns void
- Defined in packages/mapray/src/PinEntity.ts:319

`Private` _setVector3Property

_setVector3Property(name: string, value: Vector3): void
Vector3プロパティを設定
Parameters
- name: string
- value: Vector3
Returns void
- Defined in packages/mapray/src/PinEntity.ts:300

`Private` _setupAnimationBindingBlock

_setupAnimationBindingBlock(): void
アニメーションの BindingBlock を初期化

Returns void
- Defined in packages/mapray/src/PinEntity.ts:127

`Private` _setupByJson

_setupByJson(json: mapray.PinEntity.Json): void
Parameters
- json: mapray.PinEntity.Json
  
  Json
Returns void
- Defined in packages/mapray/src/PinEntity.ts:338

`Private` _unbindDescendantAnimations

_unbindDescendantAnimations(): void
EasyBindingBlock.DescendantUnbinder 処理

Returns void
- Defined in packages/mapray/src/PinEntity.ts:115

addMakiIconPin

addMakiIconPin(id: string, position: GeoPoint, props?: MakiIconPinEntryOption): MakiIconPinEntry
Add Maki Icon Pin

Returns
追加したEntry
Parameters
- id: string
  
  ID of Maki Icon
- position: GeoPoint
  
  位置
- Optional props: MakiIconPinEntryOption
  
  プロパティ
Returns MakiIconPinEntry
- Defined in packages/mapray/src/PinEntity.ts:232

addPin

addPin(position: GeoPoint, props?: AbstractPinEntryOption): TextPinEntry
Add Pin

Returns
追加したEntry
Parameters
- position: GeoPoint
  
  位置
- Optional props: AbstractPinEntryOption
  
  プロパティ
Returns TextPinEntry
- Defined in packages/mapray/src/PinEntity.ts:220

addTextPin

addTextPin(text: string, position: GeoPoint, props?: TextPinEntryOption): TextPinEntry
Add Text Pin

Returns
追加したEntry
Parameters
- text: string
  
  ピンに表示されるテキスト
- position: GeoPoint
  
  位置
- Optional props: TextPinEntryOption
  
  プロパティ
Returns TextPinEntry
- Defined in packages/mapray/src/PinEntity.ts:247

getBounds

getBounds(): GeoRegion
すべてのEntryのバウンディングを算出

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

Returns GeoRegion
Inherited from AbstractPointEntity.getBounds
- Defined in packages/mapray/src/AbstractPointEntity.ts:37

getEntry

getEntry(id: string): undefined | TextPinEntry | MakiIconPinEntry
IDでEntryを取得

Returns
IDが一致するEntry（なければ undefined を返す）。
Parameters
- id: string
  
  ID
Returns undefined | TextPinEntry | MakiIconPinEntry
- Defined in packages/mapray/src/PinEntity.ts:379

getFlakePrimitiveProducer

getFlakePrimitiveProducer(): undefined | FlakePrimitiveProducer
FlakePrimitiveProducer インタフェースを取得

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

既定の実装は undefined を返す。

Returns
FlakePrimitiveProducer インタフェース

Returns undefined | FlakePrimitiveProducer
Inherited from AbstractPointEntity.getFlakePrimitiveProducer
- Defined in packages/mapray/src/Entity.ts:190

getPrimitiveProducer

getPrimitiveProducer(): mapray.PinEntity.PrimitiveProducer
Returns mapray.PinEntity.PrimitiveProducer
Overrides AbstractPointEntity.getPrimitiveProducer
- Defined in packages/mapray/src/PinEntity.ts:97

isPickable

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

Returns boolean
Inherited from AbstractPointEntity.isPickable
- Defined in packages/mapray/src/Entity.ts:206

`Protected` onChangeAltitudeMode

onChangeAltitudeMode(prev_mode: AltitudeMode): void
Parameters
- prev_mode: AltitudeMode
Returns void
Overrides AbstractPointEntity.onChangeAltitudeMode
- Defined in packages/mapray/src/PinEntity.ts:106

setBGColor

setBGColor(color: Vector3): void
アイコン背景の色を設定
Parameters
- color: Vector3
  
  アイコン背景の色
Returns void
- Defined in packages/mapray/src/PinEntity.ts:198

setFGColor

setFGColor(color: Vector3): void
アイコンの色を設定
Parameters
- color: Vector3
  
  アイコンの色
Returns void
- Defined in packages/mapray/src/PinEntity.ts:188

setFontFamily

setFontFamily(font_family: string): void
テキストアイコンのフォントを設定
Parameters
- font_family: string
  
  フォントファミリー
Returns void
- Defined in packages/mapray/src/PinEntity.ts:208

setPickable

setPickable(pickable: boolean): void
このEntityを Viewer.pick() による選択対象とするかを設定する。
Parameters
- pickable: boolean
  
  選択可能か否か
Returns void
Inherited from AbstractPointEntity.setPickable
- Defined in packages/mapray/src/Entity.ts:199

setSize

setSize(size: Vector2): void
アイコンのピクセルサイズを指定
Parameters
- size: Vector2
  
  アイコンのピクセルサイズ
Returns void
- Defined in packages/mapray/src/PinEntity.ts:178

setVisibility

setVisibility(visibility: boolean): void
可視性フラグを設定
Parameters
- visibility: boolean
  
  可視性フラグ
Returns void
Inherited from AbstractPointEntity.setVisibility
- Defined in packages/mapray/src/Entity.ts:88

Class PinEntity

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

scene: mapray.Scene

Optional opts: mapray.PinEntity.Option

Returns PinEntity

Properties

Protected _altitude_mode

Protected _anchor_mode

Protected _animation

Protected _entries

Protected _need_to_create_regions

Private _parent_props

Protected _pickable

Private _primitive_producer

Protected _visibility

Readonly scene

Static CIRCLE_SEP_LENGTH

Static DEFAULT_BG_COLOR

Static DEFAULT_FG_COLOR

Static DEFAULT_FONT_FAMILY

Static DEFAULT_SIZE

Static MAX_IMAGE_WIDTH

Static Readonly SAFETY_PIXEL_MARGIN

Accessors

altitude_mode

Returns AltitudeMode

Parameters

value: AltitudeMode

Returns void

animation

Returns any

visibility

Returns boolean

Methods

Private _getMaterial

Parameters

render_target: RenderTarget

Returns object

Private _setValueProperty

Parameters

name: string

value: string

Returns void

Private _setVector2Property

Parameters

name: string

value: Vector2

Returns void

Private _setVector3Property

Parameters

name: string

value: Vector3

Returns void

Private _setupAnimationBindingBlock

Returns void

Private _setupByJson

Parameters

json: mapray.PinEntity.Json

Returns void

Private _unbindDescendantAnimations

Returns void

addMakiIconPin

Returns

Parameters

id: string

position: GeoPoint

Optional props: MakiIconPinEntryOption

Returns MakiIconPinEntry

addPin

Returns

Parameters

`Optional` opts: mapray.PinEntity.Option

`Protected` _altitude_mode

`Protected` _anchor_mode

`Protected` _animation

`Protected` _entries

`Protected` _need_to_create_regions

`Private` _parent_props

`Protected` _pickable

`Private` _primitive_producer

`Protected` _visibility

`Readonly` scene

`Static` CIRCLE_SEP_LENGTH

`Static` DEFAULT_BG_COLOR

`Static` DEFAULT_FG_COLOR

`Static` DEFAULT_FONT_FAMILY

`Static` DEFAULT_SIZE

`Static` MAX_IMAGE_WIDTH

`Static` `Readonly` SAFETY_PIXEL_MARGIN

`Private` _getMaterial

`Private` _setValueProperty

`Private` _setVector2Property

`Private` _setVector3Property

`Private` _setupAnimationBindingBlock

`Private` _setupByJson

`Private` _unbindDescendantAnimations

`Optional` props: MakiIconPinEntryOption

`Optional` props: AbstractPinEntryOption

`Optional` props: TextPinEntryOption

`Protected` onChangeAltitudeMode