Class MxDbText

MxDbText 绘制文字

Describe

适用于标签标注类型的文字(永远面向相机的平面)

Example

 obj = new MxDbText()
   obj.rxInit()
   obj.position = new THREE.Vector3()
   obj.backgroundColor = '#ff0000'
   obj.padding = 5
   obj.strokeWidth = 3
   obj.strokeColor = "#3a8bd2"
   obj.borderColor = "#ff00ff"
   obj.borderWidth = 2
   obj.borderRadius = 2
   obj.opacity = 0.8
   obj.text  = 'This is\nsome multi-line\ntext'
   obj.height = 100000
   obj.color = "#fff000"

Hierarchy (view full)

Constructors

constructor

Properties

_angle _backgroundColor _borderColor _borderRadius _borderWidth _fontFace _fontSize _fontWeight _height _padding _scale _strokeColor _strokeWidth _text _textAlign _textShadowBlur _textShadowColor _textShadowOffsetX _textShadowOffsetY _underline addEvent children color dDashArray dDashRatio dLineWidth events layer lineWidthByPixels opacity parent position removeEvent renderOrder sGuid spriteText use_smallcoord_display userData visible cmd draw isRegister

Accessors

angle backgroundColor borderColor borderRadius borderWidth fontFace fontSize fontWeight height padding scale strokeColor strokeWidth text textAlign textShadowBlur textShadowColor textShadowOffsetX textShadowOffsetY underline

Methods

add bottom clear clone create createSpriteText dwgIn dwgInHelp dwgOut dwgOutHelp emit erase fromJsonString getClosestPointTo getColor getDash getGeomExtents getGetLength getGripPoints getLayer getLineWidth getLineWidthByPixels getMxObject getNodeByProperty getNodesByProperty getRenderOrder getTypeName guid initGuid isDashLineDisplay isUseSmallcoordDisplay moveGripPointsAt objectId off on onDwgIn onDwgOut onEndGripEidt onStartGripEidt onViewChange remove removeFromParent restoreDefaultRenderOrder rxInit setAngle setBackgroundColor setBorderColor setBorderRadius setBorderWidth setColor setDash setDashArray setDashLen setDashLineDisplay setDashRatio setFontFace setFontSize setFontWeight setGuid setHeight setLayer setLineWidth setLineWidthByPixels setNeedUpdateDisplay setPadding setPosition setRenderOrder setScale setStrokeColor setStrokeWidth setText setTextAlign setTextShadowBlur setTextShadowColor setTextShadowOffsetX setTextShadowOffsetY setUnderline setUseSmallcoordDisplay toJsonString toSmallcoord toSmallcoord2 top transformBy transformMove transformRotate transformScale traverse traverseParent worldDraw register use

Constructors

constructor

Properties

Private _angle

_angle: number = 0

Private _backgroundColor

_backgroundColor: SpriteTextColorType

Private _borderColor

_borderColor: SpriteTextColorType

Private _borderRadius

_borderRadius: number

Private _borderWidth

_borderWidth: number

Private _fontFace

_fontFace: string

Private _fontSize

_fontSize: number

Private _fontWeight

_fontWeight: TextFontWeight

Private _height

_height: number = 16

Private _padding

_padding: number | number[]

Private _scale

_scale: number = 1

Private _strokeColor

_strokeColor: SpriteTextColorType

Private _strokeWidth

_strokeWidth: number

Private _text

_text: string = ''

Private _textAlign

_textAlign: CanvasTextAlign

Private _textShadowBlur

_textShadowBlur: number

Private _textShadowColor

_textShadowColor: undefined | string | number | Color

Private _textShadowOffsetX

_textShadowOffsetX: number

Private _textShadowOffsetY

_textShadowOffsetY: number

Private _underline

_underline: boolean = false

addEvent

addEvent: (<Key>(event, callback) => void) = ...

添加一个事件处理

Type declaration

    • <Key>(event, callback): void

    • Type Parameters

      • Key extends (keyof MxDbEntityEventsType) | (keyof RendererEventsType)

      Parameters

      • event: Key
      • callback: (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void)

      Returns void

Returns

void

children

children: (MxDbEntity | MxDbText)[] = []

它的子节点集合

color

color: UnstableColor = 0xffffff

颜色值

dDashArray

dDashArray: number = 0

dDashRatio

dDashRatio: number = 0

dLineWidth

dLineWidth: number = 0

events

events: {
    [x: EventType]: Events[keyof Events][];
}

