Class TextEntity

テキストエンティティ

Hierarchy

AbstractPointEntity<TextEntry>
- TextEntity

Constructors

constructor

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

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: 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: 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: 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` _enableStroke

_enableStroke(): boolean
Returns boolean
- Defined in packages/mapray/src/TextEntity.ts:356

`Private` _getSimpleTextMaterial

_getSimpleTextMaterial(render_target: RenderTarget): object
テキストだけを描画する専用マテリアルを取得
Parameters
- render_target: RenderTarget
Returns object
- Defined in packages/mapray/src/TextEntity.ts:289

`Private` _getTextMaterial

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

`Private` _setColorProperty

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

`Private` _setValueProperty

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

`Private` _setupAnimationBindingBlock

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

Returns void
- Defined in packages/mapray/src/TextEntity.ts:95

`Private` _setupByJson

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

`Private` _unbindDescendantAnimations

_unbindDescendantAnimations(): void
EasyBindingBlock.DescendantUnbinder 処理

Returns void
- Defined in packages/mapray/src/TextEntity.ts:83

addText

addText(text: string, position: GeoPoint, props: EntryOption): TextEntry
テキストを追加

Returns
追加したEntry
Parameters
- text: string
  
  テキスト
- position: GeoPoint
  
  位置
- props: EntryOption
  
  プロパティ
Returns TextEntry
- Defined in packages/mapray/src/TextEntity.ts:251

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 | TextEntry
IDでEntryを取得

Returns
IDが一致するEntry（無ければundefined）
Parameters
- id: string
  
  ID
Returns undefined | TextEntry
- Defined in packages/mapray/src/TextEntity.ts:367

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(): undefined | mapray.TextEntity.PrimitiveProducer
PrimitiveProducer インタフェースを取得

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

Returns
PrimitiveProducer インタフェース

Returns undefined | mapray.TextEntity.PrimitiveProducer
Overrides AbstractPointEntity.getPrimitiveProducer
- Defined in packages/mapray/src/TextEntity.ts:66

isPickable

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

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

onChangeAltitudeMode

onChangeAltitudeMode(prev_mode: AltitudeMode): void
高度モードが変更された後の通知

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

setBackgroundColor

setBackgroundColor(color: Float32Array | Float64Array | [x: number, y: number, z: number, w: number] | [x: number, y: number, z: number]): void
テキスト背景の色を設定
Parameters
- color: Float32Array | Float64Array | [x: number, y: number, z: number, w: number] | [x: number, y: number, z: number]
  
  テキストの色
Returns void
- Defined in packages/mapray/src/TextEntity.ts:229

setColor

setColor(color: Float32Array | Float64Array | [x: number, y: number, z: number, w: number] | [x: number, y: number, z: number]): void
テキストの色を設定
Parameters
- color: Float32Array | Float64Array | [x: number, y: number, z: number, w: number] | [x: number, y: number, z: number]
  
  テキストの色
Returns void
- Defined in packages/mapray/src/TextEntity.ts:192

setEnableBackground

setEnableBackground(enable: boolean): void
テキスト背景を有効にするかどうか
Parameters
- enable: boolean
  
  trueなら有効
Returns void
- Defined in packages/mapray/src/TextEntity.ts:238

setEnableStroke

setEnableStroke(enable: boolean): void
テキスト縁を有効にするかどうか
Parameters
- enable: boolean
  
  trueなら有効
Returns void
- Defined in packages/mapray/src/TextEntity.ts:219

setFontFamily

setFontFamily(family: string): void
フォントファミリーを設定

See
https://developer.mozilla.org/ja/docs/Web/CSS/font-family
Parameters
- family: string
  
  フォントファミリー
Returns void
- Defined in packages/mapray/src/TextEntity.ts:182

setFontSize

setFontSize(size: number): void
フォントの大きさを設定
Parameters
- size: number
  
  フォントの大きさ (Pixels)
Returns void
- Defined in packages/mapray/src/TextEntity.ts:171

setFontStyle

setFontStyle(style: FontStyle): void
フォントスタイルを設定
Parameters
- style: FontStyle
  
  フォントスタイル
Returns void
- Defined in packages/mapray/src/TextEntity.ts:151

setFontWeight

setFontWeight(weight: FontWeight): void
Summary
フォントの太さを設定
Parameters
- weight: FontWeight
  
  フォントの太さ
Returns void
- Defined in packages/mapray/src/TextEntity.ts:161

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

setStrokeColor

setStrokeColor(color: Float32Array | Float64Array | [x: number, y: number, z: number, w: number] | [x: number, y: number, z: number]): void
テキスト縁の色を設定
Parameters
- color: Float32Array | Float64Array | [x: number, y: number, z: number, w: number] | [x: number, y: number, z: number]
  
  縁の色
Returns void
- Defined in packages/mapray/src/TextEntity.ts:201

setStrokeLineWidth

setStrokeLineWidth(width: number): void
テキスト縁の太さを設定
Parameters
- width: number
  
  縁の線幅
Returns void
- Defined in packages/mapray/src/TextEntity.ts:210

setVisibility

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

Class TextEntity

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

scene: mapray.Scene

opts: mapray.TextEntity.Option = {}

Returns TextEntity

Properties

Protected _altitude_mode

Protected _anchor_mode

Protected _animation

Protected _entries

Protected _need_to_create_regions

Protected _pickable

Private Optional _primitive_producer

Private _text_parent_props

Protected _visibility

Readonly scene

Accessors

altitude_mode

Returns AltitudeMode

Parameters

value: AltitudeMode

Returns void

animation

Returns any

visibility

Returns boolean

Methods

Private _enableStroke

Returns boolean

Private _getSimpleTextMaterial

Parameters

render_target: RenderTarget

Returns object

Private _getTextMaterial

Parameters

render_target: RenderTarget

Returns object

Private _setColorProperty

Parameters

name: string

value: Float32Array | Float64Array | [x: number, y: number, z: number, w: number] | [x: number, y: number, z: number]

Returns void

Private _setValueProperty

Parameters

name: string

value: any

Returns void

Private _setupAnimationBindingBlock

Returns void

Private _setupByJson

Parameters

json: mapray.TextEntity.Json

Returns void

Private _unbindDescendantAnimations

Returns void

addText

Returns

Parameters

text: string

position: GeoPoint

props: EntryOption

Returns TextEntry

getBounds

Returns

Returns GeoRegion

getEntry

Returns

Parameters

id: string

Returns undefined | TextEntry

getFlakePrimitiveProducer

Returns

`Protected` _altitude_mode

`Protected` _anchor_mode

`Protected` _animation

`Protected` _entries

`Protected` _need_to_create_regions

`Protected` _pickable

`Private` `Optional` _primitive_producer

`Private` _text_parent_props

`Protected` _visibility

`Readonly` scene

`Private` _enableStroke

`Private` _getSimpleTextMaterial

`Private` _getTextMaterial

`Private` _setColorProperty

`Private` _setValueProperty

`Private` _setupAnimationBindingBlock

`Private` _setupByJson

`Private` _unbindDescendantAnimations