Options
All
  • Public
  • Public/Protected
  • All
Menu

Class POI

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

autoSize

  • get autoSize(): boolean
  • set autoSize(value: boolean): void

  • Returns boolean

  • Parameters

    • value: boolean

    Returns void

backgroundColor

  • get backgroundColor(): RgbaTuple
  • set backgroundColor(value: RgbaTuple): void

  • Returns RgbaTuple

  • Parameters

    • value: RgbaTuple

    Returns void

boundingInfo

clickable

  • get clickable(): boolean
  • set clickable(value: boolean): void

  • Returns boolean

  • Parameters

    • value: boolean

    Returns void

client

coord

  • 获取模型坐标。

    Note: 通过属性获取的坐标位置并非实时从世界中获取， 而是内存中最近一次查询所缓存的值。 有可能因为正在进行中的动画而导致数据错误。这种情况下，请使用 Model::getCoordinate() 获取实体的实时坐标。

    Returns Vector3

  • 设置模型坐标。

    Note: 通过属性获取的坐标位置并非实时从世界中获取， 而是内存中最近一次查询所缓存的值。 有可能因为正在进行中的动画而导致数据错误。这种情况下，请使用 Model::getCoordinate() 获取实体的实时坐标。

    Parameters

    Returns void

group

  • get group(): string
  • set group(value: string): void

  • Returns string

  • Parameters

    • value: string

    Returns void

icon

id

  • get id(): string

  • Returns string

name

  • get name(): string
  • set name(value: string): void

  • Returns string

  • Parameters

    • value: string

    Returns void

opacity

  • get opacity(): number
  • set opacity(value: number): void

  • Returns number

  • Parameters

    • value: number

    Returns void

position

  • 获取模型位置。

    Returns Vector3

  • 设置模型位置。

    Parameters

    Returns void

rotation

  • 获取模型旋转。

    Returns Quaternion

  • 设置模型旋转。

    Parameters

    Returns void

scale

  • 获取模型缩放。

    Returns Vector3

  • 设置模型缩放。

    Parameters

    Returns void

title

  • get title(): null | string
  • set title(value: null | string): void

  • Returns null | string

  • Parameters

    • value: null | string

    Returns void

transform

  • 获取当前模型的变换矩阵。

    Returns Matrix

translation

  • 获取模型平移。

    Returns Vector3

  • 设置模型平移。

    Parameters

    Returns void

visible

  • get visible(): boolean
  • set visible(val: boolean): void

  • 获取模型可见性。

    Returns boolean

  • 设置模型可见性。

    Parameters

    • val: boolean

    Returns void

Methods

addEventListener

animate

  • animate(keyframes: null | Iterable<PropertiesNullable<DivaKeyFrameOptions & AnimatableProperties>>, options?: DivaKeyframeEffectOptions): DivaAnimation
  • animate(keyframes: null | Iterable<PropertiesNullable<DivaKeyFrameOptions & AnimatableProperties>>, duration?: number): DivaAnimation

create

  • create(): Promise<void>

createMeta

  • createMeta(): JsonRpcRequestMeta

  • Returns JsonRpcRequestMeta

dispatchEvent

  • dispatchEvent(event: Event): boolean

focus

  • focus(distance: number, pitch: number): Promise<void>

  • 聚焦至当前模型。

    Parameters

    • distance: number

      与聚焦模型的距离，单位 cm

    • pitch: number

      纵倾（俯仰）弧度角度，正值向上

    Returns Promise<void>

getAnimations

getBoundingInfo

getCoordinate

  • getCoordinate(): Promise<Vector3>

getRotation

getScale

removeEventListener

  • removeEventListener(type: string, callback: EventListener<POI>): Promise<void>

rotate

  • 将模型在当前旋转的基础之上做增量旋转。

    Parameters

    Returns Promise<Quaternion>

    变换后的缩放四元数

scaling

  • 将模型在当前平移的基础之上做增量缩放。

    Parameters

    • delta: Vector3

      缩放增量向量

    Returns Promise<Vector3>

    变换后的缩放向量

setClient

  • 为实体指定关联的客户端

    throws

    {@link ClientAlreadySetError} 该错误将会在重复设置客户端时抛出

    Parameters

    Returns Promise<void>

setCoordinate

  • 设置模型位置坐标，可以通过变换设置动画。

    deprecated

    请使用 coord 向量代替元组。

    Parameters

    Returns Promise<void>

  • 设置模型位置坐标，可以通过变换设置动画。

    Parameters

    • coord: Vector3

      坐标向量

    • Optional transition: Transition

      模型坐标变换设置

    Returns Promise<void>

setRenderingStyleMode

  • 设置当前模型渲染风格为自发光模式。

    Parameters

    • mode: Emission

      自发光渲染模式

    • opt: { color: string; strength?: number }

      自发光参数选项

      • color: string

        自发光颜色, HEX 色值，支持 alpha 通道。

      • Optional strength?: number

        自发光强度,取值范围 0~50，建议不超过 0.5，否则容易过亮。

    Returns Promise<void>

  • 设置当前模型渲染风格模式。

    Parameters

    Returns Promise<void>

setRotation

  • setRotation(rotation: Quaternion): Promise<void>

  • 设置模型变换的旋转。旋转中心为模型原点。

    Parameters

    Returns Promise<void>

setScale

  • setScale(scale: Vector3): Promise<void>

  • 设置模型变换的缩放。

    Parameters

    • scale: Vector3

      表示缩放的向量

    Returns Promise<void>

setTranslation

  • setTranslation(translation: Vector3): Promise<void>

setVisibility

  • setVisibility(visible: boolean): Promise<void>

  • 设置模型可见性。

    Parameters

    • visible: boolean

    Returns Promise<void>

setWebWidget

  • setWebWidget(uri: null): Promise<void>
  • setWebWidget(uri: URL, options: WebWidgetOptions): Promise<void>

  • 传入 null，将绑定的 Web 组件置空。

    Parameters

    • uri: null

      空值

    Returns Promise<void>

  • 设置 Web 组件。

    Parameters

    • uri: URL

      加载的地址，支持 http(s): , rtmp: 与 rtsp: 协议。

    • options: WebWidgetOptions

      web 组件选项

    Returns Promise<void>

translate

  • 将模型在当前平移的基础之上做增量平移。

    Parameters

    • delta: Vector3

      平移增量向量

    Returns Promise<Vector3>

    变换后的平移向量

update

  • update(mode: "pull"): Promise<Defined>
  • update(mode: "push"): Promise<void>
  • update(): Promise<void>