Class BaseViewer

Threejs scene initialize base class

Hierarchy (View Summary)

EventDispatcher<ViewerEventMap>
- BaseViewer

Index

Constructors

Properties

ambLight camera clock container? dirLight renderer scene topScenes

Accessors

Methods

addEventListener addTo animate createAmbLight createCamera createDirLight createRenderer createScene dispatchEvent hasEventListener removeEventListener resize update

Constructors

constructor

new BaseViewer(
container?: string | HTMLElement,
options?: ViewerOptions,
): BaseViewer
Constructor
Parameters
- Optionalcontainer: string | HTMLElement
  container element or selector string
- options: ViewerOptions = {}
  GLViewer options
Returns BaseViewer
Overrides EventDispatcher<ViewerEventMap>.constructor
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:75

Properties

`Readonly`ambLight

ambLight: AmbientLight

`Readonly`camera

camera: PerspectiveCamera

`Readonly`clock

clock: Clock = ...

`Optional`container

container?: HTMLElement

`Readonly`dirLight

dirLight: DirectionalLight

`Readonly`renderer

renderer: WebGLRenderer

`Readonly`scene

scene: Scene

`Readonly`topScenes

topScenes: Scene[] = []

Accessors

height

get height(): number
Container height

Returns number
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:66

width

get width(): number
Container width

Returns number
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:61

Methods

addEventListener

addEventListener<T extends keyof ViewerEventMap>(
type: T,
listener: EventListener<ViewerEventMap[T], T, BaseViewer>,
): void
Adds a listener to an event type.
Type Parameters
- T extends keyof ViewerEventMap
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<ViewerEventMap[T], T, BaseViewer>
  The function that gets called when the event is fired.
Returns void
Inherited from EventDispatcher.addEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:52

addTo

addTo(container: string | HTMLElement): BaseViewer
Add the renderer to a container
Parameters
- container: string | HTMLElement
  container element or selector string
Returns BaseViewer
this
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:98

animate

animate(): void
Threejs animation loop

Returns void
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:202

`Protected`createAmbLight

createAmbLight(): AmbientLight
Create ambient light

Returns AmbientLight
AmbientLight
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:157

`Protected`createCamera

createCamera(): PerspectiveCamera
Create camera

Returns PerspectiveCamera
camera
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:147

`Protected`createDirLight

createDirLight(): DirectionalLight
Create directional light

Returns DirectionalLight
DirectionalLight
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:166

`Protected`createRenderer

createRenderer(
    antialias: boolean,
    stencil: boolean,
    logarithmicDepthBuffer: boolean,
): WebGLRenderer
Create WebGL renderer
Parameters
- antialias: boolean
- stencil: boolean
- logarithmicDepthBuffer: boolean
Returns WebGLRenderer
renderer
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:129

`Protected`createScene

createScene(): Scene
Create scene

Returns Scene
scene
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:114

dispatchEvent

dispatchEvent<T extends keyof ViewerEventMap>(
event: BaseEvent<T> & ViewerEventMap[T],
): void
Fire an event type.
Type Parameters
- T extends keyof ViewerEventMap
Parameters
- event: BaseEvent<T> & ViewerEventMap[T]
  The event that gets fired.
Returns void
Inherited from EventDispatcher.dispatchEvent
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:81

hasEventListener

hasEventListener<T extends keyof ViewerEventMap>(
type: T,
listener: EventListener<ViewerEventMap[T], T, BaseViewer>,
): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends keyof ViewerEventMap
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<ViewerEventMap[T], T, BaseViewer>
  The function that gets called when the event is fired.
Returns boolean
Inherited from EventDispatcher.hasEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:62

removeEventListener

removeEventListener<T extends keyof ViewerEventMap>(
type: T,
listener: EventListener<ViewerEventMap[T], T, BaseViewer>,
): void
Removes a listener from an event type.
Type Parameters
- T extends keyof ViewerEventMap
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<ViewerEventMap[T], T, BaseViewer>
  The listener function that gets removed.
Returns void
Inherited from EventDispatcher.removeEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:72

resize

resize(): BaseViewer
Container resize

Returns BaseViewer
this
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:177

`Protected`update

update(): void
Returns void
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:189