Class Vim

Container for the built three meshes and the vim data from which it was built. Dispenses Objects for high level scene manipulation

Hierarchy

Vim

Index

Constructors

Properties

document g3d header scene source transform

Methods

dispose getAllElements getAllObjects getElementFromInstance getElementId getInstancesFromElement getMatrix getObjectFromElement getObjectsFromElementId getObjectsInBox getVimObjectFromInstance hasElement

Constructors

constructor

new Vim(header: VimHeader, document: VimDocument, g3d: G3d, scene: Scene, transform: Matrix4, map: ElementNoMapping | ElementMapping): Vim
Parameters
- header: VimHeader
- document: VimDocument
- g3d: G3d
- scene: Scene
- transform: Matrix4
- map: ElementNoMapping | ElementMapping
Returns Vim
- Defined in src/vim-loader/vim.ts:27

Properties

`Readonly` document

document: VimDocument

`Readonly` g3d

g3d: G3d

header

header: VimHeader

scene

scene: Scene

source

source: string

`Readonly` transform

transform: Matrix4

Methods

dispose

dispose(): void
Returns void
- Defined in src/vim-loader/vim.ts:44

getAllElements

getAllElements(): any[] | IterableIterator<number>
Returns all element indices of the vim

Returns any[] | IterableIterator<number>
- Defined in src/vim-loader/vim.ts:122

getAllObjects

getAllObjects(): Generator<VimObject, void, unknown>
Enumerates all objects of the vim

Returns Generator<VimObject, void, unknown>
- Defined in src/vim-loader/vim.ts:99

getElementFromInstance

getElementFromInstance(instance: number): any
Returns the element index associated with the g3d instance index.

Returns
element index or undefined if not found
Parameters
- instance: number
  
  g3d instance index
Returns any
- Defined in src/vim-loader/vim.ts:139

getElementId

getElementId(element: number): any
Returns element id from element index
Parameters
- element: number
  
  element index
Returns any
- Defined in src/vim-loader/vim.ts:147

getInstancesFromElement

getInstancesFromElement(element: number): number[]
Returns instance indices associated with vim element index
Parameters
- element: number
  
  vim element index
Returns number[]
- Defined in src/vim-loader/vim.ts:130

getMatrix

getMatrix(): Matrix4
Returns Matrix4
- Defined in src/vim-loader/vim.ts:48

getObjectFromElement

getObjectFromElement(element: number): VimObject
Parameters
- element: number
Returns VimObject
- Defined in src/vim-loader/vim.ts:65

getObjectsFromElementId

getObjectsFromElementId(id: number): any
Parameters
- id: number
Returns any
- Defined in src/vim-loader/vim.ts:58

getObjectsInBox

getObjectsInBox(box: Box3): VimObject[]
Returns an array with all vim objects strictly contained in given box.
Parameters
- box: Box3
Returns VimObject[]
- Defined in src/vim-loader/vim.ts:83

getVimObjectFromInstance

getVimObjectFromInstance(instance: number): VimObject
Parameters
- instance: number
Returns VimObject
- Defined in src/vim-loader/vim.ts:52

hasElement

hasElement(element: number): boolean
Returns true if element exists in the vim.
Parameters
- element: number
Returns boolean
- Defined in src/vim-loader/vim.ts:115

Generated using TypeDoc