Interface IObject

API to interact with an object that is both visible and related to a bim element.

Hierarchy

  • IObject

Implemented by

Properties

color element elementId focused hasMesh instances outline type vim visible

Methods

getBimElement getBimParameters getBoundingBox getCenter

Properties

color

color: Color

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.

element

element: number

The bim element index associated with this object.

elementId

elementId: BigInt

The ID of the element associated with this object.

focused

focused: boolean

Determines whether to render focus highlight for this object or not.

hasMesh

hasMesh: boolean

Checks if this object has associated geometry.

Returns

True if this object has geometry, otherwise false.

instances

instances: number[]

The geometry instances associated with this object.

outline

outline: boolean

Determines whether to render selection outline for this object or not.

type

type: ObjectType

Indicate whether this object is architectural or markup.

vim

vim: Vim

The vim object from which this object came from.

visible

visible: boolean

Determines whether to render this object or not.

Methods

getBimElement

  • Asynchronously retrieves Bim data for the element associated with this object.

    Returns

    An object containing the bim data for this element.

    Returns Promise<IElement>

getBimParameters

  • Asynchronously retrieves Bim parameters for the element associated with this object.

    Returns

    An array of all bim parameters for this elements.

    Returns Promise<ElementParameter[]>

getBoundingBox

  • 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.

    Parameters

    • Optional target: Box3

    Returns Box3

getCenter

  • 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

Settings

Member Visibility

Theme

Generated using TypeDoc