Overview
This node performs conversion of IFC (Industry Foundation Classes) files into different formats using an external IFC processing API. It is useful in scenarios where users need to transform building and construction data stored in IFC format for compatibility with other software or workflows, such as exporting architectural models, structural data, or plans into alternative file types.
Practical examples include:
- Converting an IFC model to a simplified geometry format for visualization.
- Exporting specific elements from an IFC file by including or excluding certain components.
- Generating plan views or model information selectively based on project requirements.
Properties
Name | Meaning |
---|---|
Input Filename | The name of the input IFC file to be converted. |
Output Filename | The desired name of the output file after conversion. |
Options | A collection of optional parameters to customize the conversion process: |
- Bounds | String specifying bounds to use during conversion. |
- Convert Back Units | Boolean indicating whether to convert back units during conversion. |
- Disable Opening Subtractions | Boolean to disable subtraction of openings during conversion. |
- Exclude | Comma-separated list of element names to exclude from the conversion. |
- Include | Comma-separated list of element names to include in the conversion. |
- Log File | Name of a log file to record conversion details. |
- Merge Boolean Operands | Boolean to merge boolean operands during conversion. |
- Model | Boolean indicating whether to include model information in the output. |
- Plan | Boolean indicating whether to include plan information in the output. |
- Sew Shells | Boolean to sew shells together during conversion. |
- Use World Coords | Boolean to use world coordinates instead of local coordinates. |
- Verbose | Boolean to enable verbose output during conversion. |
- Weld Vertices | Boolean to weld vertices during conversion. |
Output
The node outputs JSON data representing the result of the IFC conversion operation. This JSON typically contains metadata or status information returned by the external conversion API. The output is structured as an array of JSON objects, each corresponding to an input item processed.
If the conversion is successful, the output includes details about the converted file or conversion process. In case of errors, the output JSON will contain an error message describing the issue encountered.
The node does not directly output binary data; it relies on filenames specified in the input properties to handle file storage externally.
Dependencies
- Requires access to an external IFC pipeline API service that performs the actual file conversion.
- Requires configuration of an API authentication credential (e.g., an API key) to authorize requests to the IFC conversion service.
- The node sends HTTP POST requests to the
/ifcconvert
endpoint of the configured API.
Troubleshooting
Common issues:
- Incorrect input or output filename paths may cause the conversion to fail.
- Missing or invalid API credentials will prevent communication with the conversion service.
- Providing invalid options or malformed include/exclude lists can lead to errors.
Error messages:
- Errors returned from the API are captured and included in the output JSON under an
error
field. - If the node is set to continue on failure, it will output error details per item without stopping execution.
- Errors returned from the API are captured and included in the output JSON under an
Resolutions:
- Verify that input and output filenames are correct and accessible.
- Ensure the API credential is properly configured and valid.
- Double-check option values, especially comma-separated lists, for correct formatting.
Links and References
- IFC Specification
- IfcOpenShell Documentation (for understanding IFC processing)
- Refer to your IFC pipeline API provider's documentation for detailed usage and supported options.