MxDbEntity | Mx - v0.1.236

Index

Constructors

constructor

Properties

Constructors

constructor

new MxDbEntity(): MxDbEntity

Overrides RenderOrderNode.constructor
Returns MxDbEntity

Properties

addEvent

Type declaration

- <Key>(event: Key, callback: (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void)): void
- 订阅
  
  Type Parameters
  - Key extends keyof MxDbEntityEventsType | keyof RendererEventsType
  Parameters
  - event: Key
    
    事件名称
  - callback: (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void)
    
    事件回调
  Returns void
  void

Private callEvent

callEvent: (<Key>(event: number | Key, ...data: Parameters<(MxDbEntityEventsType & RendererEventsType)[Key]>) => void) = ...

Type declaration

- <Key>(event: number | Key, ...data: Parameters<(MxDbEntityEventsType & RendererEventsType)[Key]>): void
- 发布
  
  Type Parameters
  - Key extends keyof MxDbEntityEventsType | keyof RendererEventsType
  Parameters
  - event: number | Key
    
    — 事件名称
  - Rest ...data: Parameters<(MxDbEntityEventsType & RendererEventsType)[Key]>
    
    — 载荷
  Returns void

children

children: MxDbEntity[] = []

它的子节点集合

color

color: UnstableColor = 0xffffff

颜色值

dDashArray

dDashArray: number = 0

dDashRatio

dDashRatio: number = 0

dLineWidth

dLineWidth: number = 0

events

events: {}

Type declaration

[x: EventType]: Events[keyof Events][]

layer

layer: string = ''

lineWidthByPixels

lineWidthByPixels: boolean = true

opacity

opacity: number = 1

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

parent

parent: null | MxDbEntity = null

它的父节点

removeEvent

Type declaration

- <Key>(event: Key, callback?: (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void)): 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
  void

renderOrder

renderOrder: number = 30

显示顺序

Protected sGuid

sGuid: string = ''

Protected use_smallcoord_display

use_smallcoord_display: boolean = false

userData

userData: {} = {}

用户自定义数据.

Type declaration

[key: string]: any

visible

visible: boolean = true

该对象是否可见

Static cmd

cmd: string

该类注册的cmd命令名称

Static draw

draw: Function

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

Static isRegister

isRegister: boolean = false

该类是否已注册

Methods

add

add(...ages: MxDbEntity[]): MxDbEntity

Inherited from RenderOrderNode.add

添加子节点

Parameters
- Rest ...ages: MxDbEntity[]
Returns MxDbEntity

bottom

bottom(): void

Inherited from RenderOrderNode.bottom

bottom 同层级下最上层

Returns void

clear

clear(): MxDbEntity

Inherited from RenderOrderNode.clear

清除 children

Returns MxDbEntity

clone

clone(type?: number): any

复制克隆对象。

Parameters
- Optional type: number
  
  MxType.MxCloneType 传入参数区分是正常拷贝还是动态拷贝
Returns any
MxDbEntity

create

create(options?: {}): any

新创建一个自定义对象 (默认调用该对象的构造函数来创建新的对象)

Parameters
- Optional options: {}
Returns any
MxDbEntity

Abstract dwgIn

dwgIn(obj: { type: MxCloneType }): boolean

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

example

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

Parameters

obj: { type: MxCloneType }
- [x: string]: any
- type: MxCloneType

Returns boolean

boolean

Protected dwgInHelp

dwgInHelp<T>(obj: any, aryProp: T, hooks?: { getCacheVal?: any; getVal?: any }): boolean

自定义对象数据输入，辅助函数.
example
```
 class MxLine extends MxDbEntity {
   dwgIn(obj) {
       // 必须调用 同步自定义数据对象输入
      this.dwgInHelp(obj,["xxx"])
   }
 }
```
Type Parameters
- T extends (string | { default: any; key: string })[]
Parameters
- obj: any
  
  数据对象
- aryProp: T
  
  属性名称列表
- Optional hooks: { getCacheVal?: any; getVal?: any }
  - getCacheVal?:function
    - getCacheVal(v: any): any
    - 归档数据构子函数 return null | undefined 默认深拷贝 ; return Value 返回数据
      
      Parameters
      - v: any
      Returns any
  - getVal?:function
    - getVal(v: any): any
    - 交互数据输入钩子函数 return null | undefined 默认深拷贝 ; return Value 返回数据
      
      Parameters
      - v: any
      Returns any
Returns boolean
boolean

Abstract dwgOut

dwgOut(obj: { type: MxCloneType }): object

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

example

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

Parameters

obj: { type: MxCloneType }
- [x: string]: any
- type: MxCloneType

Returns object

object

Protected dwgOutHelp

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

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

example

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

Parameters

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

Returns any

object

emit

emit<Key>(event: number | Key, ...data: Parameters<(MxDbEntityEventsType & RendererEventsType)[Key]>): void

Inherited from RenderOrderNode.emit

发布

Type Parameters
- Key extends keyof MxDbEntityEventsType | keyof RendererEventsType
Parameters
- event: number | Key
  
  — 事件名称
