Class TrimbimModel

constructor

• new TrimbimModel(name, api, modelBuilder, clipPlaneTool, settings, messenger, trimbimModels): TrimbimModel

• Parameters

  • name: string
  • api: Api
  • modelBuilder: ModelBuilder
  • clipPlaneTool: ClipPlaneTool
  • settings: TrimbimSettings
  • messenger: TrimbimWorkerMessenger
  • trimbimModels: Map<string, TrimbimModel>

  Returns TrimbimModel

Readonly isSelectable

updateCamera

clipping

• set clipping(clipping): void

• Parameters

  • clipping: boolean

  Returns void

pauseGeometryUpdate

• get pauseGeometryUpdate(): boolean

• Returns boolean

• set pauseGeometryUpdate(value): void

• Parameters

  • value: boolean

  Returns void

_addBatch

• _addBatch(batchObject): void

• Parameters

  • batchObject: GeometryObject3D

  Returns void

_clearSelection

• _clearSelection(): Promise<void>

• Returns Promise<void>

_getBatch

• _getBatch(batchId): GeometryObject3D

• Parameters

  • batchId: number

  Returns GeometryObject3D

_removeBatch

• _removeBatch(batchId): void

• Parameters

  • batchId: number

  Returns void

_setSelection

• _setSelection(entityIds): Promise<void>

• Parameters

  • entityIds: number[]

  Returns Promise<void>

aggregateProperties

• aggregateProperties(entityIds, aggregations): Promise<PropertyAggregation[]>

• Parameters

  • entityIds: number[]
  • aggregations: PropertyAggregation[]

  Returns Promise<PropertyAggregation[]>

areaPick

• areaPick(caster, containedOnly): Promise<IIntersection>

• Parameters

  • caster: Caster
  • containedOnly: boolean

  Returns Promise<IIntersection>

dispose

• dispose(): Promise<void>

• Returns Promise<void>

expandBoundingBox

• expandBoundingBox(object): void

• Parameters

  • object: Object3D<Object3DEventMap>

  Returns void

findEntitiesByClass

• findEntitiesByClass(entityClass): Promise<number[]>

• Parameters

  • entityClass: string

  Returns Promise<number[]>

findEntitiesByGeometryType

• findEntitiesByGeometryType(geometryType): Promise<number[]>

• Parameters

  • geometryType: TrimbimGeometryType

  Returns Promise<number[]>

findEntitiesByLayer

• findEntitiesByLayer(layerName): Promise<number[]>

• Parameters

  • layerName: string

  Returns Promise<number[]>

findEntitiesByProperty

• findEntitiesByProperty(propertyName, propertyValue): Promise<number[]>

• Parameters

  • propertyName: string | RegExp
  • propertyValue: string | number | RegExp

  Returns Promise<number[]>

findEntityLayers

• findEntityLayers(entityIds): Promise<number[]>

• Parameters

  • entityIds: number[]

  Returns Promise<number[]>

findLayersByEntities

• findLayersByEntities(entityIds): Promise<string[]>

• This method has memory and performance issues

  Parameters

  • entityIds: number[]

  Returns Promise<string[]>

  Deprecated

  use findEntityLayers instead

getBoundingBox

• getBoundingBox(entityIds?): Promise<Box3>

• Parameters

  • Optional entityIds: number[]

  Returns Promise<Box3>

getBoundingBoxes

• getBoundingBoxes(entityIds?): Promise<Box3[]>

• Parameters

  • Optional entityIds: number[]

  Returns Promise<Box3[]>

getBoundingBoxesForConnectIdentifier

• getBoundingBoxesForConnectIdentifier(entityIds?): Promise<Box3[]>

• Parameters

  • Optional entityIds: number[]

  Returns Promise<Box3[]>

getBuffer

• getBuffer(): Promise<ArrayBuffer | SharedArrayBuffer>

• Creates a copy of model file buffer, including modifications

  Returns Promise<ArrayBuffer | SharedArrayBuffer>

