Class Polygon

表示覆盖物的类。

Hierarchy

Overlay
- Polygon

Constructors

constructor

new Polygon(config: PolygonConfig): Polygon
Parameters
- config: PolygonConfig
Returns Polygon

Overrides Overlay.constructor

Properties

onclick

onclick: null | ((this: Model, evt: DivaMouseEvent) => void) = null

ondblclick

ondblclick: null | ((this: Model, evt: DivaMouseEvent) => void) = null

onmousedown

onmousedown: null | ((this: Model, evt: DivaMouseEvent) => void) = null

onmouseup

onmouseup: null | ((this: Model, evt: DivaMouseEvent) => void) = null

Accessors

boundingInfo

get boundingInfo(): BoundingInfo
获取模型边界包围信息。

Returns BoundingInfo

Inherited from Overlay.boundingInfo

clickable

get clickable(): boolean
获取模型可点击性。

Returns boolean

Inherited from Overlay.clickable
set clickable(value: boolean): void
设置模型可点击性。
Parameters
- value: boolean
Returns void

Inherited from Overlay.clickable

client

get client(): JsonRpcClient
Returns JsonRpcClient

Inherited from Overlay.client

coord

get coord(): Vector3
获取模型坐标。

Deprecated
请使用 position 代替

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

Returns Vector3

Inherited from Overlay.coord
set coord(vector: Vector3): void
设置模型坐标。

Deprecated
请使用 position 代替
Parameters
- vector: Vector3
Returns void

Inherited from Overlay.coord

coordinate

get coordinate(): null | CimCoordinates | CoordinateTuple
获取经纬度坐标。

Returns null | CimCoordinates | CoordinateTuple

Inherited from Overlay.coordinate
set coordinate(value: null | CimCoordinates | CoordinateTuple): void
设置经纬度坐标，仅 CIM 模式下支持。
Parameters
- value: null | CimCoordinates | CoordinateTuple
Returns void

Inherited from Overlay.coordinate

coordinates

get coordinates(): undefined | CoordinateTuple[] | CimCoordinates[]
获取各经纬度坐标位置。

Returns undefined | CoordinateTuple[] | CimCoordinates[]
set coordinates(value: undefined | CoordinateTuple[] | CimCoordinates[]): void
设置各经纬度坐标位置，仅 CIM 模式下支持。
Parameters
- value: undefined | CoordinateTuple[] | CimCoordinates[]
Returns void

definition

get definition(): undefined | MaterialDefinition[]
获取材质详细定义。

Returns undefined | MaterialDefinition[]
set definition(value: undefined | MaterialDefinition[]): void
设置材质详细定义。
Parameters
- value: undefined | MaterialDefinition[]
Returns void

group

get group(): string
获取模型在资源列表中的目录名称。

Returns string

Inherited from Overlay.group
set group(value: string): void
设置模型在资源列表中的目录名称。
Parameters
- value: string
Returns void

Inherited from Overlay.group

height

get height(): undefined | number
获取体高度，单位 cm。

Returns undefined | number
set height(value: undefined | number): void
设置体高度，单位 cm。
Parameters
- value: undefined | number
Returns void

id

get id(): string
Returns string

Inherited from Overlay.id

material

get material(): undefined | Material
获取材质。

Returns undefined | Material
set material(value: undefined | Material): void
设置材质。
Parameters
- value: undefined | Material
Returns void

name

get name(): null | string
Returns null | string

Inherited from Overlay.name
set name(value: null | string): void
Parameters
- value: null | string
Returns void

Inherited from Overlay.name

position

get position(): Vector3
获取模型世界笛卡尔坐标位置。

Returns Vector3

Inherited from Overlay.position
set position(value: Vector3): void
设置模型世界笛卡尔坐标位置。

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

Inherited from Overlay.position

positions

get positions(): Vector3[]
获取各世界坐标位置。

Returns Vector3[]
set positions(value: Vector3[]): void
设置各世界坐标位置。
Parameters
- value: Vector3[]
Returns void

rotation

get rotation(): Quaternion
获取模型旋转。

Returns Quaternion

Inherited from Overlay.rotation
set rotation(value: Quaternion): void
设置模型旋转。
Parameters
- value: Quaternion
Returns void

Inherited from Overlay.rotation

scale

get scale(): Vector3
获取模型缩放。

Returns Vector3

Inherited from Overlay.scale
set scale(value: Vector3): void
设置模型缩放。
Parameters
- value: Vector3
Returns void

Inherited from Overlay.scale

style

get style(): string
获取样式。

Returns string
set style(value: string): void
设置样式。
Parameters
- value: string
Returns void

transform

