Class Vim

Represents a container for the built three.js meshes and the vim data from which they were constructed. Facilitates high-level scene manipulation by providing access to objects.

Hierarchy

Index

Constructors

constructor

new Vim(header: VimHeader, document: VimDocument, g3d: G3d, scene: Scene, settings: VimSettings, map: ElementMapping | ElementNoMapping | ElementMapping2, builder: SubsetBuilder, source: string, format: VimFormat, isLegacy: boolean): Vim
Constructs a new instance of a Vim object with the provided parameters.
Parameters
- header: VimHeader
  
  The Vim header, if available.
- document: VimDocument
  
  The Vim document.
- g3d: G3d
  
  The G3d object, if available.
- scene: Scene
  
  The scene containing the vim's geometry.
- settings: VimSettings
  
  The settings used to open this vim.
- map: ElementMapping | ElementNoMapping | ElementMapping2
  
  The element mapping.
- builder: SubsetBuilder
  
  The subset builder for constructing subsets of the Vim object.
- source: string
  
  The source of the Vim object.
- format: VimFormat
  
  The format of the Vim object.
- isLegacy: boolean
  
  Indicates whether the Vim object uses a legacy loading pipeline.
Returns Vim
- Defined in src/vim-loader/vim.ts:114

Properties

`Readonly` bim

bim: VimDocument

The interface to access bim data related to this vim if available.

`Readonly` format

format: VimFormat

Indicates whether the vim was opened from a vim or vimx file.

`Readonly` g3d

g3d: G3d

The raw g3d geometry scene definition.

`Readonly` header

header: VimHeader

The header for this vim.

`Readonly` isLegacy

isLegacy: boolean

Indicates whether the vim was opened using the legacy pipeline or not.

`Readonly` map

map: ElementMapping | ElementNoMapping | ElementMapping2

The mapping from Bim to Geometry for this vim.

`Readonly` scene

scene: Scene

Mostly Internal - The scene in which the vim geometry is added.

`Readonly` settings

settings: VimSettings

The settings used when this vim was opened.

`Readonly` source

source: string

Indicates the url this vim came from if applicable.

Accessors

isLoading

get isLoading(): boolean
Indicates whether there are subsets currently being loaded.

Returns
True if subsets are being loaded; otherwise, false.

Returns boolean
- Defined in src/vim-loader/vim.ts:88

onDispose

get onDispose(): ISignal
Getter for accessing the signal dispatched when the object is disposed.

Returns
The signal for disposal events.

Returns ISignal
- Defined in src/vim-loader/vim.ts:96

onLoadingUpdate

get onLoadingUpdate(): ISignal
Getter for accessing the event dispatched whenever a subset begins or finishes loading.

Returns
The event dispatcher for loading updates.

Returns ISignal
- Defined in src/vim-loader/vim.ts:80

Methods

clear

clear(): void
Removes the current geometry from the renderer.

Returns void
- Defined in src/vim-loader/vim.ts:320

dispose

dispose(): void
Cleans up and releases resources associated with the vim.

Returns void
- Defined in src/vim-loader/vim.ts:331

getFullSet

getFullSet(): G3dSubset
Retrieves all instances as a subset.

Returns
A subset containing all instances.

Returns G3dSubset
- Defined in src/vim-loader/vim.ts:246

getMatrix

getMatrix(): Matrix4
Retrieves the matrix representation of the Vim object's position, rotation, and scale.

Returns
The matrix representing the Vim object's transformation.

Returns Matrix4
- Defined in src/vim-loader/vim.ts:144

getObjectFromElement

getObjectFromElement(element: number): Object
Retrieves the Vim object associated with the given Vim element index.

Returns
The Vim object corresponding to the element index, or undefined if not found.
Parameters
- element: number
  
  The index of the Vim element.
Returns Object
- Defined in src/vim-loader/vim.ts:176

getObjectFromInstance

getObjectFromInstance(instance: number): Object
Retrieves the object associated with the specified instance number.

Returns
The object corresponding to the instance, or undefined if not found.
Parameters
- instance: number
  
  The instance number of the object.
