GLTFViewer | @juyipeng/gltf-viewer

Hierarchy

Subscribe<GLTFViewerEventMap>
- GLTFViewer

Index

Constructors

constructor

Properties

uuid

Accessors

Methods

Constructors

constructor

new GLTFViewer(config: GLTFViewerConfig): GLTFViewer

Overrides Subscribe<GLTFViewerEventMap>.constructor
- Defined in resources/gltf-viewer/index.ts:553
Parameters
- config: GLTFViewerConfig
Returns GLTFViewer

Properties

uuid

uuid: string = ...

Accessors

maxFov

get maxFov(): number
set maxFov(fov: number): void

- Defined in resources/gltf-viewer/index.ts:634
Returns number
- Defined in resources/gltf-viewer/index.ts:627
Parameters
- fov: number
Returns void

minFov

get minFov(): number
set minFov(fov: number): void

- Defined in resources/gltf-viewer/index.ts:621
Returns number
- Defined in resources/gltf-viewer/index.ts:614
Parameters
- fov: number
Returns void

state

get state(): { fov?: number; latitude?: number; longitude?: number }
set state(__namedParameters: { fov?: number; latitude?: number; longitude?: number }): void

- Defined in resources/gltf-viewer/index.ts:569
Returns { fov?: number; latitude?: number; longitude?: number }
- Optional fov?: number
- Optional latitude?: number
- Optional longitude?: number
- Defined in resources/gltf-viewer/index.ts:603
Parameters
- __namedParameters: { fov?: number; latitude?: number; longitude?: number }
  - Optional fov?: number
  - Optional latitude?: number
  - Optional longitude?: number
Returns void

Methods

appendTo

appendTo(container: HTMLDivElement, size?: GLTFViewerSize): void

- Defined in resources/gltf-viewer/index.ts:657
挂载

Parameters
- container: HTMLDivElement
- Optional size: GLTFViewerSize
Returns void

dispose

dispose(): void

- Defined in resources/gltf-viewer/index.ts:677
销毁

Returns void

emit

emit<K>(name: K, ...data: Parameters<GLTFViewerEventMap[K]>): boolean

Inherited from Subscribe.emit
- Defined in resources/gltf-viewer/Subscribe.ts:127
触发事件

Type parameters
- K: keyof GLTFViewerEventMap
  
  预设的监听事件名称
Parameters
- name: K
  
  事件类型
- Rest ...data: Parameters<GLTFViewerEventMap[K]>
  
  触发事件的数据
Returns boolean
canceled 是否被触发取消

fitFov

fitFov(): void

- Defined in resources/gltf-viewer/index.ts:687
响应式fov

Returns void

hasListener

hasListener(name: keyof GLTFViewerEventMap): boolean

Inherited from Subscribe.hasListener
- Defined in resources/gltf-viewer/Subscribe.ts:48
判断是否注册了事件

Parameters
- name: keyof GLTFViewerEventMap
  
  事件类型
Returns boolean

load

load(url: string): void

- Defined in resources/gltf-viewer/index.ts:645
Parameters
- url: string
  
  glTF 模型CDN地址
Returns void

off

off<K>(name?: K, callback?: (...args: Parameters<GLTFViewerEventMap[K]>) => ReturnType<GLTFViewerEventMap[K]>): void

Inherited from Subscribe.off
- Defined in resources/gltf-viewer/Subscribe.ts:97
解除事件

如果 name 不传的话解除对应所有事件如果 name, callback 不传的话解除所有name的所有事件

Type parameters
- K: keyof GLTFViewerEventMap
  
  预设的监听事件名称
Parameters
- Optional name: K
  
  事件类型
- Optional callback: (...args: Parameters<GLTFViewerEventMap[K]>) => ReturnType<GLTFViewerEventMap[K]>
  
  事件回调函数
  - - (...args: Parameters<GLTFViewerEventMap[K]>): ReturnType<GLTFViewerEventMap[K]>
    - Parameters
      - Rest ...args: Parameters<GLTFViewerEventMap[K]>
      Returns ReturnType<GLTFViewerEventMap[K]>