Type declaration

layer

layer: string = ''

lineWidthByPixels

lineWidthByPixels: boolean = true

opacity

opacity: number = 1

设置透明度 0 ~ 1,1表示完全不透明，0表示全透明.

parent

parent: null | MxDbEntity | MxDbText = null

它的父节点

position

position: Vector3 = ...

文字所在位置

removeEvent

removeEvent: (<Key>(event, callback?) => void) = ...

删除一个事件处理

Type declaration

    • <Key>(event, callback?): void

    • Type Parameters

      • Key extends (keyof MxDbEntityEventsType) | (keyof RendererEventsType)

      Parameters

      • event: Key
      • Optional callback: (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void)

      Returns void

Returns

void

renderOrder

renderOrder: number = 30

显示顺序

Protected sGuid

sGuid: string = ''

Protected spriteText

spriteText: SpriteText

SpriteText实例

Protected use_smallcoord_display

use_smallcoord_display: boolean = false

userData

userData: {
    [key: string]: any;
} = {}

用户自定义数据.

Type declaration

  • [key: string]: any

visible

visible: boolean = true

该对象是否可见

Static cmd

cmd: string = 'Mx_Text'

该类注册的cmd命令名称

Static draw

draw: (() => Promise<void>) = drawMxDbText

该类注册的cmd命令绘制函数

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

Static isRegister

isRegister: boolean = false

该类是否已注册

Accessors

angle

  • get angle(): number

  • 角度

    Returns number

  • set angle(angle): void

  • Parameters

    • angle: number

    Returns void

backgroundColor

borderColor

borderRadius

  • get borderRadius(): number

  • 边框圆角

    Returns number

  • set borderRadius(borderRadius): void

  • Parameters

    • borderRadius: number

    Returns void

borderWidth

  • get borderWidth(): number

  • 边框宽度

    Returns number

  • set borderWidth(borderWidth): void

  • Parameters

    • borderWidth: number

    Returns void

fontFace

  • get fontFace(): string

  • 客户端字体

    Returns string

  • set fontFace(fontFace): void

  • Parameters

    • fontFace: string

    Returns void

fontSize

  • get fontSize(): number

  • 字体大小

    Returns number

  • set fontSize(fontSize): void

  • Parameters

    • fontSize: number

    Returns void

fontWeight

height

  • get height(): number

  • 文字高度

    Returns number

  • set height(height): void

  • Parameters

    • height: number

    Returns void

padding

  • get padding(): number | number[]

  • 填充范围

    Returns number | number[]

  • set padding(padding): void

  • Parameters

    • padding: number | number[]

    Returns void

scale

  • get scale(): number

  • 缩放倍数

    Returns number

  • set scale(scale): void

  • Parameters

    • scale: number

    Returns void

strokeColor

strokeWidth

  • get strokeWidth(): number

  • 笔划宽度

    Returns number

  • set strokeWidth(strokeWidth): void

  • Parameters

    • strokeWidth: number

    Returns void

text

  • get text(): string

  • 文字内容

    Returns string

  • set text(text): void

  • Parameters

    • text: string

    Returns void

textAlign

  • get textAlign(): CanvasTextAlign

  • 文本格式

    Returns CanvasTextAlign

  • set textAlign(textAlign): void

  • Parameters

    • textAlign: CanvasTextAlign

    Returns void

textShadowBlur

  • get textShadowBlur(): number

  • 文字阴影模糊程度

    Returns number

  • set textShadowBlur(textShadowBlur): void

  • Parameters

    • textShadowBlur: number

    Returns void

textShadowColor

  • get textShadowColor(): undefined | string | number | Color

  • 文字阴影颜色

    Returns undefined | string | number | Color

  • set textShadowColor(textShadowColor): void

  • Parameters

    • textShadowColor: undefined | string | number | Color

    Returns void

textShadowOffsetX

  • get textShadowOffsetX(): number

  • 文字阴影X轴偏移量

    Returns number

  • set textShadowOffsetX(textShadowOffsetX): void

  • Parameters

    • textShadowOffsetX: number

    Returns void

textShadowOffsetY

  • get textShadowOffsetY(): number

  • 文字阴影X轴偏移量

    Returns number

  • set textShadowOffsetY(textShadowOffsetY): void

  • Parameters

    • textShadowOffsetY: number

    Returns void

underline

  • get underline(): boolean

  • 下划线

    Returns boolean

  • set underline(underline): void

  • Parameters

    • underline: boolean

    Returns void