get transform(): Matrix
获取当前模型的变换矩阵。

Returns Matrix

Inherited from Overlay.transform

translation

get translation(): Vector3
获取模型平移。

Returns Vector3

Inherited from Overlay.translation
set translation(value: Vector3): void
设置模型平移。
Parameters
- value: Vector3
Returns void

Inherited from Overlay.translation

visible

get visible(): boolean
获取模型可见性。

Returns boolean

Inherited from Overlay.visible
set visible(val: boolean): void
设置模型可见性。
Parameters
- val: boolean
Returns void

Inherited from Overlay.visible

Methods

addEventListener

addEventListener<K>(type: K, listener: ((this: Model, ev: ModelEventMap[K]) => any), options?: boolean | AddEventListenerOptions): void
Type Parameters
- K extends keyof ModelEventMap
Parameters
- type: K
- listener: ((this: Model, ev: ModelEventMap[K]) => any)
  - - (this: Model, ev: ModelEventMap[K]): any
    - Parameters
      
      this: Model
      
      ev: ModelEventMap[K]
      
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void

Inherited from Overlay.addEventListener
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void

Inherited from Overlay.addEventListener

animate

animate(keyframes: null | Iterable<PropertiesNullable<DivaKeyFrameOptions & AnimatableProperties>>, options?: DivaKeyframeEffectOptions): DivaAnimation
Parameters
- keyframes: null | Iterable<PropertiesNullable<DivaKeyFrameOptions & AnimatableProperties>>
- Optional options: DivaKeyframeEffectOptions
Returns DivaAnimation

Inherited from Overlay.animate
animate(keyframes: null | Iterable<PropertiesNullable<DivaKeyFrameOptions & AnimatableProperties>>, duration?: number): DivaAnimation
Parameters
- keyframes: null | Iterable<PropertiesNullable<DivaKeyFrameOptions & AnimatableProperties>>
- Optional duration: number
Returns DivaAnimation

Inherited from Overlay.animate

dispatchEvent

dispatchEvent(event: Event): boolean
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
Parameters
- event: Event
Returns boolean

Inherited from Overlay.dispatchEvent

focus

focus(distance: number, pitch: number): Promise<void>
聚焦至当前模型。
Parameters
- distance: number
  
  与聚焦模型的距离，单位 cm
- pitch: number
  
  纵倾（俯仰）弧度角度，正值向上
Returns Promise<void>

Inherited from Overlay.focus

getAnimations

getAnimations(): DivaAnimation[]
Returns DivaAnimation[]

Inherited from Overlay.getAnimations

getBoundingInfo

getBoundingInfo(): Promise<BoundingInfo>
获取模型的边界包围信息。

Returns Promise<BoundingInfo>

Inherited from Overlay.getBoundingInfo

getCoordinate

getCoordinate(): Promise<Vector3>
获取模型坐标。

Deprecated
请使用 getPosition 方法替代

Returns Promise<Vector3>

Inherited from Overlay.getCoordinate

getPosition

getPosition(): Promise<Vector3>
获取模型坐标。

Returns Promise<Vector3>

Inherited from Overlay.getPosition

getRotation

getRotation(): Promise<Quaternion>
获取模型旋转。

Returns Promise<Quaternion>

Inherited from Overlay.getRotation

getScale

getScale(): Promise<Vector3>
获取模型缩放。

Returns Promise<Vector3>

Inherited from Overlay.getScale

removeEventListener

removeEventListener<K>(type: K, listener: ((this: Model, ev: ModelEventMap[K]) => any), options?: boolean | EventListenerOptions): void
Type Parameters
- K extends keyof ModelEventMap
Parameters
- type: K
- listener: ((this: Model, ev: ModelEventMap[K]) => any)
  - - (this: Model, ev: ModelEventMap[K]): any
    - Parameters
      
      this: Model
      
      ev: ModelEventMap[K]
      
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void

Inherited from Overlay.removeEventListener
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void

Inherited from Overlay.removeEventListener

rotate

rotate(delta: Quaternion): Promise<Quaternion>
将模型在当前旋转的基础之上做增量旋转。

Returns
变换后的缩放四元数
Parameters
- delta: Quaternion
  
  旋转增量四元数
Returns Promise<Quaternion>

Inherited from Overlay.rotate

scaling

scaling(delta: Vector3): Promise<Vector3>
将模型在当前缩放的基础之上做增量缩放。

Returns
变换后的缩放向量
Parameters
- delta: Vector3
  
  缩放增量向量
Returns Promise<Vector3>

Inherited from Overlay.scaling

setCimCoordinate

setCimCoordinate(coordinate: CimCoordinates): Promise<void>

