andrewisen / bim-whale Goto Github PK

View Code? Open in Web Editor NEW

31.0 3.0 4.0 391 KB

A client-side IFC parser

Home Page: http://docs.bimvalen.se

License: MIT License

TypeScript 98.43% JavaScript 1.57%

ifc ifc2x3 bim cad revit parse parser javascript client bim-whale

bim-whale's Introduction

Hi there 👋

I'm currently working on:

IFC.js Web Worker Example - An IFC Viewer using Web Workers - A fork of IFC.js
The BIM Whale | BIMWHALE.js - A client-side IFC paser
Rock Grouting Toolkit - A toolkit for creating grouting graphs

People I Like:

Repos I Like:

Stuff I Like:

RegEx 101

bim-whale's People

Contributors

Stargazers

Watchers

Forkers

m8sa tomleelive linusjnilsson adityyyy

bim-whale's Issues

Convert UPPERCASE entities to PascalCase

Convert UPPERCASE entities to PascalCase.

Example: IFCPROPERTYSET becomes IfcPropertySet

This will match the IFC documentation and aid readability.

Update example site

The current example site is ugly and not very useful.

Roadmap

Things todo:

Improve parser (more specific parse-step-instance-attributes.ts)
Add support for IfcProductType
~~Add dist (JS Bundle File)~~
~~Add web example (using the dist)~~
Implement Web Workers
~~Add more samples~~
Update Docs/Wiki
Fix spelling/language
etc. etc

Will there be added features?

The parser is very simple... it doesn't do much. Will there be added features?

In short, no. The goal of this repo is to provide learning resources.
I do not intend to build "the best parser in the world".... not yet :)

Update documentation

Move documentation to https://andre-wisen.gitbook.io/bim-whale/

Implement Scandinavian string encoding

IFC uses ISO 8859-1.
The Swedish Wikipedia article has some good instructions.

Example: Ytterv\X2\00E4\X0\gg should be Yttervägg

Add Angular & React examples

Add how-to examples for Angular & React.
Consider adding proper NPM support.

JSON parse error

See #3 for more information!

