Class PipelineJoin

管线连接处组件

Export

Date

2022.5.27

Author

yj

Hierarchy

Constructors

constructor

Properties

_bounds _boundsUpdateFlag _engine _entity _object3D _renderOrder isRenderable materialScheme name queryMask topoID userData

Accessors

appendage appendageData bounds color enabled engine entity material object3D pipelines position positions quaternion radius renderOrder rotation scale visible worldPosition worldQuaternion worldScale

Methods

_destroy _onAwake _onDestroy _onDisable _onEnable _updateBounds _updateMatrixWorld _updateRenderOrder addEventListener attachAppendage destroy detachAppendage disconnect dispatchEvent dispose localToWorld raycast recoverMaterial removeAllEventListeners removeEventListener removeEventListenerByEventId replaceJoinPipeline replaceMaterial rotate setActive setClipping setHighlight setStencil setTransform translate translateTo update updateBuildParameters updateProperties worldToLocal

Constructors

constructor

Properties

Protected _bounds

_bounds: Box3 = ...

Protected _boundsUpdateFlag

_boundsUpdateFlag: BoolUpdateFlag

Protected _engine

_engine: Engine

Protected _entity

_entity: Entity

Protected _object3D

_object3D: Object3D<Object3DEventMap>

Protected _renderOrder

_renderOrder: RenderOrder

Readonly isRenderable

isRenderable: true = true

可渲染组件标识

Memberof

Renderable

Readonly materialScheme

materialScheme: string

材质方案

Memberof

PipelineJoin

Readonly name

name: string

连接处名称

Memberof

PipelineJoin

queryMask

queryMask: number = 0

查询遮罩值

Memberof

Renderable

Readonly topoID

topoID: string

拓扑ID

Memberof

PipelineJoin

userData

userData: {
    [key: string]: any;
} = {}

用户数据

Type declaration

  • [key: string]: any

Memberof

Component

Accessors

appendage

appendageData

bounds

  • get bounds(): Readonly<Box3>

  • 获取世界外包范围

    Returns Readonly<Box3>

    Memberof

    Renderable

color

  • get color(): ColorRepresentation

  • 获取连接处颜色

    Returns ColorRepresentation

    Memberof

    PipelineJoin

  • set color(value): void

  • 设置连接处颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    PipelineJoin

enabled

  • get enabled(): boolean

  • 获取组件是否启用

    Returns boolean

    Memberof

    Component

  • set enabled(value): void

  • 启用或禁用组件

    Parameters

    • value: boolean

    Returns void

    Memberof

    Component

engine

  • get engine(): Engine

  • 获取引擎对象

    Returns Engine

    Memberof

    EngineObject

entity

  • get entity(): Entity

  • 获取组件所属实体

    Returns Entity

    Memberof

    Component

material

  • get material(): string

  • 获取连接处材质名

    Returns string

    Memberof

    PipelineJoin

object3D

  • get object3D(): Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]

  • 获取渲染组件对应的Object3D（three.js）对象

    Returns Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]

    Memberof

    Renderable

pipelines

  • get pipelines(): readonly {
        guid: string;
        topuNodeIndex: number;
    }[]

  • 连接处关联管线信息

    Returns readonly {
        guid: string;
        topuNodeIndex: number;
    }[]

    Memberof

    PipelineJoin

position

  • get position(): Vector3

  • 获取本地位置

    Returns Vector3

    Memberof

    Renderable

  • set position(value): void

  • 设置本地位置

    Parameters

    • value: number[] | Vector3

    Returns void

    Memberof

    Renderable

positions

  • get positions(): readonly Vector3[][]

  • 创建连接的节点数据

    Returns readonly Vector3[][]

    Memberof

    PipelineJoin

quaternion

  • get quaternion(): Quaternion

  • 获取本地旋转四元数

    Returns Quaternion

    Memberof

    Renderable

  • set quaternion(value): void

  • 设置本地旋转四元数

    Parameters

    • value: number[] | Quaternion

    Returns void

    Memberof

    Renderable

radius

  • get radius(): number

  • 半径

    Returns number

    Memberof

    PipelineJoin

renderOrder

  • get renderOrder(): RenderOrder

  • 获取渲染顺序

    Returns RenderOrder

    Memberof

    Renderable

  • set renderOrder(value): void

  • 设置渲染顺序

    Parameters

    Returns void

    Memberof

    Renderable

rotation

  • get rotation(): Euler

  • 获取本地旋转角（单位：弧度）

    Returns Euler

    Memberof

    Renderable

  • set rotation(value): void

  • 设置本地旋转角（单位：弧度）

    Parameters

    • value: number[] | Euler

    Returns void

    Memberof

    Renderable

scale

  • get scale(): Vector3

  • 获取本地缩放

    Returns Vector3

    Memberof

    Renderable

  • set scale(value): void

  • 设置本地缩放

    Parameters

    • value: number[] | Vector3

    Returns void

    Memberof

    Renderable

