Class MxDbLineShape

线形状

Hierarchy (view full)

Constructors

constructor

Properties

_cornerRadius _fillImageSrc _paths _propertyDbKeys addEvent children closed closedLine color curveSegments dDashArray dDashRatio dLineWidth events fillImageParam filter isFill isLoadMaterialFromPath isStrokeDashLine layer lineWidthByPixels material opacity parent points removeEvent renderOrder sGuid stroke strokeLineWidth use_smallcoord_display userData visible cmd draw isRegister

Accessors

cornerRadius fillImageSrc

Methods

_draw _drawStoreLine _fillImg add addPoint bottom clear clone create createPaths dwgIn dwgInHelp dwgOut dwgOutHelp emit erase fromJsonString getArea getClosedPoints getClosestPointTo getColor getCornerRadiusPoints getDash getFilter getGeomExtents getGetLength getGripPoints getLayer getLineWidth getLineWidthByPixels getMxObject getNodeByProperty getNodesByProperty getRenderOrder getShapePoints getTotalLength getTypeName guid initGuid isDashLineDisplay isUseSmallcoordDisplay moveGripPointsAt objectId off on onDwgIn onDwgOut onEndGripEidt onStartGripEidt onViewChange remove removeFromParent removePoint restoreDefaultRenderOrder rxInit setClosed setColor setCornerRadius setCurveSegments setDash setDashArray setDashLen setDashLineDisplay setDashRatio setFillImageParam setFillImageSrc setFilter setGuid setIsFill setIsStrokeDashLine setLayer setLineWidth setLineWidthByPixels setNeedUpdateDisplay setPoints setRenderOrder setStroke setStrokeLineWidth setUseSmallcoordDisplay toJsonString toSmallcoord toSmallcoord2 top transformBy transformMove transformRotate transformScale traverse traverseParent worldDraw register use

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, 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 | MxDbLineShape)[] = []

它的子节点集合

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: {
    [x: EventType]: Events[keyof Events][];
}

Type declaration

fillImageParam

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

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

Type declaration

  • Optional center?: Vector2
  • Optional offset?: Vector2
  • Optional repeat?: Vector2
  • Optional rotation?: number

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 | MxDbLineShape = null

它的父节点

points

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

stroke

stroke: UnstableColor = '#fff'

描边颜色

strokeLineWidth

strokeLineWidth: number = 2

描边线段的宽度

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

该类是否已注册

Accessors

cornerRadius

  • get cornerRadius(): number | number[]

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

    Returns number | number[]

  • set cornerRadius(radius): void

  • Parameters

    • radius: number | number[]

    Returns void

fillImageSrc

  • get fillImageSrc(): undefined | null | string | false

  • Returns undefined | null | string | false

  • set fillImageSrc(src): void

  • Parameters

    • src: undefined | null | string | false

    Returns void

Methods

Protected _draw

  • _draw(pWorldDraw, vertices): void

  • 动态绘制函数

    Parameters

    Returns void

Protected _drawStoreLine

  • _drawStoreLine(pWorldDraw, points, draw?): void

  • 绘制描边

    Parameters

    • pWorldDraw: McGiWorldDraw
    • points: Vector3[]
    • Optional draw: ((pWorldDraw) => void)
        • (pWorldDraw): void

        • Parameters

          Returns void

    Returns void

_fillImg

add

addPoint

bottom

  • bottom(): void

  • bottom 同层级下最上层

    Returns void

clear

clone

  • clone(type?): any

  • 复制克隆对象。

    Parameters

    • Optional type: number

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

    Returns any

    MxDbEntity

