Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MxDbGradientLine

渐变线段

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

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

bezierType

bezierType: undefined | "quadratic" | "cubic" = 'quadratic'

如果没有提供张力，但bezierType赋值为'quadratic'| 'cubic'，则使用点集合中的点绘制一条bezier线 默认: undefined

summary

quadratic: 三维二次贝塞尔曲线 => 起点 – 中间的控制点 – 终点

summary

cubic: 三维三次贝塞尔曲线 => 起点v – 第一个控制点 – 第二个控制点 – 终点

children

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

它的子节点集合

closed

closed: boolean = false

定义线形状是否闭合，从而创建多边形或斑点

access

public

color

color: UnstableColor = 0xffffff

颜色值

colors

colors: (string | number | Color)[]

渐变色

Protected Optional curve

curve?: CatmullRomCurve3 | CurvePath<Vector3>

curveType

curveType: "chordal" | "catmullrom" | "centripetal" = 'centripetal'

曲线的类型: chordal: 弦线、 centripetal： 向心线、 catmullrom: Catmull-Rom曲线 默认：centripetal

access

public

dDashArray

dDashArray: number = 0

dDashRatio

dDashRatio: number = 0

dLineWidth

dLineWidth: number = 0

events

events: {}

Type declaration

layer

layer: string = ''

lineWidthByPixels

lineWidthByPixels: boolean = true

linecap

linecap: "square" | "butt" | "round" = 'round'

定义线两端的样式

access

public

linejoin

linejoin: "round" | "bevel" | "miter" = 'round'

定义线连接节点的样式

access

public

opacity

opacity: number = 1

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

parent

parent: null | MxDbEntity | MxDbGradientLine = null

它的父节点

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

tension

tension: number = 0

当curveType为catmullrom时，定义catmullrom的张力。 张力: 数值越大，曲线越弯曲。值为0将导致没有插值。默认值是0

access

public

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

addColor

bottom

  • bottom(): void

clear

clone

  • clone(type?: number): any

  • 复制克隆对象。

    Parameters

    • Optional type: number

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

    Returns any

    MxDbEntity

create

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

getClosestPointTo

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

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

    Parameters

    • pt: Vector3
    • iOperationType: number = 0

    Returns null | Vector3

    void

getColor

getDash

  • getDash(): any

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

getNodesByProperty

getPoints

  • getPoints(): Vector3[]

  • Returns Vector3[]

getRenderOrder

  • getRenderOrder(): number

getTypeName

  • getTypeName(): string

guid

  • guid(): string

  • 返回唯一标识guid

    Returns string

    string

initGuid

  • initGuid(guid: string): void

isDashLineDisplay

  • isDashLineDisplay(): boolean

isUseSmallcoordDisplay

  • isUseSmallcoordDisplay(): boolean

move

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

setBezierType

  • setBezierType(bezierType: "quadratic" | "cubic"): void

  • Parameters

    • bezierType: "quadratic" | "cubic"

    Returns void

setClosed

  • setClosed(closed: boolean): void

  • Parameters

    • closed: boolean

    Returns void

setColor

setColors

setCurveType

  • setCurveType(curveType: "chordal" | "catmullrom" | "centripetal"): void

  • Parameters

    • curveType: "chordal" | "catmullrom" | "centripetal"

    Returns void

setDash

setDashArray

setDashLen

setDashLineDisplay

setDashRatio

setGuid

  • setGuid(val: string): string

  • 修改唯一标识guid

    Parameters

    • val: string

    Returns string

    string

setLayer

  • setLayer(layer: string): void

  • 设置图层

    Parameters

    • layer: string

    Returns void

    boolean

setLineWidth

setLineWidthByPixels

setLinecap

  • setLinecap(linecap: "square" | "butt" | "round"): void

  • Parameters

    • linecap: "square" | "butt" | "round"

    Returns void

setNeedUpdateDisplay

  • setNeedUpdateDisplay(isImmediate?: boolean): boolean

setPoints

setRenderOrder

  • setRenderOrder(renderOrder: number): void

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

    Parameters

    • renderOrder: number

      显示顺序

    Returns void

setTension

  • setTension(tension: number): void

  • Parameters

    • tension: number

    Returns void

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

      THREE.Matrix4 变化矩阵

    Returns void

    void

traverse

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>