Class Vim

constructor

• new Vim(
      rpc: RpcSafeClient,
      color: ColorManager,
      renderer: Core.Ultra.Renderer,
      source: Core.Ultra.VimSource,
      logger: ILogger,
  ): Core.Ultra.Vim

• Parameters

  • rpc: RpcSafeClient
  • color: ColorManager
  • renderer: Core.Ultra.Renderer
  • source: Core.Ultra.VimSource
  • logger: ILogger

  Returns Core.Ultra.Vim

ReadonlynodeState

Readonlysource

connected

• get connected(): boolean

• Returns boolean

handle

• get handle(): number

• Returns number

clearColor

• clearColor(nodes: "all" | number[]): void

• Parameters

  • nodes: "all" | number[]

  Returns void

connect

• connect(): Core.Ultra.LoadRequest

• Returns Core.Ultra.LoadRequest

disconnect

• disconnect(): void

• Returns void

getAllElements

• getAllElements(): Core.Ultra.Element3D[]

• Retrieves all elements within the Vim.

  Returns Core.Ultra.Element3D[]

  An array of all Vim objects.

getBoundingBox

• getBoundingBox(): Promise<Box3>

• Retrieves the bounding box of the Vim object.

  Returns Promise<Box3>

  The bounding box of the Vim object.

getBoundingBoxNodes

• getBoundingBoxNodes(nodes: "all" | number[]): Promise<Box3>

• Parameters

  • nodes: "all" | number[]

  Returns Promise<Box3>

getColor

• getColor(node: number): RGBA32

• Parameters

  • node: number

  Returns RGBA32

getElementFromIndex

• getElementFromIndex(element: number): Core.Ultra.Element3D

• Retrieves the element associated with the given index.

  Parameters

  • element: number

    The index of the element.

  Returns Core.Ultra.Element3D

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

getElementFromInstanceIndex

• getElementFromInstanceIndex(instance: number): Core.Ultra.Element3D

• Retrieves the element associated with the specified instance index.

  Parameters

  • instance: number

    The instance index of the of one of the instance included in the element.

  Returns Core.Ultra.Element3D

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

getElementsFromId

• getElementsFromId(id: number): Core.Ultra.Element3D[]

• Retrieves the element associated with the specified id.

  Parameters

  • id: number

    The element ID to retrieve objects for.

  Returns Core.Ultra.Element3D[]

  An array of element corresponding to the given id.

getObjectsInBox

• getObjectsInBox(box: Box3): Core.Ultra.Element3D[]

• Parameters

  • box: Box3

  Returns Core.Ultra.Element3D[]

reapplyColors

• reapplyColors(): void

• Returns void

setColor

• setColor(nodes: number[], color: RGBA32): Promise<void>

• Parameters

  • nodes: number[]
  • color: RGBA32

  Returns Promise<void>

setColors

• setColors(nodes: number[], color: RGBA32[]): Promise<void>

• Parameters

  • nodes: number[]
  • color: RGBA32[]

  Returns Promise<void>