Methods

add

bottom

  • bottom(): void

  • bottom 同层级下最上层

    Returns void

clear

clone

  • clone(type?): any

  • 复制克隆对象。

    Parameters

    • Optional type: number

      MxType.MxCloneType 传入参数区分是正常拷贝还是动态拷贝

    Returns any

    MxDbEntity

create

Protected createSpriteText

  • createSpriteText(): void

  • 创建精灵文字对象

    Returns void

dwgIn

  • dwgIn(obj): boolean

  • 自定义对象数据输入，必须要实现该函数

    Parameters

    • obj: any

    Returns boolean

    boolean

    Example

     class MxLine extends MxDbEntity {
       dwgIn(obj) {
           // 必须调用 同步自定义数据对象输入
          this.onDwgIn(obj)
       }
     }

Protected dwgInHelp

  • dwgInHelp<T>(obj, aryProp, hooks?): boolean

  • 自定义对象数据输入，辅助函数.

    Type Parameters

    • T extends (string | {
          default: any;
          key: string;
      })[]

    Parameters

    • obj: any

      数据对象

    • aryProp: T

      属性名称列表

    • Optional hooks: {
          getCacheVal?: ((v) => any);
          getVal?: ((v) => any);
      }
      • Optional getCacheVal?: ((v) => any)

        归档数据构子函数 return null | undefined 默认深拷贝 ; return Value 返回数据

          • (v): any

          • Parameters

            • v: any

            Returns any

      • Optional getVal?: ((v) => any)

        交互数据输入钩子函数 return null | undefined 默认深拷贝 ; return Value 返回数据

          • (v): any

          • Parameters

            • v: any

            Returns any

    Returns boolean

    boolean

    Example

     class MxLine extends MxDbEntity {
       dwgIn(obj) {
           // 必须调用 同步自定义数据对象输入
          this.dwgInHelp(obj,["xxx"])
       }
     }

dwgOut

  • dwgOut(obj): object

  • 自定义对象数据输出，必须要实现该函数

    Parameters

    • obj: any

    Returns object

    object

    Example

     class MxLine extends MxDbEntity {
       dwgOut(obj) {
           // 必须调用 同步自定义数据对象输出
          this.onDwgOut(obj)
       }
     }

Protected dwgOutHelp

  • dwgOutHelp(obj, aryProp): any

  • 自定义对象数据输出 辅助函数.

    Parameters

    • obj: any
    • aryProp: (string | {
          default: any;
          key: string;
      })[]

    Returns any

    object

    Example

     class MxLine extends MxDbEntity {
       dwgOut(obj) {
           // 必须调用 同步自定义数据对象输出
          this.dwgOutHelp(obj,["xxx"])
       }
     }

emit

erase

  • erase(): boolean

  • 删除对象

    Returns boolean

    boolean

fromJsonString

  • fromJsonString(str): boolean

  • 从一个josn字符串加载数据.

    Parameters

    • str: string

    Returns boolean

    void

getClosestPointTo

  • getClosestPointTo(pt, iOperationType?): null | Vector3

  • 对一个点到这个对象的最近点 。 iOperationType == 0正常操作求值最近点. iOperationType == 1点选择操作求值最近点.

    Parameters

    • pt: Vector3
    • iOperationType: number = 0

    Returns null | Vector3

    void

getColor

getDash

getGeomExtents

getGetLength

getGripPoints

  • getGripPoints(): Vector3[]

  • 返回自定义对象的夹点.

    Returns Vector3[]

    Array<THREE.Vector3>

getLayer

getLineWidth

getLineWidthByPixels

getMxObject

getNodeByProperty

  • getNodeByProperty<V>(name, value): undefined | MxDbEntity | MxDbText

  • 根据属性名称找到对应的Node节点

    Type Parameters

    • V = any

    Parameters

    • name: string

      属性名称

    • value: V

      属性值

    Returns undefined | MxDbEntity | MxDbText

    Example

    new Node().getNodeByProperty("id", "23548")

getNodesByProperty

getRenderOrder

getTypeName

guid

  • guid(): string

  • 返回唯一标识guid

    Returns string

    string

initGuid

isDashLineDisplay

isUseSmallcoordDisplay

moveGripPointsAt

  • moveGripPointsAt(index, offset): boolean

  • 移动自定义对象的夹点.

    Parameters

    • index: number
    • offset: Vector3

    Returns boolean

    boolean

objectId

  • objectId(): number

  • 得到对象的id.

    Returns number

    number

