Class Float

A class that can make objects float.

Hierarchy (view full)

Component
- Float

Index

Constructors

Properties

base container emitter floatIntensity floatingRange group offset rotationIntensity speed

Methods

add addExisting emit off on update

Constructors

constructor

new Float(base, config?): Float
Parameters
- base: Base
- config: Partial<FloatConfig> = {}
Returns Float
Overrides Component.constructor
- Defined in src/components/float.ts:23

Properties

base

base: Base

container

container: Scene

emitter

emitter: Emitter<any>

floatIntensity

floatIntensity: number

floatingRange

floatingRange: [number?, number?]

group

group: Group<Object3DEventMap>

offset

offset: number

rotationIntensity

rotationIntensity: number

speed

speed: number

Methods

add

add(...object): void
Parameters
- Rest...object: Object3D<Object3DEventMap>[]
Returns void
- Defined in src/components/float.ts:45

addExisting

addExisting(): void
Returns void
Overrides Component.addExisting
- Defined in src/components/float.ts:42

emit

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

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

update

update(time): void
Parameters
- time: number
Returns void
Overrides Component.update
- Defined in src/components/float.ts:48