Class Base

By extending this class, you can kickstart a basic three.js scene easily.

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

Index

Constructors

Properties

animator camera clock composer container iMouse interactionManager keyboard physics renderer resizer scene

Methods

addEventListeners destroy init render saveScreenshot update

Constructors

constructor

new Base(sel?: string, config?: Partial<BaseConfig>): Base
Parameters
- sel: string = "#sketch"
- config: Partial<BaseConfig> = {}
Returns Base
- Defined in src/base/base.ts:39

Properties

animator

animator: Animator

camera

camera: OrthographicCamera | PerspectiveCamera

clock

clock: Clock

composer

composer: EffectComposer<WebGLRenderTarget<Texture<unknown>>> | null

container

container: HTMLElement

iMouse

iMouse: IMouse

interactionManager

interactionManager: InteractionManager

keyboard

keyboard: Keyboard

physics

physics: Physics

renderer

renderer: WebGLRenderer

resizer

resizer: Resizer

scene

scene: Scene

Methods

addEventListeners

addEventListeners(): void
Returns void
- Defined in src/base/base.ts:114

destroy

destroy(): void
Returns void
- Defined in src/base/base.ts:150

init

init(): void
Returns void
- Defined in src/base/base.ts:127

render

render(): void
Returns void
- Defined in src/base/base.ts:134

saveScreenshot

saveScreenshot(name?: string): Promise<void>
Parameters
- name: string = ...
Returns Promise<void>
- Defined in src/base/base.ts:141

update

update(fn: any): void
Parameters
- fn: any
Returns void
- Defined in src/base/base.ts:124