Class Laneway

巷道渲染组件

Export

Date

2022.4.13

Author

lyx

Hierarchy

Renderable
- Laneway

Index

Constructors

constructor

Properties

_bounds _boundsUpdateFlag _engine _entity _object3D _renderOrder code isRenderable leadNodes material materialScheme name parent queryMask sectionShape useLOD userData vertical

Constructors

constructor

new Laneway(entity, parameters): Laneway
Parameters
- entity: Entity
- parameters: LanewayParameters
Returns Laneway

Overrides Renderable.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` code

code: string

巷道编码

Memberof

Laneway

`Readonly` isRenderable

isRenderable: true = true

可渲染组件标识

Memberof

Renderable

`Readonly` leadNodes

leadNodes: LeadNode[]

巷道导线点数组

Memberof

Laneway

`Readonly` material

material: string

巷道材质

Memberof

Laneway

`Readonly` materialScheme

materialScheme: string

巷道材质方案

Memberof

Laneway

`Readonly` name

name: string

巷道名称

Memberof

Laneway

`Readonly` parent

parent: string

巷道父编码

Memberof

Laneway

queryMask

queryMask: number = 0

查询遮罩值

Memberof

Renderable

`Readonly` sectionShape

sectionShape: string

断面形状

Memberof

Laneway

`Readonly` useLOD

useLOD: boolean

是否启用LOD

Memberof

Laneway

userData

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

用户数据

Type declaration

[key: string]: any

Memberof

Component

`Readonly` vertical

vertical: boolean

是否是竖井

Memberof

Laneway

Accessors

arrowSpace

get arrowSpace(): number
获取巷道外壁流动箭头间距

Returns number

Memberof
Laneway
set arrowSpace(value): void
设置巷道外壁流动箭头间距
Parameters
- value: number
Returns void

Memberof
Laneway

arrowVisible

get arrowVisible(): boolean
获取巷道外壁流动箭头是否可见

Returns boolean

Memberof
Laneway
set arrowVisible(value): void
设置巷道外壁流动箭头是否可见
Parameters
- value: boolean
Returns void

Memberof
Laneway

bottomArrowVisible

get bottomArrowVisible(): boolean
获取巷道底板外壁流动箭头是否可见

Returns boolean

Memberof
Laneway
set bottomArrowVisible(value): void
设置巷道底板外壁流动箭头是否可见
Parameters
- value: boolean
Returns void

Memberof
Laneway

bottomColor

get bottomColor(): ColorRepresentation
获取巷道内壁底板颜色（Gradient材质方案特有属性）

Returns ColorRepresentation

Memberof
Laneway
set bottomColor(value): void
设置巷道内壁底板颜色（Gradient材质方案特有属性）
Parameters
- value: ColorRepresentation
Returns void

Memberof
Laneway

bounds

get bounds(): Readonly<Box3>
获取世界外包范围

Returns Readonly<Box3>

Memberof
Renderable

Inherited from Renderable.bounds

color

set color(value): void
设置巷道外壁颜色
Parameters
- value: ColorRepresentation
Returns void

Memberof
Laneway

enabled

get enabled(): boolean
获取组件是否启用

Returns boolean

Memberof
Component

Inherited from Renderable.enabled
set enabled(value): void
启用或禁用组件
Parameters
- value: boolean
Returns void

Memberof
Component

Inherited from Renderable.enabled

endColor

get endColor(): ColorRepresentation
获取巷道外壁终点颜色

Returns ColorRepresentation

Memberof
Laneway
set endColor(value): void
设置巷道外壁终点颜色
Parameters
- value: ColorRepresentation
Returns void

Memberof
Laneway

endCrossing

get endCrossing(): LanewayCrossing
获取终点交叉口对象

Returns LanewayCrossing

Memberof
Laneway

endTopoID

get endTopoID(): string
获取巷道终点拓扑ID

Returns string

Memberof
Laneway

engine

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

Returns Engine

Memberof
EngineObject

Inherited from Renderable.engine

entity

get entity(): Entity
获取组件所属实体

Returns Entity

Memberof
Component

Inherited from Renderable.entity

flowDirection

get flowDirection(): number
获取巷道外壁箭头流动方向

Returns number

Memberof
Laneway
set flowDirection(value): void
设置巷道外壁箭头流动方向
Parameters
- value: number
Returns void

Memberof
Laneway

flowSpeed

get flowSpeed(): number
获取巷道外壁流动箭头流动速度

Returns number

Memberof
Laneway
set flowSpeed(value): void
设置巷道外壁流动箭头流动速度
Parameters
- value: number
Returns void

Memberof
Laneway

innerVisible

set innerVisible(value): void
设置巷道内壁是否可见
Parameters
- value: boolean
Returns void

Memberof
Laneway

leftArrowVisible

get leftArrowVisible(): boolean
获取巷道左邦外壁流动箭头是否可见

Returns boolean

Memberof
Laneway
set leftArrowVisible(value): void
设置巷道左邦外壁流动箭头是否可见
Parameters
- value: boolean
Returns void

Memberof
Laneway

length

get length(): number
获取巷道长度

Returns number

Memberof
Laneway

lod

set lod(value): void
设置巷道LOD等级
Parameters
- value: number
Returns void

Memberof
Laneway

object3D

get object3D(): Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]
获取渲染组件对应的Object3D（three.js）对象

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

Memberof
Renderable

Inherited from Renderable.object3D

outerVisible

set outerVisible(value): void
设置巷道外壁是否可见
Parameters
- value: boolean
Returns void

Memberof
Laneway

position

get position(): Vector3
获取本地位置

Returns Vector3

Memberof
Renderable

Inherited from Renderable.position
set position(value): void
设置本地位置
Parameters
- value: number[] | Vector3
Returns void

Memberof
Renderable

Inherited from Renderable.position

quaternion

get quaternion(): Quaternion
获取本地旋转四元数

Returns Quaternion

Memberof
Renderable

Inherited from Renderable.quaternion
set quaternion(value): void
设置本地旋转四元数
Parameters
- value: number[] | Quaternion
Returns void

Memberof
Renderable

Inherited from Renderable.quaternion

renderOrder

get renderOrder(): RenderOrder
获取渲染顺序

Returns RenderOrder

Memberof
Renderable

Inherited from Renderable.renderOrder
set renderOrder(value): void
设置渲染顺序
Parameters
- value: RenderOrder
Returns void

Memberof
Renderable

Inherited from Renderable.renderOrder

rightArrowVisible

get rightArrowVisible(): boolean
设置巷道右邦外壁流动箭头是否可见

Returns boolean

Memberof
Laneway
set rightArrowVisible(value): void
设置巷道右邦外壁流动箭头是否可见
Parameters
- value: boolean
Returns void

Memberof
Laneway

rotation

get rotation(): Euler
获取本地旋转角（单位：弧度）

Returns Euler

Memberof
Renderable

Inherited from Renderable.rotation
set rotation(value): void
设置本地旋转角（单位：弧度）
Parameters
- value: number[] | Euler
Returns void

Memberof
Renderable

Inherited from Renderable.rotation

scale

get scale(): Vector3
获取本地缩放

Returns Vector3

Memberof
Renderable

Inherited from Renderable.scale
set scale(value): void
设置本地缩放
Parameters
- value: number[] | Vector3
Returns void

Memberof
Renderable

Inherited from Renderable.scale

startColor

get startColor(): ColorRepresentation
获取巷道外壁起点颜色

Returns ColorRepresentation

Memberof
Laneway
set startColor(value): void
设置巷道外壁起点颜色
Parameters
- value: ColorRepresentation
Returns void

Memberof
Laneway

startCrossing

get startCrossing(): LanewayCrossing
获取起点交叉口对象

Returns LanewayCrossing

Memberof
Laneway

startTopoID

get startTopoID(): string
获取巷道起点拓扑ID

Returns string

Memberof
Laneway
set startTopoID(value): void
设置巷道起点拓扑ID
Parameters
- value: string
Returns void

Memberof
Laneway

topArrowVisible

get topArrowVisible(): boolean
获取巷道顶板外壁流动箭头是否可见

Returns boolean

Memberof
Laneway
set topArrowVisible(value): void
设置巷道顶板外壁流动箭头是否可见
Parameters
- value: boolean
Returns void

Memberof
Laneway

topOcclusion

set topOcclusion(value): void
是否启用顶板遮挡
Parameters
- value: boolean
Returns void

Memberof
Laneway

topVisible

set topVisible(value): void
设置巷道内外壁顶板是否可见
Parameters
- value: boolean
Returns void

Memberof
Laneway

visible

get visible(): boolean
获取是否可见

Returns boolean

Memberof
Laneway

Overrides Renderable.visible
set visible(value): void
设置是否可见
Parameters
- value: boolean
Returns void

Memberof
Laneway

Overrides Renderable.visible

worldPosition

get worldPosition(): Vector3
获取世界位置

Returns Vector3

Memberof
Renderable

Inherited from Renderable.worldPosition

worldQuaternion

get worldQuaternion(): Quaternion
获取世界旋转四元数

Returns Quaternion

Memberof
Renderable

Inherited from Renderable.worldQuaternion

worldScale

get worldScale(): Vector3
获取世界缩放

Returns Vector3

Memberof
Renderable

Inherited from Renderable.worldScale

Methods

`Protected` _destroy

_destroy(): void
Protected
销毁接口

Returns void

Memberof
Laneway

Overrides Renderable._destroy

`Protected` _onAwake

_onAwake(): void
Protected
唤醒组件

Returns void

Memberof
Component

Inherited from Renderable._onAwake

`Protected` _onDestroy

_onDestroy(): void
Protected
销毁渲染组件

Returns void

Memberof
Renderable

Inherited from Renderable._onDestroy

`Protected` _onDisable

_onDisable(): void
Protected
禁用巷道渲染组件

Returns void

Memberof
Laneway

Overrides Renderable._onDisable

`Protected` _onEnable

_onEnable(): void
Protected
启用巷道渲染组件

Returns void

Memberof
Laneway

Overrides Renderable._onEnable

`Protected` _updateBounds

_updateBounds(): void
Protected
更新渲染组件外包盒

Returns void

Memberof
Renderable

Inherited from Renderable._updateBounds

`Protected` _updateMatrixWorld

_updateMatrixWorld(): void
Protected
更新渲染组件世界矩阵

Returns void

Memberof
Renderable

Inherited from Renderable._updateMatrixWorld

`Protected` _updateRenderOrder

_updateRenderOrder(): void
Protected
更新渲染顺序

Returns void

Memberof
Renderable

Inherited from Renderable._updateRenderOrder

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 Renderable.addEventListener

append

append(leadNode): void
在巷道尾部追加一个或多个导线点，如果终点是交叉口则无法追加导线点
Parameters
- leadNode: LeadNode | LeadNode[]
Returns void

Memberof
Laneway

destroy

destroy(): void
销毁组件

Returns void

Memberof
Component

Inherited from Renderable.destroy

dispatchEvent

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

Memberof
EventDispatcher

Inherited from Renderable.dispatchEvent

dispose

dispose(): void
释放接口

Returns void

Memberof
EventDispatcher

Inherited from Renderable.dispose

localToWorld

localToWorld(vector): Vector3
本地坐标转世界坐标
Parameters
- vector: number[] | Vector3
  
  本地坐标
Returns Vector3

Memberof
Renderable

Inherited from Renderable.localToWorld

pop

pop(): void
移除巷道尾部导线点

Returns void

Memberof
Laneway

projectPoint

projectPoint(point): {
    endIndex: number;
    position: Vector3;
    startIndex: number;
}
计算点在巷道中线的投影点
Parameters
- point: number[] | Vector3
Returns {
    endIndex: number;
    position: Vector3;
    startIndex: number;
}
- endIndex: number
- position: Vector3
- startIndex: number
Memberof
Laneway

raycast

raycast(raycaster): Intersection<Object3D<Object3DEventMap>>
射线拾取
Parameters
- raycaster: Raycaster
Returns Intersection<Object3D<Object3DEventMap>>

Memberof
Laneway

Overrides Renderable.raycast

recoverMaterial

recoverMaterial(): void
恢复材质

Returns void

Memberof
Laneway

Overrides Renderable.recoverMaterial

removeAllEventListeners

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

Returns void

Memberof
EventDispatcher

Inherited from Renderable.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 Renderable.removeEventListener

removeEventListenerByEventId

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

Memberof
EventDispatcher

Inherited from Renderable.removeEventListenerByEventId

replaceMaterial

replaceMaterial(material): void
替换材质
Parameters
- material: Material | {
  edgeMaterial: Material;
  wallMaterial: Material;
  }
Returns void

Memberof
Laneway

Overrides Renderable.replaceMaterial

setActive

setActive(value): void
激活或冻结组件
Parameters
- value: boolean
Returns void

Memberof
Component

Inherited from Renderable.setActive

setClipping

setClipping(parameters?): void
设置裁剪
Parameters
- Optional parameters: ClippingParameters = {}
  
  裁剪参数
Returns void

Memberof
Renderable

Inherited from Renderable.setClipping

setHighlight

setHighlight(highlight, parameters?): void
设置是否高亮
Parameters
- highlight: boolean
- Optional parameters: HighlightParameters = {}
Returns void

Memberof
Laneway

Overrides Renderable.setHighlight

setStencil

setStencil(parameters?): void
设置模板参数
Parameters
- Optional parameters: StencilParameters = {}
  
  模板参数
Returns void

Memberof
Renderable

Inherited from Renderable.setStencil

setTransform

setTransform(transformation): void
设置本地方位信息
Parameters
- transformation: Transformation
  
  方位信息
Returns void

Memberof
Renderable

Inherited from Renderable.setTransform

shift

shift(): void
移除巷道头部导线点

Returns void

Memberof
Laneway

toJSON

toJSON(): {
[key: string]: any;
}
巷道转JSON

Returns {
[key: string]: any;
}
- [key: string]: any
Memberof
Laneway

translate

translate(index, offset): void
沿指定方向平移巷道非交叉口导线点
Parameters
- index: number
  
  导线点索引编号
- offset: number[] | Vector3
  
  平移距离
Returns void

Memberof
Laneway

translateTo

translateTo(index, target): void
平移巷道非交叉口导线点到目标位置
Parameters
- index: number
  
  导线点索引编号
- target: number[] | Vector3
  
  目标位置
Returns void

Memberof
Laneway

unshift

unshift(leadNode): void
在巷道的头部添加一个或多个导线点，如果起点是交叉口则无法添加导线点
Parameters
- leadNode: LeadNode | LeadNode[]
Returns void

Memberof
Laneway

update

update(): void
更新巷道

Returns void

Memberof
Laneway

updateLOD

updateLOD(cameraPosition, distance): void
更新巷道LOD
Parameters
- cameraPosition: Vector3
  
  相机世界位置
- distance: number
  
  LOD切换距离
Returns void

Memberof
Laneway

updateProperties

updateProperties(parameters): Promise<void>
批量更新组件属性
Parameters
- parameters: {
  [key: string]: any;
  }
  - [key: string]: any
Returns Promise<void>

Memberof
Component

Inherited from Renderable.updateProperties

worldToLocal

worldToLocal(vector): Vector3
世界坐标转本地坐标
Parameters
- vector: number[] | Vector3
  
  世界坐标
Returns Vector3

Memberof
Renderable

Inherited from Renderable.worldToLocal

Class Laneway

Export

Date

Author

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

entity: Entity

parameters: LanewayParameters

Returns Laneway

Properties

Protected _bounds

Protected _boundsUpdateFlag

Protected _engine

Protected _entity

Protected _object3D

Protected _renderOrder

Readonly code

Memberof

Readonly isRenderable

Memberof

Readonly leadNodes

Memberof

Readonly material

Memberof

Readonly materialScheme

Memberof

Readonly name

Memberof

Readonly parent

Memberof

queryMask

Memberof

Readonly sectionShape

Memberof

Readonly useLOD

Memberof

userData

Type declaration

[key: string]: any

Memberof

Readonly vertical

Memberof

Accessors

arrowSpace

Returns number

Memberof

Parameters

value: number

Returns void

Memberof

arrowVisible

Returns boolean

Memberof

Parameters

value: boolean

Returns void

Memberof

bottomArrowVisible

Returns boolean

Memberof

Parameters

value: boolean

Returns void

Memberof

bottomColor

Returns ColorRepresentation

Memberof

Parameters

value: ColorRepresentation

Returns void

Memberof

bounds

Returns Readonly<Box3>

`Protected` _bounds

`Protected` _boundsUpdateFlag

`Protected` _engine

`Protected` _entity

`Protected` _object3D

`Protected` _renderOrder

`Readonly` code

`Readonly` isRenderable

`Readonly` leadNodes

`Readonly` material

`Readonly` materialScheme

`Readonly` name

`Readonly` parent

`Readonly` sectionShape

`Readonly` useLOD

`Readonly` vertical