Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MxDbShape

动态绘制形状 基于THREE.Shape计算实现的形状 通过扩展可以实现各种2d 3d形状

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

_cornerRadius

_cornerRadius: number | number[] = []

Protected _fillImageSrc

_fillImageSrc: undefined | null | string | false = null

填充图片路径

Protected _paths

_paths: CurvePath<Vector3 | Vector2>

Protected _propertyDbKeys

_propertyDbKeys: string[] = ...

需要输入和输出的属性

addEvent

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

Type declaration

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

    • 订阅

      Type Parameters

      Parameters

      • event: Key

        事件名称

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

        事件回调

      Returns void

      void

children

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

它的子节点集合

closed

closed: boolean = true

闭合

Protected closedLine

closedLine: Curve<Vector3>

color

color: UnstableColor = 0xffffff

颜色值

curveSegments

curveSegments: number = 50

线段细分数值

dDashArray

dDashArray: number = 0

dDashRatio

dDashRatio: number = 0

dLineWidth

dLineWidth: number = 0

events

events: {}

Type declaration

fillImageParam

fillImageParam: undefined | { center?: Vector2; offset?: Vector2; repeat?: Vector2; rotation?: number }

fillImageParam 填充背景图片的参数设置(如果使用了滤镜则部分参数功能失效)

filter

filter: undefined | null | MxFilters = null

设置滤镜对象MxFilters 默认为undefined | null 则不使用该滤镜效果

isFill

isFill: boolean = false

填充

Protected isLoadMaterialFromPath

isLoadMaterialFromPath: boolean = true

isStrokeDashLine

isStrokeDashLine: boolean = false

描边是否为虚线

layer

layer: string = ''

lineWidthByPixels

lineWidthByPixels: boolean = true

Protected material

material: null | MeshLambertMaterial

opacity

opacity: number = 1

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

parent

parent: null | MxDbEntity | MxDbShape = null

它的父节点

Protected points

points: Vector3[]

removeEvent

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

Type declaration

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

    • 销毁事件

      Type Parameters

      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 = ''

stroke

stroke: UnstableColor = "#fff"

描边颜色

strokeLineWidth

strokeLineWidth: number = 2

描边线段的宽度

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

该类是否已注册

Accessors

cornerRadius

  • get cornerRadius(): number | number[]
  • set cornerRadius(radius: number | number[]): void

  • 圆角半径 (一个向量点对应一个角的半径值)

    Returns number | number[]

  • 圆角半径 (一个向量点对应一个角的半径值)

    Parameters

    • radius: number | number[]

    Returns void

fillImageSrc

  • get fillImageSrc(): undefined | null | string | false
  • set fillImageSrc(src: undefined | null | string | false): void

  • Returns undefined | null | string | false

  • Parameters

    • src: undefined | null | string | false

    Returns void

Methods

Protected _draw

  • 动态绘制函数

    Parameters

    Returns void

Protected _drawStoreLine

_fillImg

  • 图片填充

    Parameters

    Returns void

add

bottom

  • bottom(): void

clear

clone

  • clone(type?: number): any

  • 复制克隆对象。

    Parameters

    • Optional type: number

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

    Returns any

    MxDbEntity

