Class Pipeline

管线渲染组件

Export

Date

2022.5.27

Author

yj

Hierarchy

Constructors

constructor

Properties

_bounds _boundsUpdateFlag _engine _entity _object3D _relativeCenter _renderOrder code isRenderable materialScheme name nodes queryMask type userData

Accessors

arrowSpace arrowVisible blockSpeed bounds color enabled endColor endJoin endTopoID engine entity flowDirection flowSpeed material object3D position quaternion radius renderOrder rotation scale startColor startJoin startTopoID visible worldPosition worldQuaternion worldScale

Methods

_destroy _onAwake _onDestroy _onDisable _onEnable _updateBlockRatio _updateBlockThreshold _updateBounds _updateMatrixWorld _updateRenderOrder addEventListener append blockFlow destroy dispatchEvent dispose getCreateDeviceTransformInfo inSert localToWorld pop projectPoint raycast recoverMaterial remove removeAllEventListeners removeEventListener removeEventListenerByEventId replaceMaterial setActive setClipping setHighlight setStencil setTransform shift translate translateTo unshift update updateBuild 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>

_relativeCenter

_relativeCenter: Vector3

Protected _renderOrder

_renderOrder: RenderOrder

Readonly code

code: string

管线编码

Memberof

Pipeline

Readonly isRenderable

isRenderable: true = true

可渲染组件标识

Memberof

Renderable

Readonly materialScheme

materialScheme: string

Readonly name

name: string

管线名称

Memberof

Pipeline

Readonly nodes

nodes: NodeInfo[] = []

导线点数组

Memberof

Pipeline

queryMask

queryMask: number = 0

查询遮罩值

Memberof

Renderable

Readonly type

type: number

管线类型

Memberof

Pipeline

userData

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

用户数据

Type declaration

  • [key: string]: any

Memberof

Component

Accessors

arrowSpace

  • get arrowSpace(): number

  • 获取管线箭头纹理间距

    Returns number

    Memberof

    Pipeline

  • set arrowSpace(value): void

  • 设置管线箭头纹理间距

    Parameters

    • value: number

    Returns void

    Memberof

    Pipeline

arrowVisible

  • get arrowVisible(): boolean

  • 获取箭头纹理可见性

    Returns boolean

    Memberof

    Pipeline

  • set arrowVisible(value): void

  • 设置箭头纹理可见性

    Parameters

    • value: boolean

    Returns void

    Memberof

    Pipeline

blockSpeed

  • get blockSpeed(): number

  • 获取管线阻断流速

    Returns number

    Memberof

    Pipeline

  • set blockSpeed(value): void

  • 设置管线阻断流速

    Parameters

    • value: number

    Returns void

    Memberof

    Pipeline

bounds

  • get bounds(): Readonly<Box3>

  • 获取世界外包范围

    Returns Readonly<Box3>

    Memberof

    Renderable

color

  • set color(value): void

  • 设置管线颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    Pipeline

enabled

  • get enabled(): boolean

  • 获取组件是否启用

    Returns boolean

    Memberof

    Component

  • set enabled(value): void

  • 启用或禁用组件

    Parameters

    • value: boolean

    Returns void

    Memberof

    Component

endColor

  • get endColor(): ColorRepresentation

  • 获取管线终点颜色

    Returns ColorRepresentation

    Memberof

    Pipeline

  • set endColor(value): void

  • 设置管线终点颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    Pipeline

endJoin

endTopoID

  • get endTopoID(): string

  • 获取终点拓扑ID

    Returns string

    Memberof

    Pipeline

  • set endTopoID(value): void

  • 设置终点拓扑ID

    Parameters

    • value: string

    Returns void

    Memberof

    Pipeline

engine

  • get engine(): Engine

  • 获取引擎对象

    Returns Engine

    Memberof

    EngineObject

entity

  • get entity(): Entity

  • 获取组件所属实体

    Returns Entity

    Memberof

    Component

flowDirection

  • get flowDirection(): number

  • 获取管线箭头纹理流动方向

    Returns number

    Memberof

    Pipeline

  • set flowDirection(value): void

  • 设置管线箭头纹理流动方向

    Parameters

    • value: number

    Returns void

    Memberof

    Pipeline

flowSpeed

  • get flowSpeed(): number

  • 获取管线箭头纹理流速

    Returns number

    Memberof

    Pipeline

  • set flowSpeed(value): void

  • 设置管线箭头纹理流速

    Parameters

    • value: number

    Returns void

    Memberof

    Pipeline

