Class Viewer

Viewer and loader for vim files.

Hierarchy

Viewer

Index

Constructors

Properties

gizmoRectangle grid inputs measure raycaster renderer sectionBox selection settings viewport

Accessors

camera environment materials onVimLoaded

Methods

add addObject clear dispose remove

Constructors

constructor

new Viewer(options?: RecursivePartial<Settings>): Viewer
Parameters
- Optional options: RecursivePartial<Settings>
Returns Viewer
- Defined in src/viewer/viewer.ts:72

Properties

gizmoRectangle

gizmoRectangle: GizmoRectangle

grid

grid: GizmoGrid

inputs

inputs: Input

measure

measure: IMeasure

raycaster

raycaster: Raycaster

renderer

renderer: Renderer

sectionBox

sectionBox: SectionBox

selection

selection: Selection

settings

settings: Settings

viewport

viewport: Viewport

Accessors

camera

get camera(): Camera
Returns Camera
- Defined in src/viewer/viewer.ts:43

environment

get environment(): IEnvironment
Interface to manipulate THREE elements not directly related to vim.

Returns IEnvironment
- Defined in src/viewer/viewer.ts:50

materials

get materials(): Materials
Returns Materials
- Defined in src/viewer/viewer.ts:39

onVimLoaded

get onVimLoaded(): ISignal
Signal dispatched when a new vim is loaded or unloaded.

Returns ISignal
- Defined in src/viewer/viewer.ts:57

Methods

add

add(vim: Object3D<Event> | Vim, frameCamera?: boolean): void
Parameters
- vim: Object3D<Event> | Vim
- frameCamera: boolean = true
Returns void
- Defined in src/viewer/viewer.ts:138

addObject

addObject(object: Object3D<Event>): void
Parameters
- object: Object3D<Event>
Returns void
- Defined in src/viewer/viewer.ts:132

clear

clear(): void
Unloads all vim from viewer.

Returns void
- Defined in src/viewer/viewer.ts:188

dispose

dispose(): void
Disposes all resources.

Returns void
- Defined in src/viewer/viewer.ts:195

remove

remove(vim: Vim): void
Unload given vim from viewer.
Parameters
- vim: Vim
Returns void
- Defined in src/viewer/viewer.ts:171

Generated using TypeDoc