create

  • create(options?: {}): any

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

    Parameters

    • Optional options: {}

      Returns any

      MxDbEntity

    Protected createPaths

    • createPaths(shapes: Curve<Vector3 | Vector2> | Curve<Vector3 | Vector2>[]): CurvePath<Vector3 | Vector2>

    • 创建路径

      Parameters

      • shapes: Curve<Vector3 | Vector2> | Curve<Vector3 | Vector2>[]

      Returns CurvePath<Vector3 | Vector2>

    dwgIn

    • dwgIn(obj: any): boolean

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

      Parameters

      • obj: any

      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

    dwgOut

    • dwgOut(obj: any): object

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

      Parameters

      • obj: any

      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

    erase

    • erase(): boolean

    fromJsonString

    • fromJsonString(str: string): boolean

    getArea

    • getArea(): number

    • 获取面积

      Returns number

    getClosedPoints

    • getClosedPoints(points: Vector3[]): Vector3[]

    • 获取线段闭合后的曲线点数

      Parameters

      • points: Vector3[]

      Returns Vector3[]

    getClosestPointTo

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

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

      Parameters

      • pt: Vector3
      • iOperationType: number = 0

      Returns null | Vector3

      void

    getColor

    getCornerRadiusPoints

    • getCornerRadiusPoints(points: Vector3[]): Vector3[]

    • 获取生成圆角后的点

      Parameters

      • points: Vector3[]

      Returns Vector3[]

    getDash

    • getDash(): any

    getFilter

    getGeomExtents

    • getGeomExtents(): null | Box3

    getGetLength

    • getGetLength(): number

    getGripPoints

    • getGripPoints(): Vector3[]

    getLayer

    • getLayer(): string

    getLineWidth

    • getLineWidth(): number

    getLineWidthByPixels

    • getLineWidthByPixels(): boolean

    getMxObject

    getNodeByProperty

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

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

      Type Parameters

      • V = any

      Parameters

      • name: string

        属性名称

      • value: V

        属性值

      Returns undefined | MxDbEntity | MxDbShape

    getNodesByProperty

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

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

      Type Parameters

      • V = any

      Parameters

      • name: string

        属性名称

      • value: V

        属性值

      Returns (MxDbEntity | MxDbShape)[]

    getRenderOrder

    • getRenderOrder(): number

    Protected getShapePoints

    • getShapePoints(paths: CurvePath<Vector3 | Vector2>): Vector3[]

    • 获取坐标集合

      Parameters

      • paths: CurvePath<Vector3 | Vector2>

      Returns Vector3[]

    getTotalLength

    • getTotalLength(): undefined | number

    • 获取长度

      Returns undefined | number

    getTypeName

    • getTypeName(): string

    guid

    • guid(): string

    • 返回唯一标识guid

      Returns string

      string

    initGuid

    • initGuid(guid: string): void

    isDashLineDisplay

    • isDashLineDisplay(): boolean

    isUseSmallcoordDisplay

    • isUseSmallcoordDisplay(): boolean

    moveGripPointsAt

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

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

      Parameters

      • index: number
      • offset: Vector3

      Returns boolean

      boolean

    objectId

    • objectId(): number

    off

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

    • 销毁事件

      Type Parameters

      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

    • 订阅

      Type Parameters

      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

    onStartGripEidt

    • onStartGripEidt(): any

    Protected onViewChange

    • onViewChange(): boolean

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

      Returns boolean

      boolean

    remove

    removeFromParent

    restoreDefaultRenderOrder

    • restoreDefaultRenderOrder(): void

    rxInit

    • rxInit(): void

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

      Returns void

    setClosed

    setColor

    setCornerRadius

    • setCornerRadius(radius: number | number[], isScreenCoord?: boolean): void

    • 设置圆角 圆角的半径（如果参数为数组则一个角度对应一个圆角半径）

      Parameters

      • radius: number | number[]

        圆角半径 为数组时[3, 2, 1, 4]分别对应左上角圆角半径3 右上角2 右下角1 左下角4； 或者直接设置半径值 则四个角统一半径

      • isScreenCoord: boolean = true

        是否根据屏幕坐标设置

      Returns void

    setCurveSegments

    • setCurveSegments(curveSegments: number): MxDbShape

    • Parameters

      • curveSegments: number

      Returns MxDbShape

    setDash

    • setDash(dDashArray: number, dDashRatio: number): MxDbShape

    setDashArray

    setDashLen

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

      Parameters

      • dashLen: number

      Returns MxDbShape

      number

    setDashLineDisplay

    • setDashLineDisplay(isDashLine: boolean): MxDbShape

    setDashRatio

    setFillImageParam

    • setFillImageParam(param: undefined | { center?: Vector2; offset?: Vector2; repeat?: Vector2; rotation?: number }): void

    • Parameters

      • param: undefined | { center?: Vector2; offset?: Vector2; repeat?: Vector2; rotation?: number }

      Returns void

    setFillImageSrc

    • setFillImageSrc(fillImageSrc: undefined | null | string | false): MxDbShape

    • 设置图片值 fillImageSrc 当设置为null | false 时取消图片填充

      Parameters

      • fillImageSrc: undefined | null | string | false

      Returns MxDbShape

    setFilter

    • setFilter(filter: undefined | null | MxFilters): void

    • Parameters

      Returns void

    setGuid

    • setGuid(val: string): string

    • 修改唯一标识guid

      Parameters

      • val: string

      Returns string

      string

    setIsFill

    setIsStrokeDashLine

    • setIsStrokeDashLine(isStrokeDashLine: boolean): MxDbShape

    • Parameters

      • isStrokeDashLine: boolean

      Returns MxDbShape

    setLayer

    • setLayer(layer: string): void

    • 设置图层

      Parameters

      • layer: string

      Returns void

      boolean

    setLineWidth

    setLineWidthByPixels

    • setLineWidthByPixels(isPixels: boolean): MxDbShape

    setNeedUpdateDisplay

    • setNeedUpdateDisplay(isImmediate?: boolean): boolean

    setRenderOrder

    • setRenderOrder(renderOrder: number): void

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

      Parameters

      • renderOrder: number

        显示顺序

      Returns void

    setStroke

    setStrokeLineWidth

    • setStrokeLineWidth(strokeLineWidth: number): MxDbShape

    • Parameters

      • strokeLineWidth: number

      Returns MxDbShape

    setUseSmallcoordDisplay

    • setUseSmallcoordDisplay(use_smallcoord_display: boolean): void

    toJsonString

    toSmallcoord

    toSmallcoord2

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

    top

    • top(): void

    • top 同层级下最上层

      Returns void

    transformBy

    • transformBy(mat: Matrix4): void

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

      Parameters

      • mat: Matrix4

      Returns void

      void

    traverse

    • traverse(callback: ((node: MxDbShape) => void)): void

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

      Parameters

      Returns void

    traverseParent

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

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

      Type Parameters

      Parameters

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

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

          • (node: V): 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?: ((obj: T) => any), data?: any): Promise<T>

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

      Type Parameters

      Parameters

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

          • Parameters

            • obj: T

            Returns any

      • Optional data: any

      Returns Promise<T>