Class Stratum

地层渲染组件

Export

Date

2022.5.27

Author

lyx

Hierarchy

Constructors

constructor

Properties

_bounds _boundsUpdateFlag _engine _entity _object3D _renderOrder category code isRenderable parentCode queryMask surface userData

Accessors

bottomVisible boundaryVisible bounds enabled engine entity gridColor gridIntensity gridRatio gridSize gridVisible maskCenter maskColor maskOpacity maskRadius object3D opacity outlineVisible position quaternion renderOrder rotation scale topVisible visible wireframe worldPosition worldQuaternion worldScale

Methods

_destroy _onAwake _onDestroy _onDisable _onEnable _updateBounds _updateMatrixWorld _updateRenderOrder addEventListener destroy digs dispatchEvent dispose localToWorld query raycast recoverMaterial removeAllEventListeners removeEventListener removeEventListenerByEventId replaceMaterial reset sections setActive setClipping setHighlight setStencil setTransform slices 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 category

category: string

地层类型

Memberof

Stratum

Readonly code

code: string

地层编码

Memberof

Stratum

Readonly isRenderable

isRenderable: true = true

可渲染组件标识

Memberof

Renderable

Readonly parentCode

parentCode: string

地层父编码

Memberof

Stratum

queryMask

queryMask: number = 0

查询遮罩值

Memberof

Renderable

Readonly surface

surface: boolean

标识是否是地表层（地表层只有底板数据）

Memberof

Stratum

userData

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

用户数据

Type declaration

  • [key: string]: any

Memberof

Component

Accessors

bottomVisible

  • get bottomVisible(): boolean

  • 获取底面是否可见

    Returns boolean

    Memberof

    Stratum

  • set bottomVisible(value): void

  • 设置底面是否可见

    Parameters

    • value: boolean

    Returns void

    Memberof

    Stratum

boundaryVisible

  • get boundaryVisible(): boolean

  • 获取侧面是否可见

    Returns boolean

    Memberof

    Stratum

  • set boundaryVisible(value): void

  • 设置侧面是否可见

    Parameters

    • value: boolean

    Returns void

    Memberof

    Stratum

bounds

  • get bounds(): Readonly<Box3>

  • 获取世界外包范围

    Returns Readonly<Box3>

    Memberof

    Renderable

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

gridColor

  • get gridColor(): ColorRepresentation

  • 获取上下表面附着网格颜色

    Returns ColorRepresentation

    Memberof

    Stratum

  • set gridColor(value): void

  • 设置上下表面附着网格颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    Stratum

gridIntensity

  • get gridIntensity(): Readonly<Vector2>

  • 获取网格强度

    Returns Readonly<Vector2>

    Memberof

    Stratum

gridRatio

  • get gridRatio(): number

  • 获取上下表面附着网格比率

    Returns number

    Memberof

    Stratum

  • set gridRatio(value): void

  • 设置上下表面附着网格比率

    Parameters

    • value: number

    Returns void

    Memberof

    Stratum

gridSize

  • get gridSize(): number

  • 获取上下表面附着网格大小

    Returns number

    Memberof

    Stratum

  • set gridSize(value): void

  • 设置上下表面附着网格大小

    Parameters

    • value: number

    Returns void

    Memberof

    Stratum

gridVisible

  • get gridVisible(): boolean

  • 获取上下表面附着网格是否可见

    Returns boolean

    Memberof

    Stratum

  • set gridVisible(value): void

  • 设置上下表面附着网格是否可见

    Parameters

    • value: boolean

    Returns void

    Memberof

    Stratum

maskCenter

  • get maskCenter(): Vector3

  • 获取遮罩中心点

    Returns Vector3

    Memberof

    Stratum

  • set maskCenter(value): void

  • 设置遮罩中心点

    Parameters

    • value: number[] | Vector3

    Returns void

    Memberof

    Stratum

maskColor

  • get maskColor(): ColorRepresentation

  • 获取遮罩颜色

    Returns ColorRepresentation

    Memberof

    Stratum

  • set maskColor(value): void

  • 设置遮罩颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    Stratum

maskOpacity

  • get maskOpacity(): number

  • 获取遮罩透明度

    Returns number

    Memberof

    Stratum

  • set maskOpacity(value): void

  • 设置遮罩透明度

    Parameters

    • value: number

    Returns void

    Memberof

    Stratum

maskRadius

  • get maskRadius(): number

  • 获取遮罩半径

    Returns number

    Memberof

    Stratum

  • set maskRadius(value): void

  • 设置遮罩半径

    Parameters

    • value: number

    Returns void

    Memberof

    Stratum

object3D

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

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

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

    Memberof

    Renderable

opacity

  • get opacity(): number

  • 获取透明度

    Returns number

    Memberof

    Stratum

  • set opacity(value): void

  • 设置透明度

    Parameters

    • value: number

    Returns void

    Memberof

    Stratum

outlineVisible

  • get outlineVisible(): boolean

  • 获取边框是否可见

    Returns boolean

    Memberof

    Stratum

  • set outlineVisible(value): void

  • 设置边框是否可见

    Parameters

    • value: boolean

    Returns void

    Memberof

    Stratum

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

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

topVisible

  • get topVisible(): boolean

  • 获取顶面是否可见

    Returns boolean

    Memberof

    Stratum

  • set topVisible(value): void

  • 设置顶面是否可见

    Parameters

    • value: boolean

    Returns void

    Memberof

    Stratum

visible

  • get visible(): boolean

  • 获取是否可见

    Returns boolean

    Memberof

    Renderable

  • set visible(value): void

  • 设置是否可见

    Parameters

    • value: boolean

    Returns void

    Memberof

    Renderable

wireframe

  • get wireframe(): boolean

  • 获取是否启用线框模式

    Returns boolean

    Memberof

    Stratum

  • set wireframe(value): void

  • 设置是否启用线框模式

    Parameters

    • value: boolean

    Returns void

    Memberof

    Stratum

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

    Stratum

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

destroy

  • 销毁组件

    Returns void

    Memberof

    Component

digs

  • 开挖地层

    Parameters

    • points: (Vector3 | [number, number, number])[]

    Returns void

    Memberof

    Stratum

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

query

  • 查询地层

    Parameters

    • parameters: number[] | Vector3 | Ray

    Returns {
        bottomPoint: Vector3;
        code: string;
        topPoint: Vector3;
    }

    • bottomPoint: Vector3
    • code: string
    • topPoint: Vector3

    Memberof

    Stratum

raycast

  • 射线拾取

    Parameters

    • raycaster: Raycaster

    Returns Intersection<Object3D<Object3DEventMap>>

    Memberof

    Stratum

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

replaceMaterial

  • 替换材质

    Parameters

    • material: Material | {
          bottomMaterial: Material;
          boundaryMaterial: Material;
          topMaterial: Material;
      }

    Returns void

    Memberof

    Stratum

reset

  • 重置地层

    Returns void

    Memberof

    Stratum

sections

  • 剖切地层

    Parameters

    • lines: (Vector3 | [number, number, number])[][]

    Returns void

    Memberof

    Stratum

setActive

  • 激活或冻结组件

    Parameters

    • value: boolean

    Returns void

    Memberof

    Component

setClipping

setHighlight

setStencil

  • 设置模板参数

    Parameters

    Returns void

    Memberof

    Renderable

setTransform

  • 设置本地方位信息

    Parameters

    Returns void

    Memberof

    Renderable

slices

  • 地层切片

    Parameters

    • lines: (Vector3 | [number, number, number])[][]

    Returns void

    Memberof

    Stratum

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