visible

  • get visible(): boolean

  • 获取是否可见

    Returns boolean

    Memberof

    Renderable

  • set visible(value): void

  • 设置是否可见

    Parameters

    • value: boolean

    Returns void

    Memberof

    Renderable

worldPosition

  • get worldPosition(): Vector3

  • 获取世界位置

    Returns Vector3

    Memberof

    Renderable

worldQuaternion

  • get worldQuaternion(): Quaternion

  • 获取世界旋转四元数

    Returns Quaternion

    Memberof

    Renderable

worldScale

  • get worldScale(): Vector3

  • 获取世界缩放

    Returns Vector3

    Memberof

    Renderable

Methods

Protected _destroy

  • _destroy(): void
  • Protected

    销毁接口

    Returns void

    Memberof

    PipelineJoin

Protected _onAwake

  • _onAwake(): void
  • Protected

    唤醒组件

    Returns void

    Memberof

    Component

Protected _onDestroy

  • _onDestroy(): void
  • Protected

    销毁渲染组件

    Returns void

    Memberof

    Renderable

Protected _onDisable

  • _onDisable(): void
  • Protected

    禁用渲染组件

    Returns void

    Memberof

    Renderable

Protected _onEnable

  • _onEnable(): void
  • Protected

    启用渲染组件

    Returns void

    Memberof

    Renderable

Protected _updateBounds

  • _updateBounds(): void
  • Protected

    更新渲染组件外包盒

    Returns void

    Memberof

    Renderable

Protected _updateMatrixWorld

  • _updateMatrixWorld(): void
  • Protected

    更新渲染组件世界矩阵

    Returns void

    Memberof

    Renderable

Protected _updateRenderOrder

addEventListener

  • 添加事件监听器

    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

attachAppendage

  • 安装管点附属物

    Parameters

    Returns Promise<void>

    {Promise}

    Memberof

    PipelineJoin

destroy

  • 销毁组件

    Returns void

    Memberof

    Component

detachAppendage

  • 拆卸管点附属物

    Returns void

    Memberof

    PipelineJoin

disconnect

  • 从连接处断开管线

    Parameters

    • guid: string

    Returns void

    Memberof

    PipelineJoin

dispatchEvent

  • 分发事件

    Parameters

    • event: {
          type: string;
          [key: string]: any;
      }
      • [key: string]: any
      • type: string

    Returns void

    Memberof

    EventDispatcher

dispose

  • 释放接口

    Returns void

    Memberof

    EventDispatcher

localToWorld

  • 本地坐标转世界坐标

    Parameters

    • vector: number[] | Vector3

      本地坐标

    Returns Vector3

    Memberof

    Renderable

raycast

  • 射线拾取

    Parameters

    • raycaster: Raycaster

    Returns Intersection<Object3D<Object3DEventMap>>

    Memberof

    PipelineJoin

recoverMaterial

removeAllEventListeners

removeEventListener

  • 移除事件监听器

    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

removeEventListenerByEventId

  • 通过事件Id移除事件监听器

    Parameters

    • eventID: number

    Returns void

    Memberof

    EventDispatcher

replaceJoinPipeline

  • 替换连接处管线

    Parameters

    • newInfo: {
          guid: string;
          topuNodeIndex: number;
      }
      • guid: string
      • topuNodeIndex: number
    • Optional originGUID: string

    Returns void

    Memberof

    PipelineJoin

replaceMaterial

  • 替换材质

    Parameters

    • material: any

      材质对象

    Returns void

    Memberof

    Renderable

rotate

  • 旋转附属物

    Parameters

    • angle: number

      角度

    • axis: string

      轴

    Returns void

    Memberof

    PipelineJoin

setActive

  • 激活或冻结组件

    Parameters

    • value: boolean

    Returns void

    Memberof

    Component

setClipping

setHighlight

  • 设置是否高亮

    Parameters

    Returns void

    Memberof

    Renderable

setStencil

  • 设置模板参数

    Parameters

    Returns void

    Memberof

    Renderable

setTransform

  • 设置本地方位信息

    Parameters

    Returns void

    Memberof

    Renderable

translate

  • 沿指定方向平移连接处

    Parameters

    • offset: number[] | Vector3

      平移距离

    Returns void

    Memberof

    PipelineJoin

translateTo

  • 平移导线点到目标位置

    Parameters

    • target: number[] | Vector3

      目标位置

    Returns void

    Memberof

    PipelineJoin

update

updateBuildParameters

  • 更新连接处构建参数

    Returns Vector3[][]

    Array<Array< Vector3>>

    Memberof

    PipelineJoin

updateProperties

  • 批量更新组件属性

    Parameters

    • parameters: {
          [key: string]: any;
      }
      • [key: string]: any

    Returns Promise<void>

    Memberof

    Component

worldToLocal

  • 世界坐标转本地坐标

    Parameters

    • vector: number[] | Vector3

      世界坐标

    Returns Vector3

    Memberof

    Renderable

Settings

Member Visibility

Theme

On This Page