- Rest ...data: Parameters<(MxDbEntityEventsType & RendererEventsType)[Key]>
  
  — 载荷
Returns void

erase

erase(): boolean

删除对象

Returns boolean
boolean

fromJsonString

fromJsonString(str: string): boolean

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

Parameters
- str: string
Returns boolean
void

getClosestPointTo

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

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

Parameters
- pt: Vector3
- iOperationType: number = 0
Returns null | Vector3
void

getColor

getColor(): MxColorType

得到颜色

Returns MxColorType
boolean

getDash

getDash(): any

得到虚线数据

Returns any
number

getGeomExtents

getGeomExtents(): null | Box3

返回对象最小外包.

Returns null | Box3
void

getGetLength

getGetLength(): number

返回曲线长度

Returns number
number

Abstract getGripPoints

getGripPoints(): Vector3[]

返回自定义对象的夹点.

Returns Vector3[]
Array<THREE.Vector3>

Private getImp

getImp(): any

Returns any

getLayer

getLayer(): string

得到图层

Returns string
boolean

getLineWidth

getLineWidth(): number

得到线宽

Returns number
number

getLineWidthByPixels

getLineWidthByPixels(): boolean

线宽是否随像素

Returns boolean
number

getMxObject

getMxObject(): null | MxDrawObject

返回对象所在的控件对象。

Returns null | MxDrawObject
MxDrawObject

getNodeByProperty

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

Inherited from RenderOrderNode.getNodeByProperty
根据属性名称找到对应的Node节点
example
```
new Node().getNodeByProperty("id", "23548")
```
Type Parameters
- V = any
Parameters
- name: string
  
  属性名称
- value: V
  
  属性值
Returns undefined | MxDbEntity

getNodesByProperty

getNodesByProperty<V>(name: string, value: V): MxDbEntity[]

Inherited from RenderOrderNode.getNodesByProperty
根据属性名称找到对应的Node节点
example
```
new Node().getNodeByProperty("id", "23548")
```
Type Parameters
- V = any
Parameters
- name: string
  
  属性名称
- value: V
  
  属性值
Returns MxDbEntity[]

getRenderOrder

getRenderOrder(): number

Overrides RenderOrderNode.getRenderOrder

得到显示顺序

Returns number
number

Abstract getTypeName

getTypeName(): string

Returns string

guid

guid(): string

返回唯一标识guid

Returns string
string

initGuid

initGuid(guid: string): void

Parameters
- guid: string
Returns void

isDashLineDisplay

isDashLineDisplay(): boolean

是否虚线显示

Returns boolean
number

isUseSmallcoordDisplay

isUseSmallcoordDisplay(): boolean

Returns boolean

Abstract moveGripPointsAt

moveGripPointsAt(index: number, offset: Vector3): boolean

移动自定义对象的夹点.

Parameters
- index: number
- offset: Vector3
Returns boolean
boolean

objectId

objectId(): number

得到对象的id.

Returns number
number

off

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

Inherited from RenderOrderNode.off

销毁事件

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: Key, callback: (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void) | (() => void)): void

Inherited from RenderOrderNode.on

订阅

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

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

Parameters
- obj: any
  
  dwgIn抽象方法的回调数据
Returns void

Protected onDwgOut

onDwgOut(obj: any): void

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

Parameters
- obj: any
  
  dwgOut抽象方法的回调数据
Returns void

onEndGripEidt

onEndGripEidt(): void

对象结束开始编辑

Returns void
string

onStartGripEidt

onStartGripEidt(): any

对象开始开始编辑

Returns any
string

Protected onViewChange

onViewChange(): boolean

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

Returns boolean
boolean

remove

remove(...ages: MxDbEntity[]): MxDbEntity

Inherited from RenderOrderNode.remove

移除子节点

Parameters
- Rest ...ages: MxDbEntity[]
Returns MxDbEntity

removeFromParent

removeFromParent(): MxDbEntity

Inherited from RenderOrderNode.removeFromParent

从父节点中移除

Returns MxDbEntity

restoreDefaultRenderOrder

restoreDefaultRenderOrder(): void

Inherited from RenderOrderNode.restoreDefaultRenderOrder

恢复默认显示顺序

Returns void

rxInit

rxInit(): void

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

Returns void

setColor

setColor(color: MxColorType): MxDbEntity

设置颜色

Parameters
- color: MxColorType
  
  颜色值
Returns MxDbEntity
boolean

setDash

setDash(dDashArray: number, dDashRatio: number): MxDbEntity

设置虚线数据

Parameters
- dDashArray: number
- dDashRatio: number
Returns MxDbEntity
number

setDashArray

setDashArray(dDashArray: number): MxDbEntity

设置实线虚线总段数 = 1 / dashArray

Parameters
- dDashArray: number
Returns MxDbEntity
number

setDashLen

setDashLen(dashLen: number): MxDbEntity

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

Parameters
- dashLen: number
Returns MxDbEntity
number

setDashLineDisplay

setDashLineDisplay(isDashLine: boolean): MxDbEntity

设置虚线显示。并初始化一个默认值。