设置模型经纬度坐标，仅 CIM 模式下支持。

Deprecated

请使用 coordinate 属性代替

model.setCimCoordinate(new CimCoordinates({ ... }));
// 请使用下面的方式替代
model.coordinate = [116.0, 39.0, 10.0]; // [经度 (角度值), 纬度 (角度值), 高度 (单位 m)]
model.update();

Parameters

coordinate: CimCoordinates

经纬度坐标

Returns Promise<void>

setCimCoordinates

setCimCoordinates(coordinates: CimCoordinates[]): Promise<void>

设置各经纬度坐标，仅 CIM 模式下支持。

Deprecated

请使用 coordinates 属性代替

Polygon.setCimCoordinates({ ... });
// 请使用下面的方式替代
Polygon.coordinates = [[116.0, 39.0, 10.0], ...]; // 分别指定各经纬度点 [经度 (角度值), 纬度 (角度值), 高度 (单位 m)]
Polygon.update();

Parameters

coordinates: CimCoordinates[]

各经纬度坐标

Returns Promise<void>

setClickable

setClickable(clickable: boolean): Promise<void>
设置模型可点击性。
Parameters
- clickable: boolean
  
  可点击性
Returns Promise<void>

Inherited from Overlay.setClickable

setClient

setClient(client: null | JsonRpcClient): Promise<void>
为实体指定关联的客户端

Throws
ClientAlreadySetError 该错误将会在重复设置客户端时抛出
Parameters
- client: null | JsonRpcClient
  
  Diva 客户端
Returns Promise<void>

Inherited from Overlay.setClient

setCoordinate

setCoordinate(coord: Vector3Tuple, transition?: Transition): Promise<void>
设置模型位置坐标，可以通过变换设置动画。

Deprecated
请使用 setPosition 代替
Parameters
- coord: Vector3Tuple
  
  坐标元组
- Optional transition: Transition
  
  模型坐标变换设置
Returns Promise<void>

Inherited from Overlay.setCoordinate
setCoordinate(coord: Vector3, transition?: Transition): Promise<void>
设置模型位置坐标，可以通过变换设置动画。

Deprecated
请使用 setPosition 代替
Parameters
- coord: Vector3
  
  坐标向量
- Optional transition: Transition
  
  模型坐标变换设置
Returns Promise<void>

Inherited from Overlay.setCoordinate

setPosition

setPosition(position: Vector3, transition?: Transition): Promise<void>
设置模型位置坐标，可以通过变换设置动画。
Parameters
- position: Vector3
  
  坐标向量
- Optional transition: Transition
  
  模型坐标变换设置
Returns Promise<void>

Inherited from Overlay.setPosition

setRenderMode

setRenderMode(mode: Emission | Emission, opt: { color: string; speed?: number; strength?: number }): Promise<void>
设置当前模型渲染风格为自发光模式。
Parameters
- mode: Emission | Emission
  
  自发光渲染模式
- opt: { color: string; speed?: number; strength?: number }
  
  自发光参数选项
  - color: string
    
    自发光颜色, HEX 色值，支持 alpha 通道。
  - Optional speed?: number
    
    闪烁速度，取值范围 0~20
  - Optional strength?: number
    
    自发光强度,取值范围 0~50，建议不超过 0.5，否则容易过亮。
Returns Promise<void>

Inherited from Overlay.setRenderMode
setRenderMode(mode: Default | Alarm | Translucence | Highlight | Default | Alarm | Translucence | Highlight): Promise<void>
设置当前模型渲染风格模式。
Parameters
- mode: Default | Alarm | Translucence | Highlight | Default | Alarm | Translucence | Highlight
  
  渲染风格模式
Returns Promise<void>

Inherited from Overlay.setRenderMode

setRenderingStyleMode

setRenderingStyleMode(mode: Emission | Emission, opt: { color: string; speed?: number; strength?: number }): Promise<void>
设置当前模型渲染风格为自发光模式。

Deprecated
请使用 setRenderMode 代替
Parameters
- mode: Emission | Emission
  
  自发光渲染模式
- opt: { color: string; speed?: number; strength?: number }
  
  自发光参数选项
  - color: string
    
    自发光颜色, HEX 色值，支持 alpha 通道。
  - Optional speed?: number
    
    闪烁速度，取值范围 0~20
  - Optional strength?: number
    
    自发光强度,取值范围 0~50，建议不超过 0.5，否则容易过亮。
Returns Promise<void>

Inherited from Overlay.setRenderingStyleMode
setRenderingStyleMode(mode: Default | Alarm | Translucence | Highlight | Default | Alarm | Translucence | Highlight): Promise<void>
设置当前模型渲染风格模式。

