Class MxDbEntity`Abstract`

Node 节点

Example

class ObjClass extends Node<{"added": { node: Node, id: number }}> {}

Index

Constructors

constructor

Constructors

constructor

new MxDbEntity(): MxDbEntity
Returns MxDbEntity
Overrides RenderOrderNode.constructor

Properties

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

`Private` callEvent

callEvent: (<Key>(event, ...data) => void) = ...

Type declaration

- <Key>(event, ...data): 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: {
[x: EventType]: Events[keyof 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

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

该类注册的cmd命令名称

`Static` draw

draw: Function

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

`Static` isRegister

isRegister: boolean = false

该类是否已注册

Methods

add

add(...ages): MxDbEntity
添加子节点
Parameters
- Rest ...ages: MxDbEntity[]
Returns MxDbEntity
Inherited from RenderOrderNode.add

bottom

bottom(): void
bottom 同层级下最上层

Returns void
Inherited from RenderOrderNode.bottom

clear

clear(): MxDbEntity
清除 children

Returns MxDbEntity
Inherited from RenderOrderNode.clear

clone

clone(type?): any
复制克隆对象。
Parameters
- Optional type: number
  MxType.MxCloneType 传入参数区分是正常拷贝还是动态拷贝
Returns any
MxDbEntity

create

create(options?): any
新创建一个自定义对象 (默认调用该对象的构造函数来创建新的对象)
Parameters
- Optional options: {}
Returns any
MxDbEntity

`Abstract` dwgIn

dwgIn(obj): boolean

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

Parameters

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

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"])
   }
 }
```

`Abstract` dwgOut

dwgOut(obj): object

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

Parameters

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

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

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

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

getNodesByProperty

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

getRenderOrder

getRenderOrder(): number
得到显示顺序

Returns number
number

Overrides RenderOrderNode.getRenderOrder

`Abstract` getTypeName

getTypeName(): string
Returns string

guid

guid(): string
返回唯一标识guid

Returns string
string

initGuid

initGuid(guid): void
Parameters
- guid: string
Returns void

isDashLineDisplay

isDashLineDisplay(): boolean
是否虚线显示

Returns boolean
number

isUseSmallcoordDisplay

isUseSmallcoordDisplay(): boolean
Returns boolean

`Abstract` 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
Inherited from RenderOrderNode.off

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
Inherited from RenderOrderNode.on

`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

onEndGripEidt(): void
对象结束开始编辑

Returns void
string

onStartGripEidt

onStartGripEidt(): any
对象开始开始编辑

Returns any
string

`Protected` onViewChange

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

Returns boolean
boolean

remove

remove(...ages): MxDbEntity
移除子节点 *
Parameters
- Rest ...ages: MxDbEntity[]
Returns MxDbEntity
Inherited from RenderOrderNode.remove

removeFromParent

removeFromParent(): MxDbEntity
从父节点中移除

Returns MxDbEntity
Inherited from RenderOrderNode.removeFromParent

restoreDefaultRenderOrder

restoreDefaultRenderOrder(): void
恢复默认显示顺序

Returns void
Inherited from RenderOrderNode.restoreDefaultRenderOrder

rxInit

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

Returns void

setColor

setColor(color): MxDbEntity
设置颜色
Parameters
- color: MxColorType
  颜色值
Returns MxDbEntity
boolean

setDash

setDash(dDashArray, dDashRatio): MxDbEntity
设置虚线数据
Parameters
- dDashArray: number
- dDashRatio: number
Returns MxDbEntity
number

setDashArray

setDashArray(dDashArray): MxDbEntity
设置实线虚线总段数 = 1 / dashArray
Parameters
- dDashArray: number
Returns MxDbEntity
number

setDashLen

setDashLen(dashLen): MxDbEntity
设置虚线 +实线的长度. dDashRatio确定虚线，与实线的比率.
Parameters
- dashLen: number
Returns MxDbEntity
number

setDashLineDisplay

setDashLineDisplay(isDashLine): MxDbEntity
设置虚线显示。并初始化一个默认值。
Parameters
- isDashLine: boolean
Returns MxDbEntity
number

setDashRatio

setDashRatio(dDashRatio): MxDbEntity
设置虚线，与实线的比率
Parameters
- dDashRatio: number
Returns MxDbEntity
number

setGuid

setGuid(val): string
修改唯一标识guid
Parameters
- val: string
Returns string
string

setLayer