Returns Object
- Defined in src/vim-loader/vim.ts:153

getObjects

getObjects(): Object[]
Retrieves an array of all objects within the Vim.

Returns
An array containing all objects within the Vim.

Returns Object[]
- Defined in src/vim-loader/vim.ts:213

getObjectsFromElementId

getObjectsFromElementId(id: number): any
Retrieves the objects associated with the specified element ID.

Returns
An array of objects corresponding to the element ID, or an empty array if none are found.
Parameters
- id: number
  
  The element ID to retrieve objects for.
Returns any
- Defined in src/vim-loader/vim.ts:164

getObjectsInBox

getObjectsInBox(box: Box3): Object[]
Retrieves an array containing all Vim objects strictly contained within the specified bounding box.

Returns
An array of Vim objects strictly contained within the bounding box.
Parameters
- box: Box3
  
  The bounding box to search within.
Returns Object[]
- Defined in src/vim-loader/vim.ts:196

getObjectsInSubset

getObjectsInSubset(subset: G3dSubset): Object[]
Retrieves an array containing all objects within the specified subset.

Returns
An array of objects within the specified subset.
Parameters
- subset: G3dSubset
  
  The subset to retrieve objects from.
Returns Object[]
- Defined in src/vim-loader/vim.ts:227

loadAll

loadAll(settings?: Partial<LoadSettings>): Promise<void>
Asynchronously loads all geometry according to the provided settings.
Parameters
- Optional settings: Partial<LoadSettings>
  
  Optional settings for the loading process.
Returns Promise<void>
- Defined in src/vim-loader/vim.ts:258

loadFilter

loadFilter(filterMode: FilterMode, filter: number[], settings?: Partial<LoadSettings>): Promise<void>
Asynchronously loads geometry based on a specified filter mode and criteria.
Parameters
- filterMode: FilterMode
  
  The mode of filtering to apply.
- filter: number[]
  
  The filter criteria.
- Optional settings: Partial<LoadSettings>
  
  Optional settings for the loading process.
Returns Promise<void>
- Defined in src/vim-loader/vim.ts:303

loadSubset

loadSubset(subset: G3dSubset, settings?: Partial<LoadSettings>): Promise<void>
Asynchronously loads geometry for the specified subset according to the provided settings.
Parameters
- subset: G3dSubset
  
  The subset to load resources for.
- Optional settings: Partial<LoadSettings>
  
  Optional settings for the loading process.
Returns Promise<void>
- Defined in src/vim-loader/vim.ts:273

Class Vim

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

header: VimHeader

document: VimDocument

g3d: G3d

scene: Scene

settings: VimSettings

map: ElementMapping | ElementNoMapping | ElementMapping2

builder: SubsetBuilder

source: string

format: VimFormat

isLegacy: boolean

Returns Vim

Properties

Readonly bim

Readonly format

Readonly g3d

Readonly header

Readonly isLegacy

Readonly map

Readonly scene

Readonly settings

Readonly source

Accessors

isLoading

Returns

Returns boolean

onDispose

Returns

Returns ISignal

onLoadingUpdate

Returns

Returns ISignal

Methods

clear

Returns void

dispose

Returns void

getFullSet

Returns

Returns G3dSubset

getMatrix

Returns

Returns Matrix4

getObjectFromElement

Returns

Parameters

element: number

Returns Object

getObjectFromInstance

Returns

Parameters

instance: number

Returns Object

getObjects

Returns

Returns Object[]

getObjectsFromElementId

Returns

Parameters

id: number

Returns any

getObjectsInBox

Returns

Parameters

box: Box3

Returns Object[]

getObjectsInSubset

Returns

Parameters

subset: G3dSubset

Returns Object[]

`Readonly` bim

`Readonly` format

`Readonly` g3d

`Readonly` header

`Readonly` isLegacy

`Readonly` map

`Readonly` scene

`Readonly` settings

`Readonly` source

`Optional` settings: Partial<LoadSettings>

`Optional` settings: Partial<LoadSettings>

`Optional` settings: Partial<LoadSettings>