Class VimObject

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

Hierarchy

VimObject

Index

Constructors

Properties

document element instances vim

Accessors

color elementId focused hasMesh outline visible

Methods

createGeometry createWireframe getBimElement getBimParameters getBoundingBox getCenter

Constructors

constructor

new VimObject(vim: Vim, element: number, instances: number[], meshes: SubMesh[]): VimObject
Parameters
- vim: Vim
- element: number
- instances: number[]
- meshes: SubMesh[]
Returns VimObject
- Defined in src/vim-loader/vimObject.ts:30

Properties

document

document: VimDocument

element

element: number

instances

instances: number[]

vim

vim: Vim

Accessors

color

get color(): Color
Changes the display color of this object.

Returns Color
- Defined in src/vim-loader/vimObject.ts:125
set color(color: Color): void
Parameters
- color: Color
Returns void
- Defined in src/vim-loader/vimObject.ts:129

elementId

get elementId(): any
Returns the element id of the element associated with this object

Returns any
- Defined in src/vim-loader/vimObject.ts:161

focused

get focused(): boolean
Toggles focused highlight for this object.

Returns boolean
- Defined in src/vim-loader/vimObject.ts:102
set focused(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/vim-loader/vimObject.ts:106

hasMesh

get hasMesh(): boolean
Returns true if this object has geometry

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

outline

get outline(): boolean
Toggles selection outline for this object.

Returns boolean
- Defined in src/vim-loader/vimObject.ts:87
set outline(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/vim-loader/vimObject.ts:91

visible

get visible(): boolean
Toggles visibility of this object.

Returns boolean
- Defined in src/vim-loader/vimObject.ts:113
set visible(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/vim-loader/vimObject.ts:117

Methods

createGeometry

createGeometry(): BufferGeometry
Creates a new THREE.BufferGeometry for this object Returns undefined if object has no geometry.

Returns BufferGeometry
- Defined in src/vim-loader/vimObject.ts:214

createWireframe

createWireframe(): LineSegments<WireframeGeometry<BufferGeometry>, LineBasicMaterial>
Creates a new three wireframe Line object from the object geometry

Returns LineSegments<WireframeGeometry<BufferGeometry>, LineBasicMaterial>
- Defined in src/vim-loader/vimObject.ts:199

getBimElement

getBimElement(): Promise<IElement>
Returns Bim data for the element associated with this object. Returns undefined if no associated bim

Returns Promise<IElement>
- Defined in src/vim-loader/vimObject.ts:147

getBimParameters

getBimParameters(): Promise<ElementParameter[]>
Returns Bim data for the element associated with this object.

Returns Promise<ElementParameter[]>
- Defined in src/vim-loader/vimObject.ts:154

getBoundingBox

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

Returns Box3
- Defined in src/vim-loader/vimObject.ts:169

getCenter

getCenter(target?: THREE.Vector3): THREE.Vector3
Returns the center position of this object
Parameters
- target: THREE.Vector3 = ...
  
  Vector3 where to copy data. A new instance is created if none provided. Returns undefined if object has no geometry.
Returns THREE.Vector3
- Defined in src/vim-loader/vimObject.ts:192

Generated using TypeDoc