setLayer(layer): void
设置图层
Parameters
- layer: string
Returns void
boolean

setLineWidth

setLineWidth(dLineWidth): MxDbEntity
设置线宽
Parameters
- dLineWidth: number
Returns MxDbEntity
number

setLineWidthByPixels

setLineWidthByPixels(isPixels): MxDbEntity
设置线宽是否随像素
Parameters
- isPixels: boolean
Returns MxDbEntity
number

setNeedUpdateDisplay

setNeedUpdateDisplay(isImmediate?): boolean
更新显示
Parameters
- Optional isImmediate: boolean
Returns boolean
boolean

setRenderOrder

setRenderOrder(renderOrder): void
设置显示顺序 (通过显示顺序控制图层)
Parameters
- renderOrder: number
  显示顺序
Returns void
Overrides RenderOrderNode.setRenderOrder

setUseSmallcoordDisplay

setUseSmallcoordDisplay(use_smallcoord_display): void
Parameters
- use_smallcoord_display: boolean
Returns void

toJsonString

toJsonString(type?): string
把一个对象变成一个json字体串.
Parameters
- type: MxCloneType = MxType.MxCloneType.kMxFileClone
Returns string
void

toSmallcoord

toSmallcoord(mxobj, pt): Vector3
Parameters
- mxobj: MxDrawObject
- pt: Vector3
Returns Vector3

toSmallcoord2

toSmallcoord2(mxobj, x, y, z?): Vector3
Parameters
- mxobj: MxDrawObject
- x: number
- y: number
- z: number = 0
Returns Vector3

top

top(): void
top 同层级下最上层 *

Returns void
Inherited from RenderOrderNode.top

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
Inherited from RenderOrderNode.traverse

traverseParent

traverseParent<V>(callback): void
让它的父节点依次冒泡执行传入的方法的方法
Type Parameters
- V extends Node<any, any, V> = MxDbEntity
Parameters
- callback: ((node) => boolean | void)
  回调函数，第一个参数是父节点, callback的返回值为false 将停止继续传递
  - - (node): boolean | void
    - Parameters
      node: V
      Returns boolean | void
Returns void
Inherited from RenderOrderNode.traverseParent

`Abstract` worldDraw

worldDraw(pWorldDraw): void
自定义对象的绘制函数。在方法中定义如何绘制图形
Parameters
- pWorldDraw: McGiWorldDraw
  绘制对象McGiWorldDraw
Returns void
void

`Static` register

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

Returns void

`Static` use

use<T>(callback?, data?): Promise<T>
使用该类的cmd命令执行默认的绘制功能
Type Parameters
- T extends MxDbEntity<T> = MxDbEntity
Parameters
- Optional callback: ((obj) => any)
  - - (obj): any
    - Parameters
      obj: T
      Returns any
- Optional data: any
Returns Promise<T>

Class MxDbEntityAbstract

Example

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns MxDbEntity

Properties

addEvent

Type declaration

Type Parameters

Parameters

Returns void

Returns

Private callEvent

Type declaration

Type Parameters

Parameters

Returns void

children

color

dDashArray

dDashRatio

dLineWidth

events

Type declaration

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

layer

lineWidthByPixels

opacity

parent

removeEvent

Type declaration

Type Parameters

Parameters

Returns void

Returns

renderOrder

Protected sGuid

Protected use_smallcoord_display

userData

Type declaration

[key: string]: any

visible

Static cmd

Static draw

Static isRegister

Methods

add

Parameters

Returns MxDbEntity

bottom

Returns void

clear

Returns MxDbEntity

clone

Parameters

Returns any

create

Parameters

Returns any

Abstract dwgIn

Parameters

[x: string]: any

type: MxCloneType

Returns boolean

Example

Protected dwgInHelp

Type Parameters

Parameters

Optional getCacheVal?: ((v) => any)

Parameters

Returns any

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

Parameters

Returns any

Returns boolean

Class MxDbEntity`Abstract`

`Private` callEvent

`Protected` sGuid

`Protected` use_smallcoord_display

`Static` cmd

`Static` draw

`Static` isRegister

`Abstract` dwgIn

`Protected` dwgInHelp

`Optional` getCacheVal?: ((v) => any)

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

`Abstract` dwgOut

`Protected` dwgOutHelp

`Abstract` getGripPoints

`Private` getImp

`Abstract` getTypeName

`Abstract` moveGripPointsAt