Class FLViewer

Threejs scene initialize class with FlyControls

Hierarchy (View Summary)

BaseViewer
- FLViewer

Index

Constructors

constructor

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

Properties

`Readonly`ambLight

ambLight: AmbientLight

`Readonly`camera

camera: PerspectiveCamera

`Readonly`clock

clock: Clock = ...

`Optional`container

container?: HTMLElement

controls

controls: FlyControls

`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/FLViewer.ts:16
set autoForward(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/plugin/src/GLViewer/FLViewer.ts:19

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, FLViewer>,
): 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, FLViewer>
  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): FLViewer
Add the renderer to a container
Parameters
- container: string | HTMLElement
  container element or selector string
Returns FLViewer
this
Inherited from BaseViewer.addTo
- Defined in packages/plugin/src/GLViewer/BaseViewer.ts:98

animate

animate(): void
Threejs animation loop

Returns void
Overrides BaseViewer.animate
- Defined in packages/plugin/src/GLViewer/FLViewer.ts:48

`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, FLViewer>,
): 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, FLViewer>
  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, FLViewer>,
): 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, FLViewer>
  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(): FLViewer
Container resize

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

`Protected`update

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

Class FLViewer

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns FLViewer

Properties

ReadonlyambLight

Readonlycamera

Readonlyclock

Optionalcontainer

controls

ReadonlydirLight

Readonlyrenderer

Readonlyscene

ReadonlytopScenes

Accessors

autoForward

Returns boolean

Parameters

Returns void

height

Returns number

width

Returns number

Methods

addEventListener

Type Parameters

Parameters

Returns void

addTo

Parameters

Returns FLViewer

animate

Returns void

ProtectedcreateAmbLight

Returns AmbientLight

ProtectedcreateCamera

Returns PerspectiveCamera

ProtectedcreateDirLight

Returns DirectionalLight

ProtectedcreateRenderer

Parameters

Returns WebGLRenderer

ProtectedcreateScene

Returns Scene

dispatchEvent

Type Parameters

Parameters

Returns void

hasEventListener

Type Parameters

Parameters

Returns boolean

removeEventListener

Type Parameters

Parameters

Returns void

resize

Returns FLViewer

Protectedupdate

Returns void

Settings

On This Page

`Readonly`ambLight

`Readonly`camera

`Readonly`clock

`Optional`container

`Readonly`dirLight

`Readonly`renderer

`Readonly`scene

`Readonly`topScenes

`Protected`createAmbLight

`Protected`createCamera

`Protected`createDirLight

`Protected`createRenderer

`Protected`createScene

`Protected`update