Parameters
- isDashLine: boolean
Returns MxDbEntity
number

setDashRatio

setDashRatio(dDashRatio: number): MxDbEntity

设置虚线，与实线的比率

Parameters
- dDashRatio: number
Returns MxDbEntity
number

setGuid

setGuid(val: string): string

修改唯一标识guid

Parameters
- val: string
Returns string
string

setLayer

setLayer(layer: string): void

设置图层

Parameters
- layer: string
Returns void
boolean

setLineWidth

setLineWidth(dLineWidth: number): MxDbEntity

设置线宽

Parameters
- dLineWidth: number
Returns MxDbEntity
number

setLineWidthByPixels

setLineWidthByPixels(isPixels: boolean): MxDbEntity

设置线宽是否随像素

Parameters
- isPixels: boolean
Returns MxDbEntity
number

setNeedUpdateDisplay

setNeedUpdateDisplay(isImmediate?: boolean): boolean

更新显示

Parameters
- Optional isImmediate: boolean
Returns boolean
boolean

setRenderOrder

setRenderOrder(renderOrder: number): void

Overrides RenderOrderNode.setRenderOrder

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

Parameters
- renderOrder: number
  
  显示顺序
Returns void

setUseSmallcoordDisplay

setUseSmallcoordDisplay(use_smallcoord_display: boolean): void

Parameters
- use_smallcoord_display: boolean
Returns void

toJsonString

toJsonString(type?: MxCloneType): string

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

Parameters
- type: MxCloneType = MxType.MxCloneType.kMxFileClone
Returns string
void

toSmallcoord

toSmallcoord(mxobj: MxDrawObject, pt: Vector3): Vector3

Parameters
- mxobj: MxDrawObject
- pt: Vector3
Returns Vector3

toSmallcoord2

toSmallcoord2(mxobj: MxDrawObject, x: number, y: number, z?: number): Vector3

Parameters
- mxobj: MxDrawObject
- x: number
- y: number
- z: number = 0
Returns Vector3

top

top(): void

Inherited from RenderOrderNode.top

top 同层级下最上层

Returns void

transformBy

transformBy(_mat: Matrix4): void

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

Parameters
- _mat: Matrix4
  
  THREE.Matrix4 变化矩阵
Returns void
void

traverse

traverse(callback: ((node: MxDbEntity) => void)): void

Inherited from RenderOrderNode.traverse

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

Parameters
- callback: ((node: MxDbEntity) => void)
  
  回调函数
  - - (node: MxDbEntity): void
    - Parameters
      - node: MxDbEntity
      Returns void
Returns void

traverseParent

traverseParent<V>(callback: ((node: V) => boolean | void)): void

Inherited from RenderOrderNode.traverseParent

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

Type Parameters
- V extends Node<any, any, V> = MxDbEntity
Parameters
- callback: ((node: V) => boolean | void)
  
  回调函数，第一个参数是父节点, callback的返回值为false 将停止继续传递
  - - (node: V): boolean | void
    - Parameters
      - node: V
      Returns boolean | void
Returns void

Abstract worldDraw

worldDraw(pWorldDraw: McGiWorldDraw): void

自定义对象的绘制函数。在方法中定义如何绘制图形

Parameters
- pWorldDraw: McGiWorldDraw
  
  绘制对象
Returns void
void

Static register

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

Returns void

Static use

use<T>(callback?: ((obj: T) => any), data?: any): Promise<T>

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

Type Parameters
- T extends MxDbEntity<T> = MxDbEntity
Parameters
- Optional callback: ((obj: T) => any)
  - - (obj: T): any
    - Parameters
      - obj: T
      Returns any
- Optional data: any
Returns Promise<T>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns MxDbEntity

Properties

addEvent

Type declaration

Type Parameters

Key extends keyof MxDbEntityEventsType | keyof RendererEventsType

Parameters

event: Key

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

Returns void

Private callEvent

Type declaration

Type Parameters

Key extends keyof MxDbEntityEventsType | keyof RendererEventsType

Parameters

event: number | Key

Rest ...data: Parameters<(MxDbEntityEventsType & RendererEventsType)[Key]>

Returns void

children

color

dDashArray

dDashRatio

dLineWidth

events

Type declaration

[x: EventType]: Events[keyof Events][]

layer

lineWidthByPixels

opacity

parent

removeEvent

Type declaration

Type Parameters

Key extends keyof MxDbEntityEventsType | keyof RendererEventsType

Parameters

event: Key

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

Returns void

renderOrder

Protected sGuid

Protected use_smallcoord_display

userData

Type declaration

[key: string]: any

visible

Static cmd

Static draw

Static isRegister

Methods

add

Parameters

Rest ...ages: MxDbEntity[]

Returns MxDbEntity

bottom

Returns void

clear

Returns MxDbEntity

clone

Parameters

Optional type: number

Returns any

create

Parameters

Optional options: {}

Returns any

Abstract dwgIn

Parameters

obj: { type: MxCloneType }

[x: string]: any

type: MxCloneType

Returns boolean

Protected dwgInHelp

Type Parameters