Class BasicPanorama

By extending this class, you can make your components keep their own state and animation.

Demo: https://kokomi-js.vercel.app/examples/#component

Hierarchy (view full)

Component
- BasicPanorama
  - ImagePanorama

Index

Constructors

Properties

active base container emitter id infospots isInfospotVisible material mesh

Methods

add addExisting addGroup emit fadeIn fadeOut hide off on onEnter onLeave outputPosition show toggleInfospotVisibility update

Constructors

constructor

new BasicPanorama(base, config?): BasicPanorama
Parameters
- base: Base
- config: Partial<BasicPanoramaConfig> = {}
Returns BasicPanorama
Overrides Component.constructor
- Defined in src/panorama/basicPanorama.ts:22

Properties

active

active: boolean

base

base: Base

container

container: Scene

emitter

emitter: Emitter<any>

id

id: string

infospots

infospots: Html[]

isInfospotVisible

isInfospotVisible: boolean

material

material: MeshBasicMaterial

mesh

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

Methods

add

add(infospot): void
Parameters
- infospot: Html
Returns void
- Defined in src/panorama/basicPanorama.ts:104

addExisting

addExisting(): void
Returns void
Overrides Component.addExisting
- Defined in src/panorama/basicPanorama.ts:43

addGroup

addGroup(infospots): void
Parameters
- infospots: Html[]
Returns void
- Defined in src/panorama/basicPanorama.ts:107

emit

emit(type, event?): void
Parameters
- type: string
- event: any = {}
Returns void
Inherited from Component.emit
- Defined in src/components/component.ts:41

fadeIn

fadeIn(duration?): Promise<unknown>
Parameters
- duration: number = 0.5
Returns Promise<unknown>
- Defined in src/panorama/basicPanorama.ts:70

fadeOut

fadeOut(duration?): Promise<unknown>
Parameters
- duration: number = 0.5
Returns Promise<unknown>
- Defined in src/panorama/basicPanorama.ts:87

hide

hide(): void
Returns void
- Defined in src/panorama/basicPanorama.ts:67

off

off(type, handler): void
Parameters
- type: string
- handler: any
Returns void
Inherited from Component.off
- Defined in src/components/component.ts:37

on

on(type, handler): void
Parameters
- type: string
- handler: any
Returns void
Inherited from Component.on
- Defined in src/components/component.ts:33

onEnter

onEnter(duration?): void
Parameters
- duration: number = 0.5
Returns void
- Defined in src/panorama/basicPanorama.ts:133

onLeave

onLeave(duration?): void
Parameters
- duration: number = 0.5
Returns void
- Defined in src/panorama/basicPanorama.ts:138

outputPosition

outputPosition(): void
Returns void
- Defined in src/panorama/basicPanorama.ts:46

show

show(): void
Returns void
- Defined in src/panorama/basicPanorama.ts:64

toggleInfospotVisibility

toggleInfospotVisibility(isVisible?): void
Parameters
- isVisible: undefined | boolean = undefined
Returns void
- Defined in src/panorama/basicPanorama.ts:125

update

update(time): void
Parameters
- time: number
Returns void
Overrides Component.update
- Defined in src/panorama/basicPanorama.ts:112