$,$,(#194,#212) is parsed into [$,"$",["#194","#212"]], which is wrong.

Parse properties correctly

Current output:

{
  TypeMark: "IFCLABEL('20')",
  Keynote: "IFCLABEL('--KEYNOTE--')",
  StoreyName: "IFCTEXT('Level: Level 1')",
  TypeDescription: "IFCTEXT('--DESCRIPTION--')",
  StatusConstruction: "IFCLABEL('New Construction')",
  NetArea: "IFCAREAMEASURE(3.18957899999998)",
  Height: "IFCLENGTHMEASURE(2134.)",
  Width: "IFCLENGTHMEASURE(915.)",
  SillHeight: "IFCLENGTHMEASURE(0.)",
  Hyperlink: "IFCTEXT('--URL--')"
}

Remove IFCTEXT, IFCLABEL, etc.

Improve attribute parser method

The method _parseStepInstanceAttributes is very slow and ugly.

            .replace(/\\/g, "") // backward slashes
            .replace(/\//g, "\\/") // forward slashes
            .replace(/\"/g, '\\"') // quotation marks
            .replace(/[^,]\'\'[^\)]/g, "") // Apostrophes
            .replace(/(\(|\,)(\..+\.)(\)|\,?)/g, "$1'$2'$3") // ".T.", ".F.", ".UNDEFINED.", etc.
            .replace(
                /([A-Z]+\()'?([0-9a-åA-Ö-_\/({}),.%&@$:;+=?*"#<> ]*)'?\)/g,
                "'$1$2)'"
            ) // 1. Functions
            .replace(/(,\$)/g, ",'$$'") // 2. Indefinite attribute A
            .replace(/(\$,)/g, "'$$',") // 2. Indefinite attribute B
            .replace(/(^|,)\((#\d+.*?)\)/g, "$1[$2]") // 3. Nested attributes:
            .replace(/([,\[])(#\d+)+/g, "$1'$2'") // 4. References to other entities
            .replace(/,(\d+[.]\d*)/g, ",'$1'") // / 5. Integers
            .replace(/'/g, '"') + // Convert apostrophes to quotes

This needs to be replaced (!).

I will go back to the drawing board and think of a better solution.

Fix broken links

Fix the broken Docs & Demo links

Update IFC naming convention

The term entity instance is a bit confusing.

What is the difference between "entity", "instance" and "entity instance"?

For example, the method generateStepInstance( ) doesn't make that much sense.
Things become more chaotic when we introduce instanceId and entityName.

Try to update the IFC naming convention to make the code more readable.

Difficult properties to parse

Some IfcPropertySingleValue that are difficult to parse

'Type',$,IFCLABEL('Table-Night Stand: 24" x 24" x 30"'),$

'URL',$,IFCLABEL('http://www.website.com/anchor#!/800X800-1'),$

'SystemID',$,IFCLABEL('Piping System: KB03R'),$

'TypeDescription',$,IFCTEXT('Circular, smooth,R=D'),$

'AboveGround',$,IFCLOGICAL(.U.),$

'StoreyName',$,IFCTEXT('Level: 02 - Floor'),$

'Diameter',$,IFCPOSITIVELENGTHMEASURE(315.),$

'TypeDescription',$,IFCTEXT('K30, R\X2\00F6\X0\rsk\X2\00E5\X0\l mineralull ytbekl armerad al-folie difft\X2\00E4\X0\t'),$

'Render Appearance Properties',$,IFCTEXT('{2, 15},{39, RPC-16-FXGQ-QK7X-PJ74-6000-ST1L-LVER-AU},{1, 0},{1, 0},{2, 36},{1, 8},{5, Color},{1, 0},{1, 0},{3, 0.8},{3, 0.8},{3, 0.8},{1, 8},{7, BBoxMin},{1, 0},{1, 0},{1, 0},{1, 0},{1, 0},{1, 8},{7, BBoxMax},{1, 0},{1, 0},{1, 0},{1, 0},{1, 0},{2, 11},{9, RPCTypeId},{1, 0},{1, 0},{39, RPC-16-FXGQ-QK7X-PJ74-6000-ST1L-LVER-AU},{1, 6},{14, RPCPlantHeight},{1, 0},{1, 0},{7, 18.0446},{2, 11},{7, keyword},{1, 0},{1, 0},{140, :Geometry:RPC:Golden-chain :Laburnum:Laburnums are very small trees native to southern Europe.  The common cultivar in Canada is ''Watereri''.},{2, 11},{8, category},{1, 0},{1, 0},{16, :Trees [General]},{2, 11},{12, LocalizedUID},{1, 0},{1, 0},{13, Golden-chain },{2, 14},{6, Height},{1, 0},{1, 0},{7, 18.0446},{1, 2},{16, Cast Reflections},{1, 0},{1, 0},{1, 0},{1, 2},{12, Cast Shadows},{1, 0},{1, 0},{1, 1},{1, 2},{9, Lock View},{1, 0},{1, 0},{1, 0},{1, 4},{5, ViewC},{1, 0},{1, 0},{1, 0},{2, 11},{11, RPCFilePath},{1, 0},{1, 0},{99, C:\\RevitRender\\Version2015940\\2017\\assetlibrary_base.fbm\\RPCs\\ArchVision_Stills_T5_Golden_Chain.rpc},{2, 11},{20, AdvancedUIDefinition},{1, 0},{1, 0},{0, },{2, 11},{10, AssetLibID},{1, 0},{1, 0},{36, 4D3F6E72-3F99-4203-98E9-AF80B3C7A7A4},{2, 11},{10, BaseSchema},{1, 0},{1, 0},{9, RPCSchema},{2, 11},{12, ExchangeGUID},{1, 0},{1, 0},{0, },{1, 2},{6, Hidden},{1, 0},{1, 0},{1, 0},{1, 4},{11, RPCCategory},{1, 0},{1, 0},{1, 0},{2, 11},{8, RPCImage},{1, 0},{1, 0},{0, },{1, 4},{13, SchemaVersion},{1, 0},{1, 0},{1, 5},{2, 11},{12, UIDefinition},{1, 0},{1, 0},{0, },{2, 11},{6, UIName},{1, 0},{1, 0},{39, RPC-16-FXGQ-QK7X-PJ74-6000-ST1L-LVER-AU},{2, 11},{11, VersionGUID},{1, 0},{1, 0},{9, RPCSchema},{2, 11},{9, assettype},{1, 0},{1, 0},{11, RPCGeometry},{2, 11},{11, description},{1, 0},{1, 0},{0, },{2, 11},{9, localname},{1, 0},{1, 0},{3, RPC},{2, 11},{9, localtype},{1, 0},{1, 0},{3, RPC},{1, 4},{8, revision},{1, 0},{1, 0},{1, 1},{2, 11},{9, thumbnail},{1, 0},{1, 0},{0, },{1, 4},{7, version},{1, 0},{1, 0},{1, 1},{1, 2},{20, RPC_Cast Reflections},{1, 0},{1, 0},{1, 1},{1, 2},{16, RPC_Cast Shadows},{1, 0},{1, 0},{1, 1},{1, 2},{13, RPC_Lock View},{1, 0},{1, 0},{1, 0},{1, 4},{9, RPC_ViewC},{1, 0},{1, 0},{1, 0},{21, assetlibrary_base.fbx},{1, 5},'),$

 '2moeq0lkL9rx1tiYe2hZKW',#42,'Pipe Insulation:K30:11937246',$,'Pipe Insulation:K30',#1365555,#1367655,'11937246',.INSULATION.

Remove Deno

Deno is an unnecessary dependancy. Replace with a regular JS bundler.

Add test

Deno has built in testing.
Add a simple test to make development easier.