getCustomMaterialEntityIds

• getCustomMaterialEntityIds(): Promise<number[]>

• Returns Promise<number[]>

getCustomMaterials

• getCustomMaterials(entityIds?): Promise<IMetaMaterial[]>

• Parameters

  • Optional entityIds: number[]

  Returns Promise<IMetaMaterial[]>

getEntities

• getEntities(entityIds?): Promise<Entity[]>

• Parameters

  • Optional entityIds: number[]

  Returns Promise<Entity[]>

getEntitiesLength

• getEntitiesLength(): Promise<number>

• Returns Promise<number>

getEntityGeometry

• getEntityGeometry(entityId): Promise<EntityGeometry[]>

• Parameters

  • entityId: number

  Returns Promise<EntityGeometry[]>

getEntityIdsByPickPriority

• getEntityIdsByPickPriority(pickPriority, hierarchical?): Promise<number[]>

• Parameters

  • pickPriority: TrimbimPickPriority
  • Optional hierarchical: boolean

  Returns Promise<number[]>

getEntityIdsWithGeometry

• getEntityIdsWithGeometry(): Promise<number[]>

• Returns Promise<number[]>

getGridTags

• getGridTags(entityId): Promise<string[]>

• Parameters

  • entityId: number

  Returns Promise<string[]>

getHierarchyChildren

• getHierarchyChildren(entityIds, hierarchyType?, recursive?): Promise<number[]>

• Retreives hierarchy children of given parents

  Parameters

  • entityIds: number[]

    parents ids
  • Optional hierarchyType: HierarchyType

    limit children to this hierarchy type
  • Optional recursive: boolean

  Returns Promise<number[]>

getHierarchyOrphans

• getHierarchyOrphans(entityIds, hierarchyType?): Promise<number[]>

• Parameters

  • entityIds: number[]
  • Optional hierarchyType: HierarchyType

  Returns Promise<number[]>

getHierarchyParents

• getHierarchyParents(entityIds, hierarchyType?, recursive?, containedOnly?): Promise<number[]>

• Retreives hierarchy parents of given children

  Parameters

  • entityIds: number[]

    child ids
  • Optional hierarchyType: HierarchyType

    limit parents to this hierarchy type
  • Optional recursive: boolean
  • Optional containedOnly: boolean

  Returns Promise<number[]>

getHierarchyRoots

• getHierarchyRoots(hierarchyType?): Promise<number[]>

• Parameters

  • Optional hierarchyType: HierarchyType

  Returns Promise<number[]>

getLayerVisibilities

• getLayerVisibilities(layerIds): Promise<boolean[]>

• Parameters

  • layerIds: number[]

  Returns Promise<boolean[]>

getLayerVisibility

• getLayerVisibility(layerName): Promise<boolean>

• This method has memory and performance issues

  Parameters

  • layerName: string

  Returns Promise<boolean>

  Deprecated

  use getLayerVisibilities instead

getLayers

• getLayers(): Promise<string[]>

• Returns Promise<string[]>

getProducts

• getProducts(entityIds): Promise<Product[]>

• Parameters

  • entityIds: number[]

  Returns Promise<Product[]>

getProperties

• getProperties(entityId): Promise<PropertySet[]>

• Parameters

  • entityId: number

  Returns Promise<PropertySet[]>

getPropertyDefinitions

• getPropertyDefinitions(setName): Promise<PropertyDefinition[]>

• Parameters

  • setName: string

  Returns Promise<PropertyDefinition[]>

getPropertySetNames

• getPropertySetNames(): Promise<string[]>

• Returns Promise<string[]>

getPropertyValues

• getPropertyValues(propertyName): Promise<(string | number | bigint)[]>

• Parameters

  • propertyName: string

  Returns Promise<(string | number | bigint)[]>

getSelection

• getSelection(): Promise<number[]>

• Returns Promise<number[]>

getUntransformedBoundingBoxes

• getUntransformedBoundingBoxes(entityIds?): Promise<Box3[]>

