Class TextEntity

テキストエンティティ

Hierarchy

AbstractPointEntity<TextEntry>
- TextEntity

Constructors

constructor

new TextEntity(scene: Scene, opts?: mapray.TextEntity.Option): TextEntity

Overrides AbstractPointEntity.constructor
- Defined in packages/mapray/src/TextEntity.ts:35
Parameters
- scene: Scene
  
  所属可能シーン
- opts: mapray.TextEntity.Option = {}
  
  オプション集合
Returns TextEntity

Properties

Protected _altitude_mode

_altitude_mode: AltitudeMode = AltitudeMode.ABSOLUTE

高度モード

Protected _animation

_animation: any = ...

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

Protected _entries

_entries: TextEntry[]

要素管理

Protected _need_to_create_regions

_need_to_create_regions: boolean = false

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

Protected _pickable

_pickable: boolean = true

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

Private Optional _primitive_producer

_primitive_producer?: mapray.TextEntity.PrimitiveProducer

Private _text_parent_props

_text_parent_props: ParentProps

Protected _visibility

_visibility: boolean = true

表示状態を示すフラグ

Readonly scene

scene: Scene

所属可能シーン

Accessors

altitude_mode

get altitude_mode(): AltitudeMode
set altitude_mode(value: AltitudeMode): void

Inherited from AbstractPointEntity.altitude_mode
- Defined in packages/mapray/src/Entity.ts:125
高度モード取得

Returns AltitudeMode
Inherited from AbstractPointEntity.altitude_mode
- Defined in packages/mapray/src/Entity.ts:112
高度モード設定

Parameters
- value: AltitudeMode
Returns void

animation

get animation(): any

Inherited from AbstractPointEntity.animation
- Defined in packages/mapray/src/Entity.ts:106
アニメーションパラメータ設定

Returns any

visibility

get visibility(): boolean

Inherited from AbstractPointEntity.visibility
- Defined in packages/mapray/src/Entity.ts:76
可視性フラグを取得

Returns boolean

Methods

Private _enableStroke

_enableStroke(): boolean

- Defined in packages/mapray/src/TextEntity.ts:355
Returns boolean

Private _getSimpleTextMaterial

_getSimpleTextMaterial(render_target: RenderTarget): object

- Defined in packages/mapray/src/TextEntity.ts:288
テキストだけを描画する専用マテリアルを取得

Parameters
- render_target: RenderTarget
Returns object

Private _getTextMaterial

_getTextMaterial(render_target: RenderTarget): object

- Defined in packages/mapray/src/TextEntity.ts:263
専用マテリアルを取得

Parameters
- render_target: RenderTarget
Returns object

Private _setColorProperty

_setColorProperty(name: string, value: Float64Array | Float32Array | [x: number, y: number, z: number] | [x: number, y: number, z: number, w: number]): void

- Defined in packages/mapray/src/TextEntity.ts:322
Parameters
- name: string
- value: Float64Array | Float32Array | [x: number, y: number, z: number] | [x: number, y: number, z: number, w: number]
Returns void

Private _setValueProperty

_setValueProperty(name: string, value: any): void

- Defined in packages/mapray/src/TextEntity.ts:310
Parameters
- name: string
- value: any
Returns void

Private _setupAnimationBindingBlock

_setupAnimationBindingBlock(): void

- Defined in packages/mapray/src/TextEntity.ts:94
アニメーションの BindingBlock を初期化

Returns void

Private _setupByJson

_setupByJson(json: mapray.TextEntity.Json): void

- Defined in packages/mapray/src/TextEntity.ts:334
Parameters
- json: mapray.TextEntity.Json
Returns void

Private _unbindDescendantAnimations

_unbindDescendantAnimations(): void

- Defined in packages/mapray/src/TextEntity.ts:82
EasyBindingBlock.DescendantUnbinder 処理

Returns void

addText

addText(text: string, position: GeoPoint, props: EntryOption): TextEntry

- Defined in packages/mapray/src/TextEntity.ts:250
テキストを追加

Parameters
- text: string
  
  テキスト
- position: GeoPoint
  
  位置
- props: EntryOption
  
  プロパティ
Returns TextEntry
追加したEntry

getBounds

getBounds(): GeoRegion

Inherited from AbstractPointEntity.getBounds
- Defined in packages/mapray/src/AbstractPointEntity.ts:37
すべてのEntryのバウンディングを算出

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

getEntry

getEntry(id: string): undefined | TextEntry

- Defined in packages/mapray/src/TextEntity.ts:366
IDでEntryを取得

Parameters
- id: string
  
  ID
Returns undefined | TextEntry
IDが一致するEntry（無ければundefined）

getFlakePrimitiveProducer

getFlakePrimitiveProducer(): undefined | FlakePrimitiveProducer

