Class WaterPolygon

多边形水块组件

Export

Date

2023.6.15

Author

xwb

Hierarchy

  • WaterCubeBase
    • WaterPolygon

Constructors

constructor

Properties

_bounds _boundsUpdateFlag _depth _engine _entity _geometry _materials _object3D _renderOrder _sideMaterial _waterMaterial _waterMesh _width isRenderable queryMask userData

Accessors

amplitude bounds depth direction enabled engine entity height object3D pointColor pointDensity position quaternion renderOrder rotation scale sideBottomColor sideOpacity sideTopColor timeSpeed topColor topColorContrast topOpacity usePoint visible waveCount wavecount wavelength wavepeak width worldPosition worldQuaternion worldScale

Methods

_destroy _getSegments _onAwake _onDestroy _onDisable _onEnable _setupWaves _updateBounds _updateMatrixWorld _updateRenderOrder addEventListener destroy dispatchEvent dispose localToWorld raycast recoverMaterial removeAllEventListeners removeEventListener removeEventListenerByEventId replaceMaterial setActive setClipping setHighlight setStencil setTransform updateProperties worldToLocal

Constructors

constructor

Properties

Protected _bounds

_bounds: Box3

Protected _boundsUpdateFlag

_boundsUpdateFlag: BoolUpdateFlag

Protected _depth

_depth: number

Protected _engine

_engine: Engine

Protected _entity

_entity: Entity

Protected _geometry

_geometry: BufferGeometry<NormalBufferAttributes>

Protected _materials

_materials: Material | Material[]

Protected _object3D

_object3D: Object3D<Object3DEventMap>

Protected _renderOrder

_renderOrder: RenderOrder

Protected _sideMaterial

_sideMaterial: ShaderMaterial

Protected _waterMaterial

_waterMaterial: ShaderMaterial

Protected _waterMesh

_waterMesh: Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

Protected _width

_width: number

Readonly isRenderable

isRenderable: true = true

可渲染组件标识

Memberof

Renderable

queryMask

queryMask: number

查询遮罩值

Memberof

Renderable

userData

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

用户数据

Type declaration

  • [key: string]: any

Memberof

Component

Accessors

amplitude

  • get amplitude(): number

  • 水波高度

    Returns number

    Memberof

    WaterCubeBase

  • set amplitude(value): void

  • 水波高度

    Parameters

    • value: number

    Returns void

    Memberof

    WaterCubeBase

bounds

  • get bounds(): Readonly<Box3>

  • 获取世界外包范围

    Returns Readonly<Box3>

    Memberof

    Renderable

depth

  • get depth(): number

  • 获取深度

    Returns number

    Memberof

    WaterCubeBase

direction

  • get direction(): number

  • 水波方向

    Returns number

    Memberof

    WaterCubeBase

  • set direction(value): void

  • 水波方向

    Parameters

    • value: number

    Returns void

    Memberof

    WaterCubeBase

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

height

  • get height(): number

  • 水面高度

    Returns number

    Memberof

    WaterCubeBase

  • set height(value): void

  • 水面高度（代表从0点坐标向上的距离 负值代表向下）

    Parameters

    • value: number

    Returns void

    Memberof

    WaterCubeBase

object3D

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

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

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

    Memberof

    Renderable

pointColor

  • get pointColor(): number

  • 水面点颜色

    Returns number

    Memberof

    WaterCubeBase

  • set pointColor(value): void

  • 水面点颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    WaterCubeBase

pointDensity

  • get pointDensity(): number

  • 水面点密度

    Returns number

    Memberof

    WaterCubeBase

  • set pointDensity(density): void

  • 水面点密度

    Parameters

    • density: number

    Returns void

    Memberof

    WaterCubeBase

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

    • value: RenderOrder

    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

sideBottomColor

  • get sideBottomColor(): number

  • 侧面底部颜色

    Returns number

    Memberof

    WaterCubeBase

  • set sideBottomColor(value): void

  • 侧面底部颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    WaterCubeBase

sideOpacity

  • get sideOpacity(): number

  • 侧面透明度

    Returns number

    Memberof

    WaterCubeBase

  • set sideOpacity(value): void

  • 侧面透明度

    Parameters

    • value: number

    Returns void

    Memberof

    WaterCubeBase

sideTopColor

  • get sideTopColor(): number

  • 侧面顶部颜色

    Returns number

    Memberof

    WaterCubeBase

  • set sideTopColor(value): void

  • 侧面顶部颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    WaterCubeBase