• Parameters

  • Optional entityIds: number[]

  Returns Promise<Box3[]>

  Deprecated

  use getBoundingBoxesForConnectIdentifier for identifier calculations, or getBoundingBoxes for everything else

getVisibility

• getVisibility(entityIds): Promise<boolean[]>

• Parameters

  • entityIds: number[]

  Returns Promise<boolean[]>

getVisibleEntityIds

• getVisibleEntityIds(visible, hierarchical?): Promise<number[]>

• Parameters

  • visible: boolean
  • Optional hierarchical: boolean

  Returns Promise<number[]>

getXRefs

• getXRefs(): Promise<DwgXref[]>

• Returns Promise<DwgXref[]>

guidsToEntityIds

• guidsToEntityIds(guids): Promise<number[]>

• Parameters

  • guids: string[]

  Returns Promise<number[]>

isLoading

• isLoading(): boolean

• Returns boolean

load

• load(buffer, loadOptions): Promise<void>

• Parameters

  • buffer: ArrayBuffer | SharedArrayBuffer
  • loadOptions: TrimbimLoadOptions

  Returns Promise<void>

onGeometryUpdateFinished

• onGeometryUpdateFinished(): void

• Returns void

pick

• pick(caster): Promise<IIntersection>

• Parameters

  • caster: Caster

  Returns Promise<IIntersection>

pickFollowLine

• pickFollowLine(entityId, ray): Promise<Hit>

• Parameters

  • entityId: number
  • ray: Ray

  Returns Promise<Hit>

pickSnapped

• pickSnapped(caster, snapTypes): Promise<IIntersection[]>

• Parameters

  • caster: Caster
  • snapTypes: SnapType[]

  Returns Promise<IIntersection[]>

processMessage

• processMessage(message): Promise<void>

• Parameters

  • message: IMessage

  Returns Promise<void>

redo

• redo(): Promise<void>
• Experimental

  feature, do not use in production

  Returns Promise<void>

resetCustomMaterials

• resetCustomMaterials(entityIds?): Promise<void>

• Parameters

  • Optional entityIds: number[]

  Returns Promise<void>

resetPickPriority

• resetPickPriority(): Promise<void>

• Returns Promise<void>

resetVisibility

• resetVisibility(): Promise<void>

• Returns Promise<void>

setCustomMaterial

• setCustomMaterial(entityIds, customMaterial): Promise<void>

• Parameters

  • entityIds: number[]
  • customMaterial: IMetaMaterial

  Returns Promise<void>

setEntityTransform

• setEntityTransform(entityId, transform): Promise<void>
• Experimental

  feature, do not use in production

  Parameters

  • entityId: number
  • transform: Matrix4

  Returns Promise<void>

setHovered

• setHovered(entityIds): Promise<void>

• Parameters

  • entityIds: number[]

  Returns Promise<void>

setHoveredFromEvent

• setHoveredFromEvent(event): void

• Parameters

  • event: PointerInput

  Returns void

setLayerVisibilities

• setLayerVisibilities(layerIds, visible): Promise<void>

• Parameters

  • layerIds: number[]
  • visible: boolean

  Returns Promise<void>

setLayerVisibility

• setLayerVisibility(layerName, visible): Promise<void>

• This method has memory and performance issues

  Parameters

  • layerName: string
  • visible: boolean

  Returns Promise<void>

  Deprecated

  use setLayerVisibilities instead

setPickPriority

• setPickPriority(entityIds, pickPriority): Promise<void>

• Parameters

  • entityIds: number[]
  • pickPriority: TrimbimPickPriority

  Returns Promise<void>

setVisibility

• setVisibility(entityIds, visible): Promise<void>

• Parameters

  • entityIds: number[]
  • visible: boolean

  Returns Promise<void>

transform

• transform(matrix): void

• Parameters

  • matrix: Matrix4

  Returns void

undo

• undo(): Promise<void>
• Experimental

  feature, do not use in production

  Returns Promise<void>