Inherited from AbstractPointEntity.getFlakePrimitiveProducer
- Defined in packages/mapray/src/Entity.ts:174
FlakePrimitiveProducer インタフェースを取得

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

既定の実装は undefined を返す。

Returns undefined | FlakePrimitiveProducer
FlakePrimitiveProducer インタフェース

getPrimitiveProducer

getPrimitiveProducer(): undefined | mapray.TextEntity.PrimitiveProducer

Overrides AbstractPointEntity.getPrimitiveProducer
- Defined in packages/mapray/src/TextEntity.ts:65
PrimitiveProducer インタフェースを取得

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

Returns undefined | mapray.TextEntity.PrimitiveProducer
PrimitiveProducer インタフェース

isPickable

isPickable(): boolean

Inherited from AbstractPointEntity.isPickable
- Defined in packages/mapray/src/Entity.ts:190
このEntityが Viewer.pick() による選択対象であるかを取得する。

Returns boolean

onChangeAltitudeMode

onChangeAltitudeMode(prev_mode: AltitudeMode): void

Overrides AbstractPointEntity.onChangeAltitudeMode
- Defined in packages/mapray/src/TextEntity.ts:71
高度モードが変更された後の通知

this.altitude_mode が変更されたときに呼び出される。既定の実装は何もしない。

Parameters
- prev_mode: AltitudeMode
Returns void

setBackgroundColor

setBackgroundColor(color: Float64Array | Float32Array | [x: number, y: number, z: number] | [x: number, y: number, z: number, w: number]): void

- Defined in packages/mapray/src/TextEntity.ts:228
テキスト背景の色を設定

Parameters
- color: Float64Array | Float32Array | [x: number, y: number, z: number] | [x: number, y: number, z: number, w: number]
  
  テキストの色
Returns void

setColor

setColor(color: Float64Array | Float32Array | [x: number, y: number, z: number] | [x: number, y: number, z: number, w: number]): void

- Defined in packages/mapray/src/TextEntity.ts:191
テキストの色を設定

Parameters
- color: Float64Array | Float32Array | [x: number, y: number, z: number] | [x: number, y: number, z: number, w: number]
  
  テキストの色
Returns void

setEnableBackground

setEnableBackground(enable: boolean): void

- Defined in packages/mapray/src/TextEntity.ts:237
テキスト背景を有効にするかどうか

Parameters
- enable: boolean
  
  trueなら有効
Returns void

setEnableStroke

setEnableStroke(enable: boolean): void

- Defined in packages/mapray/src/TextEntity.ts:218
テキスト縁を有効にするかどうか

Parameters
- enable: boolean
  
  trueなら有効
Returns void

setFontFamily

setFontFamily(family: string): void

- Defined in packages/mapray/src/TextEntity.ts:181
フォントファミリーを設定

see
https://developer.mozilla.org/ja/docs/Web/CSS/font-family

Parameters
- family: string
  
  フォントファミリー
Returns void

setFontSize

setFontSize(size: number): void

- Defined in packages/mapray/src/TextEntity.ts:170
フォントの大きさを設定

Parameters
- size: number
  
  フォントの大きさ (Pixels)
Returns void

setFontStyle

setFontStyle(style: FontStyle): void

- Defined in packages/mapray/src/TextEntity.ts:150
フォントスタイルを設定

Parameters
- style: FontStyle
  
  フォントスタイル
Returns void

setFontWeight

setFontWeight(weight: FontWeight): void

- Defined in packages/mapray/src/TextEntity.ts:160
summary
フォントの太さを設定

Parameters
- weight: FontWeight
  
  フォントの太さ
Returns void

setPickable

setPickable(pickable: boolean): void

Inherited from AbstractPointEntity.setPickable
- Defined in packages/mapray/src/Entity.ts:183
このEntityを Viewer.pick() による選択対象とするかを設定する。

Parameters
- pickable: boolean
  
  選択可能か否か
Returns void

setStrokeColor

setStrokeColor(color: Float64Array | Float32Array | [x: number, y: number, z: number] | [x: number, y: number, z: number, w: number]): void

- Defined in packages/mapray/src/TextEntity.ts:200
テキスト縁の色を設定

Parameters
- color: Float64Array | Float32Array | [x: number, y: number, z: number] | [x: number, y: number, z: number, w: number]
  
  縁の色
Returns void

setStrokeLineWidth

setStrokeLineWidth(width: number): void

- Defined in packages/mapray/src/TextEntity.ts:209
テキスト縁の太さを設定

Parameters
- width: number
  
  縁の線幅
Returns void

setVisibility

setVisibility(visibility: boolean): void

Inherited from AbstractPointEntity.setVisibility
- Defined in packages/mapray/src/Entity.ts:83
可視性フラグを設定

Parameters
- visibility: boolean
  
  可視性フラグ
Returns void