material

  • get material(): string

  • 获取管线材质名

    Returns string

    Memberof

    Pipeline

object3D

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

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

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

    Memberof

    Renderable

position

  • get position(): Vector3

  • 获取本地位置

    Returns Vector3

    Memberof

    Renderable

  • set position(value): void

  • 设置本地位置

    Parameters

    • value: number[] | Vector3

    Returns void

    Memberof

    Renderable

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

    Pipeline

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

startColor

  • get startColor(): ColorRepresentation

  • 获取管线起点颜色

    Returns ColorRepresentation

    Memberof

    Pipeline

  • set startColor(value): void

  • 设置管线起点颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    Pipeline

startJoin

startTopoID

  • get startTopoID(): string

  • 获取起点拓扑ID

    Returns string

    Memberof

    Pipeline

  • set startTopoID(value): void

  • 设置起点拓扑ID

    Parameters

    • value: string

    Returns void

    Memberof

    Pipeline

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

    Pipeline

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

    Pipeline

Protected _onEnable

  • _onEnable(): void
  • Protected

    启用渲染组件

    Returns void

    Memberof

    Pipeline

_updateBlockRatio

  • _updateBlockRatio(): void

  • 更新阻断阈值

    Returns void

    Memberof

    Pipeline

_updateBlockThreshold

  • _updateBlockThreshold(): void

  • 更新阻断阈值

    Returns void

    Memberof

    Pipeline

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

append

  • 在尾部增加一个或多个节点

    Parameters

    • position: Vector3 | Vector3[]

    Returns void

    Memberof

    Pipeline

blockFlow

  • 阻断流动

    Parameters

    • Optional point: Vector3

    Returns void

    Memberof

    Pipeline

destroy

  • 销毁组件

    Returns void

    Memberof

    Component

dispatchEvent

  • 分发事件

    Parameters

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

    Returns void

    Memberof

    EventDispatcher

dispose

  • 释放接口

    Returns void

    Memberof

    EventDispatcher

getCreateDeviceTransformInfo

  • 获取在管线上创建设备的方位信息

    Parameters

    • point: number[] | Vector3

    Returns {
        position: Vector3;
        quaternion: Quaternion;
    }

    {{ position: Vector3, quaternion: Quaternion }}

    • position: Vector3
    • quaternion: Quaternion

    Memberof

    Pipeline

inSert

  • 插入一个或多个点

    Parameters

    • index: number
    • position: Vector3 | Vector3[]

    Returns void

    Memberof

    Pipeline

localToWorld

  • 本地坐标转世界坐标

    Parameters

    • vector: number[] | Vector3

      本地坐标

    Returns Vector3

    Memberof

    Renderable

pop

  • 移除尾部导线点

    Parameters

    • deleteCount: number = -1

    Returns NodeInfo[]

    Memberof

    Pipeline

projectPoint

  • 计算点在管线中线的投影点

    Parameters

    • point: number[] | Vector3

    Returns {
        endIndex: number;
        position: Vector3;
        startIndex: number;
    }

    • endIndex: number
    • position: Vector3
    • startIndex: number

    Memberof

    Pipeline

raycast

  • 射线拾取

    Parameters

    • raycaster: Raycaster

    Returns Intersection<Object3D<Object3DEventMap>>

    Memberof

    Pipeline

recoverMaterial

remove

  • 移除元素

    Parameters

    • start: number
    • deleteCount: number

    Returns NodeInfo[]

    NodeInfo[]

    Memberof

    Pipeline

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

replaceMaterial

  • 替换材质

    Parameters

    • material: any

      材质对象

    Returns void

    Memberof

    Renderable

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

shift

  • 移除头部导线点

    Parameters

    • deleteCount: number = -1

    Returns NodeInfo[]

    Memberof

    Pipeline

translate

  • 沿指定方向平移导线点

    Parameters

    • index: number

      导线点索引编号

    • offset: number[] | Vector3

      平移距离

    Returns void

    Memberof

    Pipeline

translateTo

  • 平移导线点到目标位置

    Parameters

    • index: number

      导线点索引编号

    • target: number[] | Vector3

      目标位置

    Returns void

    Memberof

    Pipeline

unshift

  • 在头部增加一个或多个节点

    Parameters

    • position: Vector3 | Vector3[]

    Returns void

    Memberof

    Pipeline

update

  • 帧更新

    Parameters

    • timeSinceLastFrame: number
    • totalTime: number

    Returns void

    Memberof

    Pipeline

updateBuild

  • 更新接口

    Parameters

    Returns void

    Memberof

    Pipeline

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