### Install web-ifc NPM Package Source: https://thatopen.github.io/engine_web-ifc/docs/index Instructions to install the web-ifc library using the Node Package Manager (npm). This command adds the web-ifc package to your project's dependencies. ```Bash npm install web-ifc ``` -------------------------------- ### API Navigation: Page Constructors and Properties Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC2X3.IfcMechanicalConcreteMaterialProperties Lists the constructors and properties available on the current documentation page, serving as a quick navigation guide for the API elements documented within this section. ```APIDOC Constructors constructor Properties AdmixturesDescription CompressiveStrength DynamicViscosity expressID Material MaxAggregateSize PoissonRatio ProtectivePoreRatio ShearModulus ThermalExpansionCoefficient type WaterImpermeability Workability YoungModulus ``` -------------------------------- ### Get Express ID from Global ID (GUID) Source: https://thatopen.github.io/engine_web-ifc/docs/classes/web-ifc.IfcAPI Looks up and returns an entity's express ID based on its GlobalID (GUID) within a specified model. The function can return undefined, a string, or a number for the express ID. ```APIDOC GetExpressIdFromGuid(modelID: number, guid: string): undefined | string | number Parameters: modelID: number Model handle retrieved by OpenModel guid: string GobalID to be looked up Returns: undefined | string | number expressID numerical value ``` -------------------------------- ### Web-IFC Entity Constructor Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC2X3.IfcEquipmentElement Details the constructor available for instantiating a Web-IFC entity, outlining its basic initialization. The specific parameters are not detailed in this index. ```APIDOC constructor() ``` -------------------------------- ### IfcAPI Constructor Overview Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC2X3.IfcOpenShell Lists the available constructors for the IfcAPI class. Detailed documentation for the constructor is available via the provided link in the original source. ```APIDOC IfcAPI: constructor() ``` -------------------------------- ### IFC Schema: Start Property Definition Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4.IfcWorkTime Specifies the Start property, which can be null or an IfcDate object from IFC4, indicating a date value, as defined in ifc-schema.ts. ```APIDOC Start: null | [IFC4](../modules/ifc-schema.IFC4.html).[IfcDate](ifc-schema.IFC4.IfcDate.html) ``` -------------------------------- ### Web-IFC API Constructors Overview Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcComplexProperty This section lists the primary constructors available in the Web-IFC API, providing entry points for creating instances or initializing core components. ```APIDOC Constructors: - constructor ``` -------------------------------- ### Web-IFC API Constructors Overview Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcAudioVisualApplianceTypeEnum This section lists the primary constructors available in the Web-IFC API, providing a quick reference and links to their specific documentation. ```APIDOC Constructors: - constructor ``` -------------------------------- ### GetNextExpressID Source: https://thatopen.github.io/engine_web-ifc/docs/classes/web-ifc.IfcAPI Gets the next unused expressID. ```APIDOC GetNextExpressID(modelID: number, expressID: number): number Parameters: modelID: number Description: Model handle retrieved by OpenModel expressID: number Description: Starting expressID value Returns: number Description: The next unused expressID starting from the value provided ``` -------------------------------- ### IfcEngine Class Constructor Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4.IfcEngine Documents the constructor for the IfcEngine class, detailing all required and optional parameters for its instantiation. It inherits from IfcEnergyConversionDevice and returns an IfcEngine instance. ```APIDOC new IfcEngine( GlobalId: IFC4.IfcGloballyUniqueId, OwnerHistory: null | IFC4.IfcOwnerHistory | Handle, Name: null | IFC4.IfcLabel, Description: null | IFC4.IfcText, ObjectType: null | IFC4.IfcLabel, ObjectPlacement: null | IFC4.IfcObjectPlacement | Handle, Representation: null | IFC4.IfcProductRepresentation | Handle, Tag: null | IFC4.IfcIdentifier, PredefinedType: null | IFC4.IfcEngineTypeEnum ): IFC4.IfcEngine Parameters: GlobalId: IFC4.IfcGloballyUniqueId OwnerHistory: null | IFC4.IfcOwnerHistory | Handle Name: null | IFC4.IfcLabel Description: null | IFC4.IfcText ObjectType: null | IFC4.IfcLabel ObjectPlacement: null | IFC4.IfcObjectPlacement | Handle Representation: null | IFC4.IfcProductRepresentation | Handle Tag: null | IFC4.IfcIdentifier PredefinedType: null | IFC4.IfcEngineTypeEnum Returns: IFC4.IfcEngine ``` -------------------------------- ### GetNameFromTypeCode Source: https://thatopen.github.io/engine_web-ifc/docs/classes/web-ifc.IfcAPI Gets the name from a type code. ```APIDOC GetNameFromTypeCode(type: number): string Parameters: type: number Description: Code Returns: string Description: Name ``` -------------------------------- ### IfcAPI Class Constructors and Properties Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4.IfcWindowStyle Provides an overview of the available constructors and properties for an IfcAPI class. This section serves as a quick reference for navigating the class's public interface. ```APIDOC Constructors constructor Properties ApplicableOccurrence ConstructionType Decomposes Description expressID GlobalId HasAssignments HasAssociations HasContext HasPropertySets IsDecomposedBy IsNestedBy Name Nests OperationType OwnerHistory ParameterTakesPrecedence ReferencedBy RepresentationMaps Sizeable Tag type Types ``` -------------------------------- ### GetTypeCodeFromName Source: https://thatopen.github.io/engine_web-ifc/docs/classes/web-ifc.IfcAPI Gets the type code from a name code. ```APIDOC GetTypeCodeFromName(typeName: string): number Parameters: typeName: string Returns: number Description: type code ``` -------------------------------- ### IfcDoorType Constructor Overview Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcDoorType Provides an overview of the constructor for the IfcDoorType class. The provided documentation does not detail specific parameters or return types for the constructor. ```APIDOC Constructors: constructor ``` -------------------------------- ### StartTime Property Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC2X3.IfcTimeSeries Specifies the start time of an event or process, typed as IfcDateTimeSelect. ```APIDOC StartTime: IfcDateTimeSelect ``` -------------------------------- ### Get ForProfileEndSet Property Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcMaterialProfileSetUsageTapering Retrieves the ForProfileEndSet property, which can be an IfcMaterialProfileSet or a Handle to an IfcMaterialProfileSet. ```APIDOC ForProfileEndSet: | IFC4X3.IfcMaterialProfileSet | Handle ``` -------------------------------- ### Web-IFC API Constructors and Properties Overview Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcInterceptor This section outlines the main constructors and properties available within the Web-IFC API, providing a structured list for quick reference. ```APIDOC Web-IFC API: Constructors: - constructor Properties: - ConnectedFrom - ConnectedTo - ContainedInStructure - Declares - Decomposes - Description - expressID - FillsVoids - GlobalId - HasAssignments - HasAssociations - HasContext - HasControlElements - HasCoverings - HasOpenings - HasPorts - HasProjections - HasSurfaceFeatures - InterferesElements - IsConnectionRealization - IsDeclaredBy - IsDecomposedBy - IsDefinedBy - IsInterferedByElements - IsNestedBy - IsTypedBy - Name - Nests - ObjectPlacement - ObjectType - OwnerHistory - PositionedRelativeTo - PredefinedType - ProvidesBoundaries - ReferencedBy - ReferencedInStructures - Representation - Tag - type ``` -------------------------------- ### IfcEquipmentElement Constructor API Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC2X3.IfcEquipmentElement This snippet documents the constructor for the IfcEquipmentElement class. It details all required and optional parameters for creating a new instance of an IfcEquipmentElement, including its global ID, owner history, name, description, object type, placement, representation, and tag. The constructor returns a new IfcEquipmentElement object. ```APIDOC new IfcEquipmentElement( GlobalId: IfcGloballyUniqueId, OwnerHistory: IfcOwnerHistory | Handle, Name: null | IfcLabel, Description: null | IfcText, ObjectType: null | IfcLabel, ObjectPlacement: null | IfcObjectPlacement | Handle, Representation: null | IfcProductRepresentation | Handle, Tag: null | IfcIdentifier ) Parameters: GlobalId: IfcGloballyUniqueId - A globally unique identifier for the element. OwnerHistory: IfcOwnerHistory | Handle - The history of the object's ownership. Name: null | IfcLabel - The name of the object. Description: null | IfcText - A description of the object. ObjectType: null | IfcLabel - The type of the object. ObjectPlacement: null | IfcObjectPlacement | Handle - The placement of the object in space. Representation: null | IfcProductRepresentation | Handle - The representation of the product. Tag: null | IfcIdentifier - A tag for the object. Returns: IfcEquipmentElement ``` -------------------------------- ### Property: StartTime Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4.IfcIrregularTimeSeries Represents the start time of the time series. It is inherited from IfcTimeSeries and is of type IfcDateTime. ```APIDOC StartTime: IFC4.IfcDateTime ``` -------------------------------- ### Property: StartParam Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4.IfcFixedReferenceSweptAreaSolid Defines the start parameter for an entity. It can be null or an IfcParameterValue. This property is defined in ifc-schema.ts. ```APIDOC StartParam: null | IFC4.IfcParameterValue ``` -------------------------------- ### GlobalId Property Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcMarineFacility Represents the globally unique identifier (GUID) for the entity. This property is inherited from IfcFacility. ```APIDOC GlobalId: IFC4X3.IfcGloballyUniqueId ``` -------------------------------- ### Get IFC Material Name Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4.IfcMaterial Retrieves the name of the IFC material, represented as an IfcLabel. ```APIDOC Name: IFC4.IfcLabel ``` -------------------------------- ### IfcMooringDevice Class API Reference Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcMooringDevice This section provides the API documentation for the IfcMooringDevice class, detailing its constructor parameters and inherited properties for connecting elements within the IFC4X3 schema. ```APIDOC Class: IfcMooringDevice Constructor: Parameters: GlobalId: IFC4X3.IfcGloballyUniqueId OwnerHistory: IFC4X3.IfcOwnerHistory | Handle | null Name: IFC4X3.IfcLabel | null Description: IFC4X3.IfcText | null ObjectType: IFC4X3.IfcLabel | null ObjectPlacement: IFC4X3.IfcObjectPlacement | Handle | null Representation: IFC4X3.IfcProductRepresentation | Handle | null Tag: IFC4X3.IfcIdentifier | null PredefinedType: IfcMooringDeviceTypeEnum | null Returns: IfcMooringDevice ``` ```APIDOC Property: ConnectedFrom Type: (IFC4X3.IfcRelConnectsElements | Handle)[] | null Inherited From: IfcBuiltElement ``` ```APIDOC Property: ConnectedTo Type: (IFC4X3.IfcRelConnectsElements | Handle)[] | null Inherited From: IfcBuiltElement ``` -------------------------------- ### IfcCooledBeam Constructor API Documentation Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcCooledBeam Documents the constructor for the IfcCooledBeam class, detailing all required and optional parameters for its instantiation within the IFC4X3 schema. It returns an instance of IfcCooledBeam. ```APIDOC new IfcCooledBeam( GlobalId: IFC4X3.IfcGloballyUniqueId, OwnerHistory: null | IFC4X3.IfcOwnerHistory | Handle, Name: null | IFC4X3.IfcLabel, Description: null | IFC4X3.IfcText, ObjectType: null | IFC4X3.IfcLabel, ObjectPlacement: null | IFC4X3.IfcObjectPlacement | Handle, Representation: null | IFC4X3.IfcProductRepresentation | Handle, Tag: null | IFC4X3.IfcIdentifier, PredefinedType: null | IFC4X3.IfcCooledBeamTypeEnum ): IFC4X3.IfcCooledBeam Parameters: - GlobalId: IFC4X3.IfcGloballyUniqueId - OwnerHistory: null | IFC4X3.IfcOwnerHistory | Handle - Name: null | IFC4X3.IfcLabel - Description: null | IFC4X3.IfcText - ObjectType: null | IFC4X3.IfcLabel - ObjectPlacement: null | IFC4X3.IfcObjectPlacement | Handle - Representation: null | IFC4X3.IfcProductRepresentation | Handle - Tag: null | IFC4X3.IfcIdentifier - PredefinedType: null | IFC4X3.IfcCooledBeamTypeEnum Returns: IFC4X3.IfcCooledBeam ``` -------------------------------- ### StartPoint Property Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcAlignmentHorizontalSegment This property specifies the starting point of the segment. It can be an IFC4X3.IfcCartesianPoint directly or a Handle referencing an IFC4X3.IfcCartesianPoint. ```APIDOC StartPoint: IFC4X3.IfcCartesianPoint | Handle ``` -------------------------------- ### StartDirection Property Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcAlignmentHorizontalSegment This property defines the starting direction of the segment. Its value is an IFC4X3.IfcPlaneAngleMeasure, representing an angle in a plane. ```APIDOC StartDirection: IFC4X3.IfcPlaneAngleMeasure ``` -------------------------------- ### Web-IFC Main API Class (IfcAPI) Source: https://thatopen.github.io/engine_web-ifc/docs/variables/ifc-schema.IFCTUBEBUNDLETYPE Documentation for the `IfcAPI` class, which serves as the main entry point for interacting with the web-ifc library, providing core functionalities for loading, parsing, and managing IFC models. ```APIDOC Class: IfcAPI Module: web_ifc Description: Main entry point for interacting with the web-ifc library, providing core functionalities for loading, parsing, and managing IFC models. ``` -------------------------------- ### Construct IfcAudioVisualAppliance Instance Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcAudioVisualAppliance Initializes a new instance of the `IfcAudioVisualAppliance` class. This constructor requires various IFC-specific parameters such as a globally unique ID, owner history, name, description, object type, object placement, representation, tag, and a predefined type. It returns a new `IfcAudioVisualAppliance` object. ```APIDOC IfcAudioVisualAppliance Constructor: new IfcAudioVisualAppliance( GlobalId: IFC4X3.IfcGloballyUniqueId, OwnerHistory: null | IFC4X3.IfcOwnerHistory | Handle, Name: null | IFC4X3.IfcLabel, Description: null | IFC4X3.IfcText, ObjectType: null | IFC4X3.IfcLabel, ObjectPlacement: null | IFC4X3.IfcObjectPlacement | Handle, Representation: null | IFC4X3.IfcProductRepresentation | Handle, Tag: null | IFC4X3.IfcIdentifier, PredefinedType: null | IFC4X3.IfcAudioVisualApplianceTypeEnum ): IFC4X3.IfcAudioVisualAppliance ``` -------------------------------- ### LateStart Property Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC2X3.IfcScheduleTimeControl Specifies the late start date/time for an entity. This property can be null or an IfcDateTimeSelect type. ```APIDOC LateStart: null | IfcDateTimeSelect ``` -------------------------------- ### Get Name Property for IfcStructuralReaction Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcStructuralCurveReaction Retrieves the 'Name' property, which is an IfcLabel. This property is inherited from IfcStructuralReaction. ```APIDOC Name: null | IFC4X3.IfcLabel Inherited from IfcStructuralReaction.Name ``` -------------------------------- ### IfcBearing Constructor Overview Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcBearing Lists the available constructors for the `IfcBearing` class. This section provides a quick reference to how instances of `IfcBearing` can be initialized. ```APIDOC Constructors: - constructor ``` -------------------------------- ### IfcSpace Class Constructor Documentation Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC2X3.IfcSpace Documents the constructor for the IfcSpace class, detailing all required and optional parameters for creating an instance of an IFC Space entity. It includes parameter types and the return type of the constructor. ```APIDOC new IfcSpace( GlobalId: IFC2X3.IfcGloballyUniqueId, OwnerHistory: IFC2X3.IfcOwnerHistory | Handle, Name: null | IFC2X3.IfcLabel, Description: null | IFC2X3.IfcText, ObjectType: null | IFC2X3.IfcLabel, ObjectPlacement: | null | IFC2X3.IfcObjectPlacement | Handle, Representation: | null | IFC2X3.IfcProductRepresentation | Handle, LongName: null | IFC2X3.IfcLabel, CompositionType: IFC2X3.IfcElementCompositionEnum, InteriorOrExteriorSpace: IFC2X3.IfcInternalOrExternalEnum, ElevationWithFlooring: null | IFC2X3.IfcLengthMeasure, ): IFC2X3.IfcSpace Parameters: GlobalId: IFC2X3.IfcGloballyUniqueId OwnerHistory: IFC2X3.IfcOwnerHistory | Handle Name: null | IFC2X3.IfcLabel Description: null | IFC2X3.IfcText ObjectType: null | IFC2X3.IfcLabel ObjectPlacement: null | IFC2X3.IfcObjectPlacement | Handle Representation: null | IFC2X3.IfcProductRepresentation | Handle LongName: null | IFC2X3.IfcLabel CompositionType: IFC2X3.IfcElementCompositionEnum InteriorOrExteriorSpace: IFC2X3.IfcInternalOrExternalEnum ElevationWithFlooring: null | IFC2X3.IfcLengthMeasure Returns: IFC2X3.IfcSpace ``` -------------------------------- ### Get ReferenceExtent Property Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcMaterialProfileSetUsageTapering Retrieves the ReferenceExtent property, which can be null or an IfcPositiveLengthMeasure. This property is inherited from IfcMaterialProfileSetUsage. ```APIDOC ReferenceExtent: null | IFC4X3.IfcPositiveLengthMeasure Inherited from IfcMaterialProfileSetUsage.ReferenceExtent ``` -------------------------------- ### Get CardinalPoint Property Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcMaterialProfileSetUsageTapering Retrieves the CardinalPoint property, which can be null or an IfcCardinalPointReference. This property is inherited from IfcMaterialProfileSetUsage. ```APIDOC CardinalPoint: null | IFC4X3.IfcCardinalPointReference Inherited from IfcMaterialProfileSetUsage.CardinalPoint ``` -------------------------------- ### IfcWindow Class Constructor and Properties API Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC2X3.IfcWindow This snippet provides the API documentation for the IfcWindow class, including its constructor signature with all parameters and their types, as well as the definition of the 'ConnectedFrom' property. ```APIDOC IfcWindow constructor: new IfcWindow( GlobalId: IFC2X3.IfcGloballyUniqueId, OwnerHistory: IFC2X3.IfcOwnerHistory | Handle, Name: null | IFC2X3.IfcLabel, Description: null | IFC2X3.IfcText, ObjectType: null | IFC2X3.IfcLabel, ObjectPlacement: null | IFC2X3.IfcObjectPlacement | Handle, Representation: null | IFC2X3.IfcProductRepresentation | Handle, Tag: null | IFC2X3.IfcIdentifier, OverallHeight: null | IFC2X3.IfcPositiveLengthMeasure, OverallWidth: null | IFC2X3.IfcPositiveLengthMeasure ): IFC2X3.IfcWindow ``` ```APIDOC IfcWindow.ConnectedFrom property: Type: null | (IFC2X3.IfcRelConnectsElements | Handle)[] Inherited from IfcBuildingElement.ConnectedFrom ``` -------------------------------- ### Web-IFC API Reference Index Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC2X3.IfcBeam Lists the main constructors and properties available in the Web-IFC API, serving as a navigation aid to their detailed documentation. ```APIDOC Web-IFC API Elements: Constructors: - constructor() Properties: - ConnectedFrom - ConnectedTo - ContainedInStructure - Decomposes - Description - expressID - FillsVoids - GlobalId - HasAssignments - HasAssociations - HasCoverings - HasOpenings - HasPorts - HasProjections - HasStructuralMember - IsConnectionRealization - IsDecomposedBy - IsDefinedBy - Name - ObjectPlacement - ObjectType - OwnerHistory - ProvidesBoundaries - ReferencedBy - ReferencedInStructures - Representation - Tag - type ``` -------------------------------- ### API Property: IfcControl.StartTime Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcWorkControl Indicates the start time of an IFC object. Its type is IfcDateTime. This property is defined in ifc-schema.ts. ```APIDOC StartTime: Type: IFC4X3.IfcDateTime Defined In: ifc-schema.ts:28253 ``` -------------------------------- ### IfcEvaporatorType Constructor API Documentation Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC2X3.IfcEvaporatorType Documents the constructor for the IfcEvaporatorType class, detailing all required and optional parameters for its instantiation. It outlines the types for each parameter, including references to IFC2X3 schema definitions and Handle types. ```APIDOC constructor( GlobalId: IFC2X3.IfcGloballyUniqueId, OwnerHistory: IFC2X3.IfcOwnerHistory | Handle, Name: null | IFC2X3.IfcLabel, Description: null | IFC2X3.IfcText, ApplicableOccurrence: null | IFC2X3.IfcLabel, HasPropertySets: null | (IFC2X3.IfcPropertySetDefinition | Handle)[], RepresentationMaps: null | (IFC2X3.IfcRepresentationMap | Handle)[], Tag: null | IFC2X3.IfcLabel, ElementType: null | IFC2X3.IfcLabel, PredefinedType: IFC2X3.IfcEvaporatorTypeEnum ): IFC2X3.IfcEvaporatorType ``` -------------------------------- ### IFC Schema Property: StartParam Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcSweptDiskSolid Defines the start parameter, which can be null or an IfcParameterValue. This property is defined in ifc-schema.ts. ```APIDOC StartParam: null | IfcParameterValue ``` -------------------------------- ### StartTag Property Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcAlignmentHorizontalSegment This property represents the start tag of a segment. It can be null or an instance of IFC4X3.IfcLabel. This property is inherited from IfcAlignmentParameterSegment. ```APIDOC StartTag: null | IFC4X3.IfcLabel ``` -------------------------------- ### IfcBoxedHalfSpace Constructor Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcBoxedHalfSpace Initializes a new instance of the IfcBoxedHalfSpace class. Requires a base surface, an agreement flag, and an enclosure bounding box. ```APIDOC constructor( BaseSurface: IFC4X3.IfcSurface | Handle, AgreementFlag: IFC4X3.IfcBoolean, Enclosure: IFC4X3.IfcBoundingBox | Handle ): IFC4X3.IfcBoxedHalfSpace Overrides: IfcHalfSpaceSolid.constructor Defined in: ifc-schema.ts:25536 ``` -------------------------------- ### StartRadiusOfCurvature Property Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcAlignmentHorizontalSegment This property defines the radius of curvature at the start of the segment. Its type is IFC4X3.IfcLengthMeasure, indicating a length value. ```APIDOC StartRadiusOfCurvature: IFC4X3.IfcLengthMeasure ``` -------------------------------- ### Web-IFC API Constructors and Properties Overview Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcApplication Lists the main constructors and properties exposed by the Web-IFC API, providing a quick reference to available members. ```APIDOC Constructors: - constructor Properties: - ApplicationDeveloper - ApplicationFullName - ApplicationIdentifier - expressID - type - Version ``` -------------------------------- ### Reference to Main Web-IFC API Class Source: https://thatopen.github.io/engine_web-ifc/docs/variables/ifc-schema.IFCPIPEFITTING Provides a direct link to the documentation for the `IfcAPI` class, which serves as the main entry point for interacting with the Web-IFC API in the That Open Engine. ```APIDOC Web-IFC API: Class: IfcAPI Documentation Link: classes/web_ifc.IfcAPI.html ``` -------------------------------- ### Get ForProfileSet Property Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcMaterialProfileSetUsageTapering Retrieves the ForProfileSet property, which can be an IfcMaterialProfileSet or a Handle to an IfcMaterialProfileSet. This property is inherited from IfcMaterialProfileSetUsage. ```APIDOC ForProfileSet: | IFC4X3.IfcMaterialProfileSet | Handle Inherited from IfcMaterialProfileSetUsage.ForProfileSet ``` -------------------------------- ### API Property: StartParam Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4.IfcSweptDiskSolidPolygonal Indicates the starting parameter value for an object. This property is inherited from IfcSweptDiskSolid and can be null or an IfcParameterValue. ```APIDOC StartParam: null | IFC4.IfcParameterValue Inherited from IfcSweptDiskSolid.StartParam ``` -------------------------------- ### Web-IFC API Constructors Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcReinforcingBar Lists the available constructors for Web-IFC objects. ```APIDOC constructor ``` -------------------------------- ### StartParam Property Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcDirectrixDerivedReferenceSweptAreaSolid This property defines the start parameter for a swept area solid. It can be null or an IfcCurveMeasureSelect type. It is inherited from IfcFixedReferenceSweptAreaSolid. ```APIDOC StartParam: null | IfcCurveMeasureSelect ``` -------------------------------- ### IfcPlate Constructor Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC2X3.IfcPlate Documents the constructor for the IfcPlate class. While specific parameters are not detailed in the provided text, its availability for object instantiation is noted. ```APIDOC Constructors - constructor ``` -------------------------------- ### API Documentation for SegmentStart Property Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcCurveSegment Defines the SegmentStart property, which specifies a measure for the start of a curve segment. It is of type IfcCurveMeasureSelect. ```APIDOC SegmentStart: IfcCurveMeasureSelect ``` -------------------------------- ### Web-IFC API Constructor Reference Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4.IfcShadingDevice Lists the available constructors for the Web-IFC API. ```APIDOC Constructors: - constructor ``` -------------------------------- ### PatternStart Property Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC2X3.IfcFillAreaStyleHatching Indicates the starting point of a pattern. It can be null, an IfcCartesianPoint, or a Handle to an IfcCartesianPoint. This property is defined in ifc-schema.ts. ```APIDOC PatternStart: null | IFC2X3.IfcCartesianPoint | Handle ``` -------------------------------- ### Web-IFC API Constructors and Properties Index Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcEvaporativeCoolerTypeEnum This section outlines the primary constructors and a comprehensive list of properties available within the Web-IFC API. It acts as a quick reference for the core components of the API. ```APIDOC Constructors: - constructor Properties: - DIRECTEVAPORATIVEAIRWASHER - DIRECTEVAPORATIVEPACKAGEDROTARYAIRCOOLER - DIRECTEVAPORATIVERANDOMMEDIAAIRCOOLER - DIRECTEVAPORATIVERIGIDMEDIAAIRCOOLER - DIRECTEVAPORATIVESLINGERSPACKAGEDAIRCOOLER - INDIRECTDIRECTCOMBINATION - INDIRECTEVAPORATIVECOOLINGTOWERORCOILCOOLER - INDIRECTEVAPORATIVEPACKAGEAIRCOOLER - INDIRECTEVAPORATIVEWETCOIL - NOTDEFINED - USERDEFINED ``` -------------------------------- ### IfcWorkPlan Constructor API Documentation Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC2X3.IfcWorkPlan Documents the constructor for the IfcWorkPlan class, detailing all required and optional parameters for instantiation and its return type. This constructor allows for the creation of a new IfcWorkPlan instance with comprehensive metadata. ```APIDOC IfcWorkPlan: constructor( GlobalId: IFC2X3.IfcGloballyUniqueId, OwnerHistory: IFC2X3.IfcOwnerHistory | Handle, Name: null | IFC2X3.IfcLabel, Description: null | IFC2X3.IfcText, ObjectType: null | IFC2X3.IfcLabel, Identifier: IFC2X3.IfcIdentifier, CreationDate: IfcDateTimeSelect, Creators: null | (IFC2X3.IfcPerson | Handle)[], Purpose: null | IFC2X3.IfcLabel, Duration: null | IFC2X3.IfcTimeMeasure, TotalFloat: null | IFC2X3.IfcTimeMeasure, StartTime: IfcDateTimeSelect, FinishTime: null | IfcDateTimeSelect, WorkControlType: null | IfcWorkControlTypeEnum, UserDefinedControlType: null | IFC2X3.IfcLabel ) Returns: IFC2X3.IfcWorkPlan ``` -------------------------------- ### Get expressID Property Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcMaterialProfileSetUsageTapering Retrieves the expressID property, a number with a default value of -1. This property is inherited from IfcMaterialProfileSetUsage. ```APIDOC expressID: number = -1 Inherited from IfcMaterialProfileSetUsage.expressID ``` -------------------------------- ### Web-IFC API Reference Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC2X3.IfcZone This snippet provides a structured overview of the Web-IFC API's main constructor and its available properties, as listed in the documentation's table of contents. ```APIDOC Web-IFC API Reference: Constructors: - constructor Properties: - Decomposes - Description - expressID - GlobalId - HasAssignments - HasAssociations - IsDecomposedBy - IsDefinedBy - IsGroupedBy - Name - ObjectType - OwnerHistory - type ``` -------------------------------- ### ScheduleStart Property Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4.IfcTaskTime Indicates the scheduled start time, which can be null or an IfcDateTime type from the IFC4 schema. This property is defined in ifc-schema.ts. ```APIDOC ScheduleStart: null | IFC4.IfcDateTime ``` -------------------------------- ### StartParam Property Definition Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4.IfcSweptDiskSolid Defines the starting parameter for an element. This property can be null or an IfcParameterValue, indicating a specific parameter value. ```APIDOC StartParam: null | IFC4.IfcParameterValue ``` -------------------------------- ### IfcHeatExchanger Constructor API Documentation Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4X3.IfcHeatExchanger Documents the constructor for the IfcHeatExchanger class, outlining all required and optional parameters for instantiation. It details the types for each parameter, including IFC4X3 schema types and Handle references, and specifies the return type as an IfcHeatExchanger instance. ```APIDOC new IfcHeatExchanger( GlobalId: IFC4X3.IfcGloballyUniqueId, OwnerHistory: null | IFC4X3.IfcOwnerHistory | Handle, Name: null | IFC4X3.IfcLabel, Description: null | IFC4X3.IfcText, ObjectType: null | IFC4X3.IfcLabel, ObjectPlacement: null | IFC4X3.IfcObjectPlacement | Handle, Representation: null | IFC4X3.IfcProductRepresentation | Handle, Tag: null | IFC4X3.IfcIdentifier, PredefinedType: null | IFC4X3.IfcHeatExchangerTypeEnum ): IFC4X3.IfcHeatExchanger Parameters: GlobalId: IFC4X3.IfcGloballyUniqueId OwnerHistory: null | IFC4X3.IfcOwnerHistory | Handle Name: null | IFC4X3.IfcLabel Description: null | IFC4X3.IfcText ObjectType: null | IFC4X3.IfcLabel ObjectPlacement: null | IFC4X3.IfcObjectPlacement | Handle Representation: null | IFC4X3.IfcProductRepresentation | Handle Tag: null | IFC4X3.IfcIdentifier PredefinedType: null | IFC4X3.IfcHeatExchangerTypeEnum Returns: IFC4X3.IfcHeatExchanger ``` -------------------------------- ### ScheduleStart Property Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4.IfcResourceTime Represents the scheduled start time. This property can be null or an IfcDateTime object from the IFC4 schema. It is defined in ifc-schema.ts. ```APIDOC ScheduleStart: null | IFC4.IfcDateTime ``` -------------------------------- ### IfcWindowStyle Constructor API Reference Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4.IfcWindowStyle Documents the constructor for the IfcWindowStyle class, outlining all parameters required for its instantiation, including their types and whether they are optional or mandatory. It also specifies the return type of the constructor. ```APIDOC new IfcWindowStyle( GlobalId: IFC4.IfcGloballyUniqueId, OwnerHistory: null | IFC4.IfcOwnerHistory | Handle, Name: null | IFC4.IfcLabel, Description: null | IFC4.IfcText, ApplicableOccurrence: null | IFC4.IfcIdentifier, HasPropertySets: null | (IFC4.IfcPropertySetDefinition | Handle)[], RepresentationMaps: null | (IFC4.IfcRepresentationMap | Handle)[], Tag: null | IFC4.IfcLabel, ConstructionType: IFC4.IfcWindowStyleConstructionEnum, OperationType: IFC4.IfcWindowStyleOperationEnum, ParameterTakesPrecedence: IFC4.IfcBoolean, Sizeable: IFC4.IfcBoolean ): IFC4.IfcWindowStyle ``` -------------------------------- ### IfcSystem Class API Reference Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC2X3.IfcSystem Detailed API documentation for the IfcSystem class, including its hierarchical structure, constructor signature with parameters and return type, and inherited properties with their types and origins. ```APIDOC Class: IfcSystem Hierarchy: - IFC2X3.IfcGroup - IfcSystem - IfcElectricalCircuit - IFC2X3.IfcStructuralAnalysisModel Constructors: constructor( GlobalId: IFC2X3.IfcGloballyUniqueId, OwnerHistory: IFC2X3.IfcOwnerHistory | Handle, Name: null | IFC2X3.IfcLabel, Description: null | IFC2X3.IfcText, ObjectType: null | IFC2X3.IfcLabel ): IFC2X3.IfcSystem Parameters: GlobalId: IFC2X3.IfcGloballyUniqueId OwnerHistory: IFC2X3.IfcOwnerHistory | Handle Name: null | IFC2X3.IfcLabel Description: null | IFC2X3.IfcText ObjectType: null | IFC2X3.IfcLabel Returns: IFC2X3.IfcSystem Overrides: IfcGroup.constructor Properties: Decomposes: null | (IFC2X3.IfcRelDecomposes | Handle)[] Inherited from: IfcGroup.Decomposes Description: null | IFC2X3.IfcText Inherited from: IfcGroup.Description expressID: number = -1 Inherited from: IfcGroup.expressID ``` -------------------------------- ### ActualStart Property Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4.IfcResourceTime Represents the actual start time. This property can be null or an IfcDateTime object from the IFC4 schema. It is defined in ifc-schema.ts. ```APIDOC ActualStart: null | IFC4.IfcDateTime ``` -------------------------------- ### IfcAPI Class Reference and Methods Source: https://thatopen.github.io/engine_web-ifc/docs/classes/web-ifc.IfcAPI Detailed API documentation for the IfcAPI class, including its constructor, properties, and a selection of methods for model handling and geometry creation. This reference outlines method signatures, parameters, return types, and brief descriptions. ```APIDOC class IfcAPI { constructor(): IfcAPI properties: Properties Description: Contains all the logic and methods regarding properties, psets, qsets, etc. methods: CloseModel(modelID: number): void Description: Closes a model and frees all related memory Parameters: modelID: number - Model handle retrieved by OpenModel, model must be closed after use CreateAABB(): any CreateAlignment(): any CreateArc(): any CreateBooleanOperator(): any CreateCircularSweep(): any CreateClothoid(): any } ``` -------------------------------- ### API Property: StartTime Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC2X3.IfcRegularTimeSeries Documents the 'StartTime' property, which specifies the start time using the IfcDateTimeSelect type. This property is inherited from IfcTimeSeries. ```APIDOC StartTime: IfcDateTimeSelect Inherited from IfcTimeSeries.StartTime ``` -------------------------------- ### Web-IFC API Constructors and Properties Overview Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC4.IfcPerformanceHistory This section outlines the primary constructors and properties exposed by the Web-IFC API. It acts as a quick reference or table of contents for navigating the detailed API documentation, indicating available members for objects within the library. ```APIDOC Web-IFC API Members: Constructors: - constructor Properties: - Controls - Declares - Decomposes - Description - expressID - GlobalId - HasAssignments - HasAssociations - HasContext - Identification - IsDeclaredBy - IsDecomposedBy - IsDefinedBy - IsNestedBy - IsTypedBy - LifeCyclePhase - Name - Nests - ObjectType - OwnerHistory - PredefinedType - type ``` -------------------------------- ### StartOfNextHatchLine Property Source: https://thatopen.github.io/engine_web-ifc/docs/classes/ifc-schema.IFC2X3.IfcFillAreaStyleHatching Specifies the starting point for the next hatch line, using an IfcHatchLineDistanceSelect type. This property is defined in ifc-schema.ts. ```APIDOC StartOfNextHatchLine: IFC2X3.IfcHatchLineDistanceSelect ```