Class Potree

Potree点云组件

Export

Date

2022.5.7

Author

lyx

Hierarchy

  • Renderable
    • Potree

Constructors

constructor

Properties

_bounds _boundsUpdateFlag _engine _entity _object3D _renderOrder baseUrl extension extensionOctree hierarchyStepSize isRenderable maxCount maxDepth parser queryMask root spacing sseThreshold userData version

Accessors

adaptiveSize bounds boundsColor boundsMaterial boundsVisible displayMode enabled engine entity material maxSize minSize object3D opacity position quaternion renderOrder rotation scale size visible worldPosition worldQuaternion worldScale

Methods

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

Constructors

constructor

  • Parameters

    Returns Potree

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

baseUrl

baseUrl: string

基础Url地址

Memberof

Potree

extension

extension: string

点云文件扩展

Memberof

Potree

extensionOctree

extensionOctree: string

点云树文件扩展

Memberof

Potree

hierarchyStepSize

hierarchyStepSize: number

树层级

Memberof

Potree

Readonly isRenderable

isRenderable: true = true

可渲染组件标识

Memberof

Renderable

maxCount

maxCount: number

点总数

Memberof

Potree

maxDepth

maxDepth: number

八叉树最大深度

Memberof

Potree

parser

parser: PotreeParser

解析器

Memberof

Potree

queryMask

queryMask: number

查询遮罩值

Memberof

Renderable

root

root: PotreeNode

根节点

Memberof

Potree

spacing

spacing: number

点间距

Memberof

Potree

sseThreshold

sseThreshold: number

sse（Screen Space Error）阈值

Memberof

Potree

userData

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

用户数据

Type declaration

  • [key: string]: any

Memberof

Component

version

version: Version

数据版本号

Memberof

Potree

Accessors

adaptiveSize

  • get adaptiveSize(): boolean

  • 获取是否自适应尺寸

    Returns boolean

    Memberof

    Potree

  • set adaptiveSize(value): void

  • 设置是否自适应尺寸

    Parameters

    • value: boolean

    Returns void

    Memberof

    Potree

bounds

  • get bounds(): Readonly<Box3>

  • 获取外包范围

    Returns Readonly<Box3>

    Memberof

    Potree

boundsColor

  • set boundsColor(value): void

  • 设置外包盒颜色

    Parameters

    • value: ColorRepresentation

    Returns void

    Memberof

    Potree

boundsMaterial

  • get boundsMaterial(): Readonly<LineBasicMaterial>

  • 获取外包盒材质

    Returns Readonly<LineBasicMaterial>

    Memberof

    Potree

boundsVisible

  • set boundsVisible(value): void

  • 设置外包盒是否可见

    Parameters

    • value: boolean

    Returns void

    Memberof

    Potree

displayMode

  • get displayMode(): DisplayMode

  • 获取显示模式

    Returns DisplayMode

    Memberof

    Potree

  • set displayMode(value): void

  • 设置显示模式

    Parameters

    Returns void

    Memberof

    Potree

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

material

  • get material(): Readonly<ShaderMaterial>

  • 获取点云材质

    Returns Readonly<ShaderMaterial>

    Memberof

    Potree

maxSize

  • get maxSize(): number

  • 获取点最大尺寸

    Returns number

    Memberof

    Potree

  • set maxSize(value): void

  • 设置点最大尺寸

    Parameters

    • value: number

    Returns void

    Memberof

    Potree

minSize

  • get minSize(): number

  • 获取点最小尺寸

    Returns number

    Memberof

    Potree

  • set minSize(value): void

  • 设置点最小尺寸

    Parameters

    • value: number

    Returns void

    Memberof

    Potree

object3D

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

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

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

    Memberof

    Renderable

opacity

  • get opacity(): number

  • 获取透明度

    Returns number

    Memberof

    Potree

  • set opacity(value): void

  • 设置透明度

    Parameters

    • value: number

    Returns void

    Memberof

    Potree

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(): Readonly<RenderOrder>

  • 获取点云渲染队列

    Returns Readonly<RenderOrder>

    Memberof

    Potree

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

size

  • get size(): number

  • 获取点尺寸

    Returns number

    Memberof

    Potree

  • set size(value): void

  • 设置点尺寸

    Parameters

    • value: number

    Returns void

    Memberof

    Potree

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

    Potree

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

    Potree

Protected _onEnable

  • _onEnable(): void
  • Protected

    启用组件

    Returns void

    Memberof

    Potree

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

onCameraChanged

  • 相机改变事件回调

    Parameters

    • event: any

    Returns void

    Memberof

    Potree

raycast

  • 射线拾取

    Parameters

    • raycaster: Raycaster

    Returns Intersection<Object3D<Object3DEventMap>>

    Memberof

    Potree

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

update

  • 逐帧更新用于驱动数据加载

    Parameters

    • timeSinceLastFrame: number
    • totalTime: number

    Returns void

    Memberof

    Potree

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