create

  • create(options?): any

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

    Parameters

    • Optional options: {}

      Returns any

      MxDbEntity

    Protected createPaths

    • createPaths(shapes): CurvePath<Vector3 | Vector2>
      • 创建路径

      Parameters

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

      Returns CurvePath<Vector3 | Vector2>

    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

    getArea

    getClosedPoints

    • getClosedPoints(points): Vector3[]

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

      Parameters

      • points: Vector3[]

      Returns Vector3[]

    getClosestPointTo

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

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

      Parameters

      • pt: Vector3
      • iOperationType: number = 0

      Returns null | Vector3

      void

    getColor

    getCornerRadiusPoints

    • getCornerRadiusPoints(points): Vector3[]

    • 获取生成圆角后的点

      Parameters

      • points: Vector3[]

      Returns Vector3[]

    getDash

    • getDash(): any

    • 得到虚线数据

      Returns any

      number

    getFilter

    getGeomExtents

    getGetLength

    getGripPoints

    • getGripPoints(): Vector3[]

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

      Returns Vector3[]

      Array<THREE.Vector3>

    getLayer

    • getLayer(): string

    • 得到图层

      Returns string

      boolean

    getLineWidth

    getLineWidthByPixels

    getMxObject

    getNodeByProperty

    getNodesByProperty

    getRenderOrder

    Protected getShapePoints

    • getShapePoints(paths): Vector3[]

    • 获取坐标集合

      Parameters

      • paths: CurvePath<Vector3 | Vector2>

      Returns Vector3[]

    getTotalLength

    getTypeName

    guid

    • guid(): string

    • 返回唯一标识guid

      Returns string

      string

    initGuid

    • initGuid(guid): void

    • Parameters

      • guid: string

      Returns void

    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

    removePoint

    restoreDefaultRenderOrder

    rxInit

    • rxInit(): void

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

      Returns void

    setClosed

    setColor

    setCornerRadius

    • setCornerRadius(radius, isScreenCoord?): void

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

      Parameters

      • radius: number | number[]

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

      • isScreenCoord: boolean = true

        是否根据屏幕坐标设置

      Returns void

    setCurveSegments

    setDash

    setDashArray

    setDashLen

    setDashLineDisplay

    setDashRatio

    setFillImageParam

    • setFillImageParam(param): void

    • Parameters

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

      Returns void

    setFillImageSrc

    setFilter

    setGuid

    • setGuid(val): string

    • 修改唯一标识guid

      Parameters

      • val: string

      Returns string

      string

    setIsFill

    setIsStrokeDashLine

    setLayer

    • setLayer(layer): void

    • 设置图层

      Parameters

      • layer: string

      Returns void

      boolean

    setLineWidth

    setLineWidthByPixels

    setNeedUpdateDisplay

    • setNeedUpdateDisplay(isImmediate?): boolean

    • 更新显示

      Parameters

      • Optional isImmediate: boolean

      Returns boolean

      boolean

    setPoints

    setRenderOrder

    • setRenderOrder(renderOrder): void

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

      Parameters

      • renderOrder: number

        显示顺序

      Returns void

    setStroke

    setStrokeLineWidth

    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_cornerRadius_fillImageSrc_paths_propertyDbKeysaddEventchildrenclosedclosedLinecolorcurveSegmentsdDashArraydDashRatiodLineWidtheventsfillImageParamfilterisFillisLoadMaterialFromPathisStrokeDashLinelayerlineWidthByPixelsmaterialopacityparentpointsremoveEventrenderOrdersGuidstrokestrokeLineWidthuse_smallcoord_displayuserDatavisiblecmddrawisRegistercornerRadiusfillImageSrc_draw_drawStoreLine_fillImgaddaddPointbottomclearclonecreatecreatePathsdwgIndwgInHelpdwgOutdwgOutHelpemiterasefromJsonStringgetAreagetClosedPointsgetClosestPointTogetColorgetCornerRadiusPointsgetDashgetFiltergetGeomExtentsgetGetLengthgetGripPointsgetLayergetLineWidthgetLineWidthByPixelsgetMxObjectgetNodeByPropertygetNodesByPropertygetRenderOrdergetShapePointsgetTotalLengthgetTypeNameguidinitGuidisDashLineDisplayisUseSmallcoordDisplaymoveGripPointsAtobjectIdoffononDwgInonDwgOutonEndGripEidtonStartGripEidtonViewChangeremoveremoveFromParentremovePointrestoreDefaultRenderOrderrxInitsetClosedsetColorsetCornerRadiussetCurveSegmentssetDashsetDashArraysetDashLensetDashLineDisplaysetDashRatiosetFillImageParamsetFillImageSrcsetFiltersetGuidsetIsFillsetIsStrokeDashLinesetLayersetLineWidthsetLineWidthByPixelssetNeedUpdateDisplaysetPointssetRenderOrdersetStrokesetStrokeLineWidthsetUseSmallcoordDisplaytoJsonStringtoSmallcoordtoSmallcoord2toptransformBytransformMovetransformRotatetransformScaletraversetraverseParentworldDrawregisteruse