Class Vim

constructor

• new Vim(
      header: VimHeader,
      document: VimDocument,
      g3d: G3d,
      scene: Scene,
      settings: VimSettings,
      map: ElementMapping | ElementNoMapping | ElementMapping2,
      builder: SubsetBuilder,
      source: string,
      format: VimFormat,
  ): WebglViewer.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.

  Returns WebglViewer.Vim

Readonlybim

Readonlyformat

Readonlyg3d

Readonlyheader

Readonlymap

Readonlyscene

Readonlysettings

Readonlysource

isLoading

• get isLoading(): boolean

• Indicates whether there are subsets currently being loaded.

  Returns boolean

  True if subsets are being loaded; otherwise, false.

onDispose

• get onDispose(): ISignal

• Getter for accessing the signal dispatched when the object is disposed.

  Returns ISignal

  The signal for disposal events.

onLoadingUpdate

• get onLoadingUpdate(): ISignal

• Getter for accessing the event dispatched whenever a subset begins or finishes loading.

  Returns ISignal

  The event dispatcher for loading updates.

clear

• clear(): void

• Removes the current geometry from the renderer.

  Returns void

dispose

• dispose(): void

• Cleans up and releases resources associated with the vim.

  Returns void

getFullSet

• getFullSet(): G3dSubset

• Retrieves all instances as a subset.

  Returns G3dSubset

  A subset containing all instances.

getMatrix

• getMatrix(): Matrix4

• Retrieves the matrix representation of the Vim object's position, rotation, and scale.

  Returns Matrix4

  The matrix representing the Vim object's transformation.

getObjectFromElement

• getObjectFromElement(element: number): Object3D

• Retrieves the Vim object associated with the given Vim element index.

  Parameters

  • element: number

    The index of the Vim element.

  Returns Object3D

  The Vim object corresponding to the element index, or undefined if not found.

getObjectFromInstance

• getObjectFromInstance(instance: number): Object3D

• Retrieves the object associated with the specified instance number.

  Parameters

  • instance: number

    The instance number of the object.

  Returns Object3D

  The object corresponding to the instance, or undefined if not found.

getObjects

• getObjects(): Object3D[]

• Retrieves an array of all objects within the Vim.

  Returns Object3D[]

  An array containing all objects within the Vim.

getObjectsFromElementId

• getObjectsFromElementId(id: number): any

• Retrieves the objects associated with the specified element ID.

  Parameters

  • id: number

    The element ID to retrieve objects for.

  Returns any

  An array of objects corresponding to the element ID, or an empty array if none are found.

getObjectsInBox

• getObjectsInBox(box: Box3): Object3D[]

• Retrieves an array containing all Vim objects strictly contained within the specified bounding box.

  Parameters

  • box: Box3

    The bounding box to search within.

  Returns Object3D[]

  An array of Vim objects strictly contained within the bounding box.

getObjectsInSubset

• getObjectsInSubset(subset: G3dSubset): Object3D[]

• Retrieves an array containing all objects within the specified subset.

  Parameters

  • subset: G3dSubset

    The subset to retrieve objects from.

  Returns Object3D[]

  An array of objects within the specified subset.

loadAll

• loadAll(settings?: Partial<LoadSettings>): Promise<void>

• Asynchronously loads all geometry according to the provided settings.

  Parameters

  • Optionalsettings: Partial<LoadSettings>

    Optional settings for the loading process.

  Returns Promise<void>

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.
  • Optionalsettings: Partial<LoadSettings>

    Optional settings for the loading process.

  Returns Promise<void>

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.
  • Optionalsettings: Partial<LoadSettings>

    Optional settings for the loading process.

  Returns Promise<void>