Class TubeTool

管线创建工具

Export

Date

2023.3.20

Author

xwb

Hierarchy

Tool
- TubeTool

Constructors

constructor

new TubeTool(engine, parameters): TubeTool
Parameters
- engine: Engine
- parameters: TubeToolParameters
Returns TubeTool

Overrides Tool.constructor

Properties

`Protected` _engine

_engine: Engine

Accessors

addDecorateInfo

get addDecorateInfo(): {
    style?: {
        color?: ColorRepresentation;
        edge?: EdgeParameters;
        glow?: GlowParameters;
    };
    url: string;
}
获取附加部件信息

Returns {
    style?: {
        color?: ColorRepresentation;
        edge?: EdgeParameters;
        glow?: GlowParameters;
    };
    url: string;
}
- Optional style?: {
      color?: ColorRepresentation;
      edge?: EdgeParameters;
      glow?: GlowParameters;
  }
  - Optional color?: ColorRepresentation
  - Optional edge?: EdgeParameters
  - Optional glow?: GlowParameters
- url: string
Memberof
TubeTool

adsorbDistance

get adsorbDistance(): number
获取吸附距离

Returns number

Memberof
TubeTool

curRadius

get curRadius(): number
获取宽度

Returns number

Memberof
TubeTool

enableAdsorbAxis

get enableAdsorbAxis(): boolean
启用轴吸附

Returns boolean

Memberof
TubeTool

enableAdsorbPosition

get enableAdsorbPosition(): boolean
启用距离吸附

Returns boolean

Memberof
TubeTool

engine

get engine(): Engine
获取引擎对象

Returns Engine

Memberof
EngineObject

Inherited from Tool.engine

selectNodeImageUrl

get selectNodeImageUrl(): string
Returns string

showDistance

get showDistance(): boolean
设置隐藏显示距离文本

Returns boolean

Memberof
TubeTool
set showDistance(bool): void
设置隐藏显示距离文本
Parameters
- bool: boolean
Returns void

Memberof
TubeTool

startHeight

get startHeight(): number
Returns number
set startHeight(height): void
设置水平面起始高度
Parameters
- height: number
Returns void

Memberof
TubeTool

Methods

active

active(): void
激活工具

Returns void

Memberof
TubeTool

Overrides Tool.active

addEventListener

addEventListener(type, callback, parameters?): number
添加事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- callback: ((event) => void)
  
  事件监听回调
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
- Optional parameters: {
  priority?: Priority;
  target?: any;
  }
  
  事件参数
  - Optional priority?: Priority
  - Optional target?: any
Returns number

Memberof
EventDispatcher

Inherited from Tool.addEventListener

changeDecorate

changeDecorate(url?, style?): void
切换附属物
Parameters
- Optional url: string
- Optional style: {
      color?: ColorRepresentation;
      edge?: EdgeParameters;
      glow?: GlowParameters;
  }
  - Optional color?: ColorRepresentation
  - Optional edge?: EdgeParameters
  - Optional glow?: GlowParameters
Returns void

Memberof
TubeTool

deactivate

deactivate(): void
停用工具

Returns void

Memberof
TubeTool

Overrides Tool.deactivate

dispatchEvent

dispatchEvent(event): void
分发事件
Parameters
- event: {
  type: string;
  [key: string]: any;
  }
  - [key: string]: any
  - type: string
Returns void

Memberof
EventDispatcher

Inherited from Tool.dispatchEvent

dispose

dispose(): void
清空

Returns void

Memberof
TubeTool

Overrides Tool.dispose

onClick

onClick(event): boolean
响应‘click’事件
Parameters
- event: MouseEvent
Returns boolean

Memberof
TubeTool

Overrides Tool.onClick

onDblClick

onDblClick(event): boolean
响应dblclick事件
Parameters
- event: PointerEvent
Returns boolean

Memberof
TubeTool

Overrides Tool.onDblClick

onKeyDown

onKeyDown(event): boolean
响应‘keydown’事件
Parameters
- event: KeyboardEvent
Returns boolean
{boolean}

Memberof
TubeTool

Overrides Tool.onKeyDown

onKeyUp

onKeyUp(event): boolean
响应‘keyup’事件
Parameters
- event: KeyboardEvent
Returns boolean
{boolean}

Memberof
TubeTool

Overrides Tool.onKeyUp

onPointerCancel

onPointerCancel(event): boolean | void
响应‘pointercancel’事件
Parameters
- event: PointerEvent
Returns boolean | void

Memberof
Tool

Inherited from Tool.onPointerCancel

onPointerDown

onPointerDown(event): boolean
鼠标按下
Parameters
- event: PointerEvent
Returns boolean
{boolean}

Memberof
TubeTool

Overrides Tool.onPointerDown

onPointerMove

onPointerMove(event): boolean
响应‘pointermove’事件
Parameters
- event: PointerEvent
Returns boolean

Memberof
TubeTool

Overrides Tool.onPointerMove

onPointerUp

onPointerUp(event): boolean
鼠标抬起
Parameters
- event: PointerEvent
Returns boolean
{boolean}

Memberof
TubeTool

Overrides Tool.onPointerUp

onWheel

onWheel(event): boolean | void
响应‘wheel’事件
Parameters
- event: MouseEvent
Returns boolean | void

Memberof
Tool

Inherited from Tool.onWheel

removeAllEventListeners

removeAllEventListeners(): void
移除所有事件监听器

Returns void

Memberof
EventDispatcher

Inherited from Tool.removeAllEventListeners

removeEventListener

removeEventListener(type, callback?): void
移除事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- Optional callback: ((event) => void)
  
  事件监听回调（可选，不设置则表示移除所有监听器）
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
Returns void

Memberof
EventDispatcher

Inherited from Tool.removeEventListener

removeEventListenerByEventId

removeEventListenerByEventId(eventID): void
通过事件Id移除事件监听器
Parameters
- eventID: number
Returns void

Memberof
EventDispatcher

Inherited from Tool.removeEventListenerByEventId

setDecorateRotation

setDecorateRotation(angle): void
设置附属物旋转
Parameters
- angle: number
Returns void

Memberof
TubeTool

setNodeDistanceByIndex

setNodeDistanceByIndex(index, distance): void
通过编号设置节点距离
Parameters
- index: number
- distance: number
Returns void

Memberof
TubeTool

switchModel

switchModel(model): void
切换状态
Parameters
- model: TubeToolModel
Returns void

Memberof
TubeTool