Class Object

High level api to interact with the loaded vim geometry and data.

Hierarchy

Object

Implements

IObject

Index

Constructors

constructor

new Object(vim: Vim, element: number, instances: number[], meshes: Submesh[]): Object
Constructs a new instance of Object.
Parameters
- vim: Vim
  
  The Vim instance.
- element: number
  
  The element index.
- instances: number[]
  
  An optional array of instance numbers.
- meshes: Submesh[]
  
  An optional array of submeshes.
Returns Object
- Defined in src/vim-loader/object.ts:130

Properties

`Readonly` element

element: number

The bim element index associated with this object.

`Readonly` instances

instances: number[]

The geometry instances associated with this object.

`Readonly` type

type: ObjectType = "Architectural"

Indicate whether this object is architectural or markup.

`Readonly` vim

vim: Vim

The vim object from which this object came from.

Accessors

color

get color(): Color
Gets or sets the display color of this object.

Returns
The current color of the object.

Returns Color
Implementation of IObject.color
- Defined in src/vim-loader/object.ts:111
set color(color: Color): void
Gets or sets the display color of this object.

Param
The color to apply. Pass undefined to revert to the default color.

Returns
The current color of the object.
Parameters
- color: Color
Returns void
Implementation of IObject.color
- Defined in src/vim-loader/object.ts:115

elementId

get elementId(): bigint
The ID of the element associated with this object.

Returns bigint
Implementation of IObject.elementId
- Defined in src/vim-loader/object.ts:49

focused

get focused(): boolean
Determines whether to render focus highlight for this object or not.

Returns boolean
Implementation of IObject.focused
- Defined in src/vim-loader/object.ts:83
set focused(value: boolean): void
Determines whether to render focus highlight for this object or not.
Parameters
- value: boolean
Returns void
Implementation of IObject.focused
- Defined in src/vim-loader/object.ts:87

hasMesh

get hasMesh(): boolean
Checks if this object has associated geometry.

Returns
True if this object has geometry, otherwise false.

Returns boolean
Implementation of IObject.hasMesh
- Defined in src/vim-loader/object.ts:62

outline

get outline(): boolean
Determines whether to render selection outline for this object or not.

Returns boolean
Implementation of IObject.outline
- Defined in src/vim-loader/object.ts:69
set outline(value: boolean): void
Determines whether to render selection outline for this object or not.
Parameters
- value: boolean
Returns void
Implementation of IObject.outline
- Defined in src/vim-loader/object.ts:73

visible

get visible(): boolean
Determines whether to render this object or not.

Returns boolean
Implementation of IObject.visible
- Defined in src/vim-loader/object.ts:96
set visible(value: boolean): void
Determines whether to render this object or not.
Parameters
- value: boolean
Returns void
Implementation of IObject.visible
- Defined in src/vim-loader/object.ts:100

Methods

_addMesh

_addMesh(mesh: Submesh): void
Internal method used to replace this object's meshes and apply color as needed.

Throws
Throws an error if the provided mesh instance does not match any existing instances.
Parameters
- mesh: Submesh
  
  The new mesh to be added.
Returns void
- Defined in src/vim-loader/object.ts:230

getBimElement

getBimElement(): Promise<IElement>
Asynchronously retrieves Bim data for the element associated with this object.

Returns
An object containing the bim data for this element.

Returns Promise<IElement>
Implementation of IObject.getBimElement
- Defined in src/vim-loader/object.ts:180

getBimParameters

getBimParameters(): Promise<ElementParameter[]>
Asynchronously retrieves Bim parameters for the element associated with this object.

Returns
An array of all bim parameters for this elements.

Returns Promise<ElementParameter[]>
Implementation of IObject.getBimParameters
- Defined in src/vim-loader/object.ts:188

getBoundingBox

getBoundingBox(): Box3
Retrieves the bounding box of the object from cache or computes it if needed. Returns undefined if the object has no geometry.

Returns
The bounding box of the object, or undefined if the object has no geometry.

Returns Box3
Implementation of IObject.getBoundingBox
- Defined in src/vim-loader/object.ts:197

getCenter

getCenter(target??: Vector3): Vector3
Retrieves the center position of this object.

Returns
The center position of the object, or undefined if the object has no geometry.
Parameters
- Optional target: Vector3 = ...
Returns Vector3
Implementation of IObject.getCenter
- Defined in src/vim-loader/object.ts:221

Class Object

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

vim: Vim

element: number

instances: number[]

meshes: Submesh[]

Returns Object

Properties

Readonly element

Readonly instances

Readonly type

Readonly vim

Accessors

color

Returns

Returns Color

Param

Returns

Parameters

color: Color

Returns void

elementId

Returns bigint

focused

Returns boolean

Parameters

value: boolean

Returns void

hasMesh

Returns

Returns boolean

outline

Returns boolean

Parameters

value: boolean

Returns void

visible

Returns boolean

Parameters

value: boolean

Returns void

Methods

_addMesh

Throws

Parameters

mesh: Submesh

Returns void

getBimElement

Returns

Returns Promise<IElement>

getBimParameters

Returns

Returns Promise<ElementParameter[]>

getBoundingBox

Returns

Returns Box3

getCenter

Returns

Parameters

Optional target: Vector3 = ...

Returns Vector3

Settings

Member Visibility

Theme

`Readonly` element

`Readonly` instances

`Readonly` type

`Readonly` vim

`Optional` target: Vector3 = ...