Class PLViewer

Threejs scene initialize class with PointerLockControls.

Hierarchy (View Summary)

BaseViewer
- PLViewer

Index

Constructors

Properties

ambLight camera cameraHeight clock container? controls dirLight renderer scene topScenes

Accessors

autoForward height width

Methods

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

Constructors

constructor

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

Properties

`Readonly`ambLight

ambLight: AmbientLight

`Readonly`camera

camera: PerspectiveCamera

cameraHeight

cameraHeight: number = 8000

`Readonly`clock

clock: Clock = ...

`Optional`container

container?: HTMLElement

controls

controls: PointerLockControls

`Readonly`dirLight

dirLight: DirectionalLight

`Readonly`renderer

renderer: WebGLRenderer

`Readonly`scene

scene: Scene

`Readonly`topScenes

topScenes: Scene[] = []

Accessors

autoForward

get autoForward(): boolean
Returns boolean
- Defined in packages/plugin/src/GLViewer/PLViewer.ts:28
set autoForward(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/plugin/src/GLViewer/PLViewer.ts:31

height

get height(): number
Container height

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

width

get width(): number
Container width

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

Methods

addEventListener

addEventListener<T extends keyof ViewerEventMap>(
type: T,
listener: EventListener<ViewerEventMap[T], T, PLViewer>,
): 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, PLViewer>
  The function that gets called when the event is fired.
Returns void
Inherited from BaseViewer.addEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:52

addTo

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

animate

animate(): void
Threejs animation loop

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

`Protected`createAmbLight

createAmbLight(): AmbientLight
Create ambient light

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

`Protected`createCamera

createCamera(): PerspectiveCamera
Create camera

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

`Protected`createDirLight

createDirLight(): DirectionalLight
Create directional light

Returns DirectionalLight
DirectionalLight
Inherited from BaseViewer.createDirLight
- 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
Inherited from BaseViewer.createRenderer
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:129

`Protected`createScene

createScene(): Scene
Create scene

Returns Scene
scene
Inherited from BaseViewer.createScene
- 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 BaseViewer.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, PLViewer>,
): 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, PLViewer>
  The function that gets called when the event is fired.
Returns boolean
Inherited from BaseViewer.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, PLViewer>,
): 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, PLViewer>
  The listener function that gets removed.
Returns void
Inherited from BaseViewer.removeEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:72

resize

resize(): PLViewer
Container resize

Returns PLViewer
this
Inherited from BaseViewer.resize
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:177

update

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