Class ImageIconEntity

画像アイコンエンティティ

Hierarchy (view full)

AbstractPointEntity<ImageEntry>
- ImageIconEntity

Constructors

constructor

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

Properties

`Private` _alpha_clip_threshold

_alpha_clip_threshold: number

`Private` _alpha_clipping

_alpha_clipping: boolean

`Protected` _altitude_mode

_altitude_mode: AltitudeMode = AltitudeMode.ABSOLUTE

高度モード

`Protected` _anchor_mode

_anchor_mode: boolean = false

アンカーモード

`Protected` _animation

_animation: any = ...

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

`Protected` _entries

_entries: ImageEntry[]

要素管理

`Private` `Optional` _mask_color

_mask_color?: Vector3

`Protected` _need_to_create_regions

_need_to_create_regions: boolean = false

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

`Private` _parent_props

_parent_props: Props

`Protected` _pickable

_pickable: boolean = true

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

`Private` _primitive_producer

_primitive_producer: PrimitiveProducer

`Protected` _visibility

_visibility: boolean = true

表示状態を示すフラグ

`Readonly` scene

scene: mapray.Scene

所属可能シーン

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): 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): object
専用マテリアルを取得
Parameters
- render_target: RenderTarget
Returns object
- Defined in packages/mapray/src/ImageIconEntity.ts:184

`Private` _setValueProperty

_setValueProperty(name, value): void
Parameters
- name: string
- value: any
Returns void
- Defined in packages/mapray/src/ImageIconEntity.ts:207

`Private` _setVector2Property

_setVector2Property(name, value): void
Parameters
- name: string
- value: Vector2
Returns void
- Defined in packages/mapray/src/ImageIconEntity.ts:216

`Private` _setupAnimationBindingBlock

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

Returns void
- Defined in packages/mapray/src/ImageIconEntity.ts:106

`Private` _setupByJson

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

`Private` _unbindDescendantAnimations

_unbindDescendantAnimations(): void
EasyBindingBlock.DescendantUnbinder 処理

Returns void
- Defined in packages/mapray/src/ImageIconEntity.ts:94

addImageIcon

addImageIcon(image_src, position, props?): ImageEntry
Add Image Icon
Parameters
- image_src: string | HTMLCanvasElement | HTMLImageElement
  画像
- position: GeoPoint
  位置
- props: ImageEntryOption = {}
  プロパティ
Returns ImageEntry
追加したEntry
- Defined in packages/mapray/src/ImageIconEntity.ts:172

getBounds

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

Returns GeoRegion
バウンディング情報を持ったGeoRegion
Inherited from AbstractPointEntity.getBounds
- Defined in packages/mapray/src/AbstractPointEntity.ts:37

getEntry

getEntry(id): undefined | ImageEntry
IDでEntryを取得
Parameters
- id: string
  ID
Returns undefined | ImageEntry
IDが一致するEntry（無ければundefined）
- Defined in packages/mapray/src/ImageIconEntity.ts:248

getFlakePrimitiveProducer

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

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

既定の実装は undefined を返す。

Returns undefined | FlakePrimitiveProducer
FlakePrimitiveProducer インタフェース
Inherited from AbstractPointEntity.getFlakePrimitiveProducer
- Defined in packages/mapray/src/Entity.ts:190

getPrimitiveProducer

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

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): void
高度モードが変更された後の通知

this.altitude_mode が変更されたときに呼び出される。既定の実装は何もしない。
Parameters
- prev_mode: AltitudeMode
  直前のモード
Returns void
Inherited from AbstractPointEntity.onChangeAltitudeMode
- Defined in packages/mapray/src/Entity.ts:161

setOrigin

setOrigin(origin): void
アイコンの原点位置を指定
Parameters
- origin: Vector2
  アイコンの原点位置
Returns void
- Defined in packages/mapray/src/ImageIconEntity.ts:152

setPickable

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

setSize

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

setVisibility

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

Class ImageIconEntity

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

scene: mapray.Scene

opts: mapray.ImageIconEntity.Option = {}

Returns ImageIconEntity

Properties

Private _alpha_clip_threshold

Private _alpha_clipping

Protected _altitude_mode

Protected _anchor_mode

Protected _animation

Protected _entries

Private Optional _mask_color

Protected _need_to_create_regions

Private _parent_props

Protected _pickable

Private _primitive_producer

Protected _visibility

Readonly scene

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: any

Returns void

Private _setVector2Property

Parameters

name: string

value: Vector2

Returns void

Private _setupAnimationBindingBlock

Returns void

Private _setupByJson

Parameters

json: mapray.ImageIconEntity.Json

Returns void

Private _unbindDescendantAnimations

Returns void

addImageIcon

Parameters

image_src: string | HTMLCanvasElement | HTMLImageElement

position: GeoPoint

props: ImageEntryOption = {}

Returns ImageEntry

getBounds

Returns GeoRegion

getEntry

Parameters

id: string

Returns undefined | ImageEntry

getFlakePrimitiveProducer

Returns undefined | FlakePrimitiveProducer

getPrimitiveProducer

Returns PrimitiveProducer

isPickable

Returns boolean

Protected onChangeAltitudeMode

Parameters

`Private` _alpha_clip_threshold

`Private` _alpha_clipping

`Protected` _altitude_mode

`Protected` _anchor_mode

`Protected` _animation

`Protected` _entries

`Private` `Optional` _mask_color

`Protected` _need_to_create_regions

`Private` _parent_props

`Protected` _pickable

`Private` _primitive_producer

`Protected` _visibility

`Readonly` scene

`Private` _getMaterial

`Private` _setValueProperty

`Private` _setVector2Property

`Private` _setupAnimationBindingBlock

`Private` _setupByJson

`Private` _unbindDescendantAnimations

`Protected` onChangeAltitudeMode