Class LanewayCrossing

巷道交叉口渲染组件

Export

Date

2022.4.13

Author

lyx

Hierarchy

Renderable
- LanewayCrossing

Index

Constructors

constructor

Properties

_bounds _boundsUpdateFlag _engine _entity _object3D _renderOrder centerPosition id isRenderable material materialScheme queryMask relativeCenterPosition sectionShape topoID useLOD userData

Constructors

constructor

new LanewayCrossing(entity, parameters): LanewayCrossing
Parameters
- entity: Entity
- parameters: LanewayCrossingParameters
Returns LanewayCrossing

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` centerPosition

centerPosition: Vector3

交叉口中心点位置

Memberof

LanewayCrossing

`Readonly` id

id: number

交叉口ID

Memberof

LanewayCrossing

`Readonly` isRenderable

isRenderable: true = true

可渲染组件标识

Memberof

Renderable

`Readonly` material

material: string

材质名称

Memberof

LanewayCrossing

`Readonly` materialScheme

materialScheme: string

材质方案

Memberof

LanewayCrossing

queryMask

queryMask: number = 0

查询遮罩值

Memberof

Renderable

`Readonly` relativeCenterPosition

relativeCenterPosition: Vector3 = ...

交叉口中心点相对位置

Memberof

LanewayCrossing

`Readonly` sectionShape

sectionShape: string

断面形状

Memberof

LanewayCrossing

`Readonly` topoID

topoID: string

交叉口拓扑ID

Memberof

LanewayCrossing

`Readonly` useLOD

useLOD: boolean

是否启用LOD

Memberof

LanewayCrossing

userData

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

用户数据

Type declaration

[key: string]: any

Memberof

Component

Accessors

bottomColor

get bottomColor(): ColorRepresentation
获取内壁底板颜色

Returns ColorRepresentation

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

Memberof
LanewayCrossing

bounds

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

Returns Readonly<Box3>

Memberof
Renderable

Inherited from Renderable.bounds

branchCount

get branchCount(): number
获取交叉口分支个数

Returns number

Memberof
LanewayCrossing

color

get color(): ColorRepresentation
获取外壁颜色

Returns ColorRepresentation

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

Memberof
LanewayCrossing

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

engine

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

Returns Engine

Memberof
EngineObject

Inherited from Renderable.engine

entity

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

Returns Entity

Memberof
Component

Inherited from Renderable.entity

innerVisible

get innerVisible(): boolean
获取内壁是否可见

Returns boolean

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

Memberof
LanewayCrossing

lod

set lod(value): void
设置交叉口LOD等级
Parameters
- value: number
Returns void

Memberof
LanewayCrossing

object3D

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

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

Memberof
Renderable

Inherited from Renderable.object3D

outerVisible

get outerVisible(): boolean
获取外壁是否可见

Returns boolean

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

Memberof
LanewayCrossing

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

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

topOcclusion

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

Memberof
LanewayCrossing

topVisible

get topVisible(): boolean
获取内外壁顶板是否可见

Returns boolean

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

Memberof
LanewayCrossing

visible

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

Returns boolean

Memberof
LanewayCrossing

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
LanewayCrossing

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
LanewayCrossing

Overrides Renderable._onDisable

`Protected` _onEnable

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

Returns void

Memberof
LanewayCrossing

Overrides Renderable._onEnable

`Protected` _updateBounds

_updateBounds(): void
Protected
更新外包盒

Returns void

Memberof
LanewayCrossing

Overrides Renderable._updateBounds

`Protected` _updateMatrixWorld

_updateMatrixWorld(): void
Protected
更新世界矩阵

Returns void

Memberof
LanewayCrossing

Overrides Renderable._updateMatrixWorld

`Protected` _updateRenderOrder

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

Returns void

Memberof
Renderable

Inherited from Renderable._updateRenderOrder

addBranch

addBranch(branch): void
添加一个分支（注：需要手动Update，才会改变交叉口形态）
Parameters
- branch: Branch
Returns void

Memberof
LanewayCrossing

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

connect

connect(laneway): void
交叉口连接巷道
Parameters
- laneway: Laneway
Returns void

Memberof
LanewayCrossing

connectTo

connectTo(laneway, toHead?): void
交叉口连接巷道的起点或终点
Parameters
- laneway: Laneway
- Optional toHead: boolean = true
  
  连接起点还是终点（true->起点，false->终点）
Returns void

Memberof
LanewayCrossing

destroy

destroy(): void
销毁组件

Returns void

Memberof
Component

Inherited from Renderable.destroy

disconnect

disconnect(laneway): void
从交叉口上断开巷道（注：当分支个数等于0时会自动释放交叉口渲染数据但组件不会被移除）
Parameters
- laneway: Laneway
Returns void

Memberof
LanewayCrossing

disconnectAll

disconnectAll(): void
断开交叉口上的所有巷道（注：会同时释放交叉口渲染数据但组件不会被移除）

Returns void

Memberof
LanewayCrossing

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

getBranch

getBranch(index): Branch
获取指定索引分支
Parameters
- index: number
Returns Branch

Memberof
LanewayCrossing

localToWorld

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

Memberof
Renderable

Inherited from Renderable.localToWorld

lookupBranch

lookupBranch(code): Branch
查找分支
Parameters
- code: string
  
  分支所属巷道编码
Returns Branch

Memberof
LanewayCrossing

raycast

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

Memberof
LanewayCrossing

Overrides Renderable.raycast

recoverMaterial

recoverMaterial(): void
恢复材质

Returns void

Memberof
LanewayCrossing

Overrides Renderable.recoverMaterial

removeAllEventListeners

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

Returns void

Memberof
EventDispatcher

Inherited from Renderable.removeAllEventListeners

removeBranch

removeBranch(code): void
移除一个分支（注：需要手动Update，才会改变交叉口形态）
Parameters
- code: string
  
  分支所属巷道编号
Returns void

Memberof
LanewayCrossing

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: {
      innerMaterial?: Material;
      outerMaterial?: Material;
      wireframeMaterial?: Material;
  }
  - Optional innerMaterial?: Material
  - Optional outerMaterial?: Material
  - Optional wireframeMaterial?: Material
Returns void

Memberof
LanewayCrossing

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
LanewayCrossing

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

toJSON

toJSON(): {
[key: string]: any;
}
交叉口转JSON

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

translate

translate(offset): void
沿指定方向平移交叉口
Parameters
- offset: number[] | Vector3
  
  平移距离
Returns void

Memberof
LanewayCrossing

translateTo

translateTo(target): void
平移交叉口到目标位置
Parameters
- target: number[] | Vector3
  
  目标位置
Returns void

Memberof
LanewayCrossing

update

update(excludedBranches?): void
更新交叉口
Parameters
- Optional excludedBranches: string[] = []
  
  排除的分支编码数组
Returns void

Memberof
LanewayCrossing

updateLOD

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

Memberof
LanewayCrossing

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 LanewayCrossing

Export

Date

Author

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

entity: Entity

parameters: LanewayCrossingParameters

Returns LanewayCrossing

Properties

Protected _bounds

Protected _boundsUpdateFlag

Protected _engine

Protected _entity

Protected _object3D

Protected _renderOrder

Readonly centerPosition

Memberof

Readonly id

Memberof

Readonly isRenderable

Memberof

Readonly material

Memberof

Readonly materialScheme

Memberof

queryMask

Memberof

Readonly relativeCenterPosition

Memberof

Readonly sectionShape

Memberof

Readonly topoID

Memberof

Readonly useLOD

Memberof

userData

Type declaration

[key: string]: any

Memberof

Accessors

bottomColor

Returns ColorRepresentation

Memberof

Parameters

value: ColorRepresentation

Returns void

Memberof

bounds

Returns Readonly<Box3>

Memberof

branchCount

Returns number

Memberof

color

Returns ColorRepresentation

Memberof

Parameters

value: ColorRepresentation

Returns void

Memberof

enabled

Returns boolean

Memberof

Parameters

value: boolean

Returns void

Memberof

engine

Returns Engine

Memberof

entity

Returns Entity

`Protected` _bounds

`Protected` _boundsUpdateFlag

`Protected` _engine

`Protected` _entity

`Protected` _object3D

`Protected` _renderOrder

`Readonly` centerPosition

`Readonly` id

`Readonly` isRenderable

`Readonly` material

`Readonly` materialScheme

`Readonly` relativeCenterPosition

`Readonly` sectionShape

`Readonly` topoID

`Readonly` useLOD