Returns void

on

on<K>(name: K, callback: (...args: Parameters<GLTFViewerEventMap[K]>) => ReturnType<GLTFViewerEventMap[K]>, once?: boolean): () => void

Inherited from Subscribe.on
- Defined in resources/gltf-viewer/Subscribe.ts:62
注册事件

Type parameters
- K: keyof GLTFViewerEventMap
  
  预设的监听事件名称
Parameters
- name: K
  
  事件类型
- callback: (...args: Parameters<GLTFViewerEventMap[K]>) => ReturnType<GLTFViewerEventMap[K]>
  
  事件回调函数
  - - (...args: Parameters<GLTFViewerEventMap[K]>): ReturnType<GLTFViewerEventMap[K]>
    - Parameters
      - Rest ...args: Parameters<GLTFViewerEventMap[K]>
      Returns ReturnType<GLTFViewerEventMap[K]>
- Optional once: boolean
  
  是否只执行一次
Returns () => void
解除事件
- - (): void
  - 注册事件
    
    Returns void
    解除事件

once

once<K>(name: K, callback: (...args: Parameters<GLTFViewerEventMap[K]>) => ReturnType<GLTFViewerEventMap[K]>): () => void

Inherited from Subscribe.once
- Defined in resources/gltf-viewer/Subscribe.ts:81
注册事件(是否只执行一次)

Type parameters
- K: keyof GLTFViewerEventMap
  
  预设的监听事件名称
Parameters
- name: K
  
  事件类型
- callback: (...args: Parameters<GLTFViewerEventMap[K]>) => ReturnType<GLTFViewerEventMap[K]>
  
  事件回调函数
  - - (...args: Parameters<GLTFViewerEventMap[K]>): ReturnType<GLTFViewerEventMap[K]>
    - Parameters
      - Rest ...args: Parameters<GLTFViewerEventMap[K]>
      Returns ReturnType<GLTFViewerEventMap[K]>
Returns () => void
解除事件
- - (): void
  - 注册事件(是否只执行一次)
    
    Returns void
    解除事件

refresh

refresh(size?: GLTFViewerSize): void

- Defined in resources/gltf-viewer/index.ts:668
刷新：如果传递宽高则以该宽高重新绘制；否则，以父容器的宽高重新绘制。

Parameters
- Optional size: GLTFViewerSize
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

config: GLTFViewerConfig

Returns GLTFViewer

Properties

uuid

Accessors

maxFov

Returns number

Parameters

fov: number

Returns void

minFov

Returns number

Parameters

fov: number

Returns void

state

Returns { fov?: number; latitude?: number; longitude?: number }

Optional fov?: number

Optional latitude?: number

Optional longitude?: number

Parameters

__namedParameters: { fov?: number; latitude?: number; longitude?: number }

Optional fov?: number

Optional latitude?: number

Optional longitude?: number

Returns void

Methods

appendTo

Parameters

container: HTMLDivElement

Optional size: GLTFViewerSize

Returns void

dispose

Returns void

emit

Type parameters

K: keyof GLTFViewerEventMap

Parameters

name: K

Rest ...data: Parameters<GLTFViewerEventMap[K]>

Returns boolean

fitFov

Returns void

hasListener

Parameters

name: keyof GLTFViewerEventMap

Returns boolean

load

Parameters

url: string

Returns void

off

Type parameters

K: keyof GLTFViewerEventMap

Parameters

Optional name: K

Optional callback: (...args: Parameters<GLTFViewerEventMap[K]>) => ReturnType<GLTFViewerEventMap[K]>

Parameters

Rest ...args: Parameters<GLTFViewerEventMap[K]>

Returns ReturnType<GLTFViewerEventMap[K]>

Returns void

on

Type parameters

K: keyof GLTFViewerEventMap

Parameters

name: K

callback: (...args: Parameters<GLTFViewerEventMap[K]>) => ReturnType<GLTFViewerEventMap[K]>

Parameters

Rest ...args: Parameters<GLTFViewerEventMap[K]>

Returns ReturnType<GLTFViewerEventMap[K]>

Optional once: boolean