timeSpeed

  • get timeSpeed(): number

  • 水波波动速度

    Returns number

    Memberof

    WaterCubeBase

  • set timeSpeed(intensity): void

  • 水波波动速度

    Parameters

    • intensity: number

    Returns void

    Memberof

    WaterCubeBase

topColor

  • get topColor(): number

  • 水面颜色

    Returns number

    Memberof

    WaterCubeBase

  • set topColor(value): void

  • 水面颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    WaterCubeBase

topColorContrast

  • get topColorContrast(): number

  • 是否渲染点

    Returns number

    Memberof

    WaterCubeBase

  • set topColorContrast(value): void

  • 水面颜色对比度

    Parameters

    • value: number

    Returns void

    Memberof

    WaterCubeBase

topOpacity

  • get topOpacity(): number

  • 水面透明度

    Returns number

    Memberof

    WaterCubeBase

  • set topOpacity(value): void

  • 水面透明度

    Parameters

    • value: number

    Returns void

    Memberof

    WaterCubeBase

usePoint

  • get usePoint(): boolean

  • 是否渲染点

    Returns boolean

    Memberof

    WaterCubeBase

visible

  • get visible(): boolean

  • 获取是否可见

    Returns boolean

    Memberof

    Renderable

  • set visible(value): void

  • 设置是否可见

    Parameters

    • value: boolean

    Returns void

    Memberof

    Renderable

waveCount

  • get waveCount(): number

  • 水波叠加数量

    Returns number

    Memberof

    WaterCubeBase

wavecount

  • set wavecount(value): void

  • 水波叠加数量

    Parameters

    • value: number

    Returns void

    Memberof

    WaterCubeBase

wavelength

  • get wavelength(): number

  • 水波波长

    Returns number

    Memberof

    WaterCubeBase

  • set wavelength(value): void

  • 水波波长

    Parameters

    • value: number

    Returns void

    Memberof

    WaterCubeBase

wavepeak

  • get wavepeak(): number

  • 水波尖锐度

    Returns number

    Memberof

    WaterCubeBase

  • set wavepeak(value): void

  • 水波尖锐度

    Parameters

    • value: number

    Returns void

    Memberof

    WaterCubeBase

width

  • get width(): number

  • 获取宽度

    Returns number

    Memberof

    WaterCubeBase

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

    WaterCubeBase

Protected _getSegments

  • _getSegments(resolutionScale): {
        depthSegments: number;
        widthSegments: number;
    }
  • Protected

    获取网格分段数

    Parameters

    • resolutionScale: number

    Returns {
        depthSegments: number;
        widthSegments: number;
    }

    {{ widthSegments: number, depthSegments: number }}

    • depthSegments: number
    • widthSegments: number

    Memberof

    WaterCubeBase

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 _setupWaves

  • _setupWaves(a, d, l, waveCount?, defaultValue?): void

  • 构建水面波动参数

    Parameters

    • a: number

      强度

    • d: number

      方向

    • l: number

      波长

    • Optional waveCount: number = 8
    • defaultValue: boolean = false

    Returns void

    Memberof

    WaterCubeBase

Protected _updateBounds

  • _updateBounds(): void
  • Protected

    更新渲染组件外包盒

    Returns void

    Memberof

    Renderable

Protected _updateMatrixWorld

  • _updateMatrixWorld(): void
  • Protected

    更新渲染组件世界矩阵

    Returns void

    Memberof

    Renderable

Protected _updateRenderOrder

  • _updateRenderOrder(): void
  • Protected

    更新渲染顺序

    Returns void

    Memberof

    Renderable

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

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

    WaterCubeBase

recoverMaterial

  • 恢复材质

    Returns void

    Memberof

    Renderable

removeAllEventListeners

  • 移除所有事件监听器

    Returns void

    Memberof

    EventDispatcher

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

  • 设置裁剪

    Parameters

    • Optional parameters: ClippingParameters

      裁剪参数

    Returns void

    Memberof

    Renderable

setHighlight

  • 设置是否高亮

    Parameters

    • highlight: boolean

      是否高亮

    • Optional parameters: HighlightParameters

      高亮参数

    Returns void

    Memberof

    Renderable

setStencil

  • 设置模板参数

    Parameters

    • Optional parameters: StencilParameters

      模板参数

    Returns void

    Memberof

    Renderable

setTransform

  • 设置本地方位信息

    Parameters

    • transformation: Transformation

      方位信息

    Returns void

    Memberof

    Renderable

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