off

  • off<Key>(event, callback?): void

  • 销毁事件

    Type Parameters

    • Key extends (keyof MxDbEntityEventsType) | (keyof RendererEventsType)

    Parameters

    • event: Key

      事件名称

    • Optional callback: (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void)

      事件方法

    Returns void

on

  • on<Key>(event, callback): void

  • 订阅

    Type Parameters

    • Key extends (keyof MxDbEntityEventsType) | (keyof RendererEventsType)

    Parameters

    • event: Key

      事件名称

    • callback: (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void)

      事件回调

    Returns void

Protected onDwgIn

  • onDwgIn(obj): void

  • 自定义对象内部数据输入同步（重写实现dwgIn抽象方法时 必须在实现中调用 this.onDwgIn(obj)）

    Parameters

    • obj: any

      dwgIn抽象方法的回调数据

    Returns void

Protected onDwgOut

  • onDwgOut(obj): void

  • 自定义对象内部数据输出同步（重写实现dwgIn抽象方法 必须在实现中调用 this.onDwgIn(obj)

    Parameters

    • obj: any

      dwgOut抽象方法的回调数据

    Returns void

onEndGripEidt

onStartGripEidt

Protected onViewChange

  • onViewChange(): boolean

  • 视区显示比较发生成变化，继承类可以向应该事件，更新显示大小。

    Returns boolean

    boolean

remove

removeFromParent

restoreDefaultRenderOrder

rxInit

  • rxInit(): void

  • 初始自定义对象的类型信息.(如果需要实现该图形对象的保存数据和恢复数据的功能, 需要在项目中初始化一次该图形对象的类)

    Returns void

setAngle

setBackgroundColor

setBorderColor

setBorderRadius

  • setBorderRadius(borderRadius): MxDbText

  • Parameters

    • borderRadius: number

    Returns MxDbText

setBorderWidth

  • setBorderWidth(borderWidth): MxDbText

  • Parameters

    • borderWidth: number

    Returns MxDbText

setColor

setDash

setDashArray

setDashLen

  • setDashLen(dashLen): MxDbText

  • 设置虚线 +实线的长度. dDashRatio确定虚线，与实线的比率.

    Parameters

    • dashLen: number

    Returns MxDbText

    number

setDashLineDisplay

setDashRatio

setFontFace

setFontSize

setFontWeight

setGuid

  • setGuid(val): string

  • 修改唯一标识guid

    Parameters

    • val: string

    Returns string

    string

setHeight

setLayer

  • setLayer(layer): void

  • 设置图层

    Parameters

    • layer: string

    Returns void

    boolean

setLineWidth

setLineWidthByPixels

setNeedUpdateDisplay

  • setNeedUpdateDisplay(isImmediate?): boolean

  • 更新显示

    Parameters

    • Optional isImmediate: boolean

    Returns boolean

    boolean

setPadding

  • setPadding(padding): MxDbText

  • Parameters

    • padding: number | number[]

    Returns MxDbText

setPosition

setRenderOrder

  • setRenderOrder(renderOrder): void

  • 设置显示顺序 (通过显示顺序控制图层)

    Parameters

    • renderOrder: number

      显示顺序

    Returns void

setScale

setStrokeColor

setStrokeWidth

  • setStrokeWidth(strokeWidth): MxDbText

  • Parameters

    • strokeWidth: number

    Returns MxDbText

setText

setTextAlign

  • setTextAlign(textAlign): MxDbText

  • Parameters

    • textAlign: CanvasTextAlign

    Returns MxDbText

setTextShadowBlur

  • setTextShadowBlur(textShadowBlur): MxDbText

  • Parameters

    • textShadowBlur: number

    Returns MxDbText

setTextShadowColor

  • setTextShadowColor(textShadowColor): MxDbText

  • Parameters

    • textShadowColor: undefined | string | number | Color

    Returns MxDbText

setTextShadowOffsetX

  • setTextShadowOffsetX(textShadowOffsetX): MxDbText

  • Parameters

    • textShadowOffsetX: number

    Returns MxDbText

setTextShadowOffsetY

  • setTextShadowOffsetY(textShadowOffsetY): MxDbText

  • Parameters

    • textShadowOffsetY: number

    Returns MxDbText

setUnderline

  • setUnderline(underline): void

  • Parameters

    • underline: boolean

    Returns void

setUseSmallcoordDisplay

