Class Properties

Index

Methods

getItemProperties getMaterialsProperties getPropertySets getSpatialStructure getTypeProperties setMaterialsProperties setPropertySets

Methods

getItemProperties

getItemProperties(
    modelID: number,
    id: number,
    recursive?: boolean,
    inverse?: boolean,
): Promise<any>
Parameters
- modelID: number
  model handle
- id: number
  expressID of IfcElement
- recursive: boolean = false
  default false, if true get all nested properties recursively
- inverse: boolean = false
  default false, if true get all inverse properties recursively
Returns Promise<any>
IfcElement
- Defined in helpers/properties.ts:75

getMaterialsProperties

getMaterialsProperties(
    modelID: number,
    elementID?: number,
    recursive?: boolean,
    includeTypeMaterials?: boolean,
): Promise<any[]>
Get materials of IfcElement
Parameters
- modelID: number
  model handle
- elementID: number = 0
  expressID of IfcElement, default 0 (all materials in model)
- recursive: boolean = false
  default false, if true get all nested properties recursively
- includeTypeMaterials: boolean = false
Returns Promise<any[]>
array of IfcElements inheriting from IfcMaterialDefinition
- Defined in helpers/properties.ts:133

getPropertySets

getPropertySets(
    modelID: number,
    elementID?: number,
    recursive?: boolean,
    includeTypeProperties?: boolean,
): Promise<any[]>
Get IfcPropertySets of IfcElements
Parameters
- modelID: number
  model handle
- elementID: number = 0
  expressID of IfcElement, default 0 (all psets in model)
- recursive: boolean = false
  default false, if true get all nested properties recursively
- includeTypeProperties: boolean = false
Returns Promise<any[]>
array of IfcElements inheriting from IfcPropertySetDefinition
- Defined in helpers/properties.ts:86

getSpatialStructure

getSpatialStructure(modelID: number, includeProperties?: boolean): Promise<Node>
Get Spatial Structure of IfcProject
Parameters
- modelID: number
  model handle
- includeProperties: boolean = false
  default false
Returns Promise<Node>
IfcProject as Node
- Defined in helpers/properties.ts:161

getTypeProperties

getTypeProperties(
    modelID: number,
    elementID?: number,
    recursive?: boolean,
): Promise<any[]>
Get TypeObject of IfcElements
Parameters
- modelID: number
  model handle
- elementID: number = 0
  expressID of IfcElement, default 0 (all type objects in model)
- recursive: boolean = false
  default false, if true get all nested properties of the type object recursively
Returns Promise<any[]>
array of objects inheriting from IfcTypeObject
- Defined in helpers/properties.ts:115

setMaterialsProperties

setMaterialsProperties(
    modelID: number,
    elementID: number | number[],
    materialID: number | number[],
): Promise<boolean>
Set IfcRelAssociatesMaterial relations of IfcElements and IfcMaterialDefinitions
Parameters
- modelID: number
  model handle
- elementID: number | number[]
  expressID or array of expressIDs of IfcElements
- materialID: number | number[]
  expressID or array of expressIDs of IfcMaterialDefinitions
Returns Promise<boolean>
true if success or false if error
- Defined in helpers/properties.ts:151

setPropertySets

setPropertySets(
    modelID: number,
    elementID: number | number[],
    psetID: number | number[],
): Promise<boolean>
Set IfcRelDefinesByProperties relations of IfcElements and IfcPropertySets
Parameters
- modelID: number
  model handle
- elementID: number | number[]
  expressID or array of expressIDs of IfcElements
- psetID: number | number[]
  expressID or array of expressIDs of IfcPropertySets
Returns Promise<boolean>
true if success or false if error
- Defined in helpers/properties.ts:104