Deprecated
请使用 setRenderMode 代替
Parameters
- mode: Default | Alarm | Translucence | Highlight | Default | Alarm | Translucence | Highlight
  
  渲染风格模式
Returns Promise<void>

Inherited from Overlay.setRenderingStyleMode

setRotation

setRotation(rotation: Quaternion): Promise<void>
设置模型变换的旋转。旋转中心为模型原点。
Parameters
- rotation: Quaternion
  
  表示旋转的四元数
Returns Promise<void>

Inherited from Overlay.setRotation
setRotation(rotation: Vector3): Promise<void>
设置模型变换的旋转。旋转中心为模型原点。
Parameters
- rotation: Vector3
  
  表示旋转的三维向量，提供分别绕各个坐标轴旋转的角度值
Returns Promise<void>

Inherited from Overlay.setRotation

setScale

setScale(scale: Vector3): Promise<void>
设置模型变换的缩放。
Parameters
- scale: Vector3
  
  表示缩放的向量
Returns Promise<void>

Inherited from Overlay.setScale

setTranslation

setTranslation(translation: Vector3): Promise<void>
设置模型平移位置。
Parameters
- translation: Vector3
  
  平移向量
Returns Promise<void>

Inherited from Overlay.setTranslation

setVisibility

setVisibility(visible: boolean): Promise<void>
设置模型可见性。

Deprecated
请用 setVisible 代替
Parameters
- visible: boolean
  
  可见性
Returns Promise<void>

Inherited from Overlay.setVisibility

setVisible

setVisible(visible: boolean): Promise<void>
设置模型可见性。
Parameters
- visible: boolean
  
  可见性
Returns Promise<void>

Inherited from Overlay.setVisible

setWebWidget

setWebWidget(uri: null): Promise<void>
传入 null，将绑定的 Web 组件置空。
Parameters
- uri: null
  
  空值
Returns Promise<void>

Inherited from Overlay.setWebWidget
setWebWidget(uri: URL, options: WebWidgetOptions): Promise<void>
设置 Web 组件。
Parameters
- uri: URL
  
  加载的地址，支持 http(s): , rtmp: 与 rtsp: 协议。
- options: WebWidgetOptions
  
  web 组件选项
Returns Promise<void>

Inherited from Overlay.setWebWidget

stopTransition

stopTransition(): Promise<void>
Returns Promise<void>

Inherited from Overlay.stopTransition

transition

transition(options: TransitionOptions): Promise<void>
Parameters
- options: TransitionOptions
Returns Promise<void>

Inherited from Overlay.transition

translate

translate(delta: Vector3): Promise<Vector3>
将模型在当前平移的基础之上做增量平移。

Returns
变换后的平移向量
Parameters
- delta: Vector3
  
  平移增量向量
Returns Promise<Vector3>

Inherited from Overlay.translate

update

update(mode: "pull"): Promise<RpcParams>
Parameters
- mode: "pull"
Returns Promise<RpcParams>

Overrides Overlay.update
update(mode: "push"): Promise<void>
Parameters
- mode: "push"
Returns Promise<void>

Overrides Overlay.update
update(): Promise<void>
Returns Promise<void>

Overrides Overlay.update

Class Polygon

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

config: PolygonConfig

Returns Polygon

Properties

onclick

ondblclick

onmousedown

onmouseup

Accessors

boundingInfo

Returns BoundingInfo

clickable

Returns boolean

Parameters

value: boolean

Returns void

client

Returns JsonRpcClient

coord

Deprecated

Returns Vector3

Deprecated

Parameters

vector: Vector3

Returns void

coordinate

Returns null | CimCoordinates | CoordinateTuple

Parameters

value: null | CimCoordinates | CoordinateTuple

Returns void

coordinates

Returns undefined | CoordinateTuple[] | CimCoordinates[]

Parameters

value: undefined | CoordinateTuple[] | CimCoordinates[]

Returns void

definition

Returns undefined | MaterialDefinition[]

Parameters

value: undefined | MaterialDefinition[]

Returns void

group

Returns string

Parameters

value: string

Returns void

height

Returns undefined | number

Parameters

value: undefined | number

Returns void

id

Returns string

material

Returns undefined | Material

Parameters

value: undefined | Material

Returns void

name

Returns null | string

Parameters

value: null | string

Returns void

position

Returns Vector3

Parameters

value: Vector3

Returns void

positions

Returns Vector3[]

Parameters

value: Vector3[]

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: boolean | AddEventListenerOptions

`Optional` options: DivaKeyframeEffectOptions

`Optional` duration: number