toJsonString

  • toJsonString(type?): string

  • 把一个对象变成一个json字体串.

    Parameters

    Returns string

    void

toSmallcoord

toSmallcoord2

top

  • top(): void

  • top 同层级下最上层 *

    Returns void

transformBy

  • transformBy(_mat): void

  • 自定义实体的矩阵 坐标变换 (需要重写该方法实现如果通过矩阵对自定义实体进行操作 默认不会进行任何操作)

    Parameters

    • _mat: Matrix4

      THREE.Matrix4 变化矩阵

    Returns void

    void

transformMove

  • transformMove(ptMove): void

  • 移动对象

    Parameters

    • ptMove: Vector3

    Returns void

    void

transformRotate

  • transformRotate(ptBase, angle): void

  • 旋转对象

    Parameters

    • ptBase: Vector3
    • angle: number

    Returns void

    void

transformScale

  • transformScale(ptBase, scale): void

  • 缩放对像

    Parameters

    • ptBase: Vector3
    • scale: number

    Returns void

    void

traverse

  • traverse(callback): void

  • 遍历它的所有子节点包括孙子节点，直到它包含的节点全部遍历完成并都执行传入的方法

    Parameters

    • callback: ((node) => void)

      回调函数

        • (node): void

        • Parameters

          • node: this

          Returns void

    Returns void

traverseParent

  • traverseParent<V>(callback): void

  • 让它的父节点依次冒泡执行传入的方法的方法

    Type Parameters

    Parameters

    • callback: ((node) => boolean | void)

      回调函数，第一个参数是父节点, callback的返回值为false 将停止继续传递

        • (node): boolean | void

        • Parameters

          • node: V

          Returns boolean | void

    Returns void

worldDraw

Static register

  • register(): void

  • 注册该类的cmd命令和初始化 (引入该类时自动注册 当该类的isRegister为ture时表示已经注册)

    Returns void

Static use

  • use<T>(callback?, data?): Promise<T>

  • 使用该类的cmd命令 执行默认的绘制功能

    Type Parameters

    Parameters

    • Optional callback: ((obj) => any)
        • (obj): any

        • Parameters

          • obj: T

          Returns any

    • Optional data: any

    Returns Promise<T>

Settings

Member Visibility

Theme

On This Page

constructor_angle_backgroundColor_borderColor_borderRadius_borderWidth_fontFace_fontSize_fontWeight_height_padding_scale_strokeColor_strokeWidth_text_textAlign_textShadowBlur_textShadowColor_textShadowOffsetX_textShadowOffsetY_underlineaddEventchildrencolordDashArraydDashRatiodLineWidtheventslayerlineWidthByPixelsopacityparentpositionremoveEventrenderOrdersGuidspriteTextuse_smallcoord_displayuserDatavisiblecmddrawisRegisteranglebackgroundColorborderColorborderRadiusborderWidthfontFacefontSizefontWeightheightpaddingscalestrokeColorstrokeWidthtexttextAligntextShadowBlurtextShadowColortextShadowOffsetXtextShadowOffsetYunderlineaddbottomclearclonecreatecreateSpriteTextdwgIndwgInHelpdwgOutdwgOutHelpemiterasefromJsonStringgetClosestPointTogetColorgetDashgetGeomExtentsgetGetLengthgetGripPointsgetLayergetLineWidthgetLineWidthByPixelsgetMxObjectgetNodeByPropertygetNodesByPropertygetRenderOrdergetTypeNameguidinitGuidisDashLineDisplayisUseSmallcoordDisplaymoveGripPointsAtobjectIdoffononDwgInonDwgOutonEndGripEidtonStartGripEidtonViewChangeremoveremoveFromParentrestoreDefaultRenderOrderrxInitsetAnglesetBackgroundColorsetBorderColorsetBorderRadiussetBorderWidthsetColorsetDashsetDashArraysetDashLensetDashLineDisplaysetDashRatiosetFontFacesetFontSizesetFontWeightsetGuidsetHeightsetLayersetLineWidthsetLineWidthByPixelssetNeedUpdateDisplaysetPaddingsetPositionsetRenderOrdersetScalesetStrokeColorsetStrokeWidthsetTextsetTextAlignsetTextShadowBlursetTextShadowColorsetTextShadowOffsetXsetTextShadowOffsetYsetUnderlinesetUseSmallcoordDisplaytoJsonStringtoSmallcoordtoSmallcoord2toptransformBytransformMovetransformRotatetransformScaletraversetraverseParentworldDrawregisteruse