Skip to content

ladybug-tools/spider-gbxml-viewers-for-openstudio

Repository files navigation

You are now in a GitHub source code view - click this link to view Read Me file as a web page

Spider gbXML Viewers for OpenStudio

Source code and help for Spider gbXML Viewers included with NREL's OpenStudio program.

The following files are a work-in-progress and not yet available in a working version of OpenStudio.

  • File: embeddable_gbxml_editor.html
  • Nothing happens when you load this file because init() and animate() required by Three.js are disabled so they may first called by the app doing the hosting - in this case from within OpenStudio.

Features

This file is living proof that the Spider code is viable in workflows based on mature and complex systems.

  • Load gbXML files in a speedy fashion
  • Display in real-time interactive 3D
  • Click on a surface to view a subset of its data
  • Adjust opacity and reset to home view
  • Toggle
    • Rotation
    • Wireframe view
    • Axes
    • Bounding box
    • Edges
  • View file statistics
  • Sliding menu

Usage

In order to test "embeddable_gbxml_editor.html" files with OpenStudio, copy a file into the bin folder of your OpenStudio installation. Start a new session and the file will appear the next time you invoke the gbXML Viewer from the geometry tab.

See the OpenStudio Advanced Tutorial Working with gbXML for more details.

  • Lots of fun here

  • Popup viewer embedded in an Iframe
  • Allows you to test the runnable version of 'embeddable_gbxml_editor.html' outside of OpebStudio
  • Buttons load drawings via iframe.contentWindow.GBX.parseFile( gbxml-text );
  • The script that gathers the source code files, glues them together and allows you to save the single file to disk

OpenStudio Requirements / 2019-09-02

From email sent by Dan Macumber

  • Our app users may not be online so we need the JavaScript dependencies to be directly copy/pasted into the html rather than loaded online
  • We don’t want example files because that might confuse the users (e.g. wait that’s not my model, what’s happening?)
  • We don’t yet support a workflow where the user could fix the file in the app so we would want to hide the fixer menus
  • We need some type of method (e.g. setGbXml) that I can call from the app to pass in our gbXML file as a string

This is where the application currently initializes the gbXML viewer and passes in the file as a string to the setGbXml method. I am happy to change that method name if needed, for your testing with the current version of the app it is expecting the method setGbXml.

Links of interest

gbXML Home Page

gbXML is an industry supported schema for sharing building information between disparate building design software tools.

gbXML GitHub Presence

Repositories for all things gbXML including the schema, validator source code, test cases, and a fork of the Spider gbXML Viewer

gbXML Schema as a document

Schema GreenBuildingXML_Ver6.01.xsd / the core definition of gbXML in a format that is easier to read than the source code.

More gbXML References

The Green Building XML schema (gbXML) is an open schema developed to facilitate transfer of building data stored in Building Information Models (BIM) to engineering analysis tools. gbXML is being integrated into a range of software CAD and engineering tools and supported by leading 3D BIM vendors. gbXML is streamlined to transfer building properties to and from engineering analysis tools to reduce the interoperability issues and eliminate plan take-off time.

  • https://twitter.com/gbXML
  • The gbXML open schema helps facilitate the transfer of building properties stored in 3D building information models (BIM) to engineering analysis tools.

DOE / NREL / OpenStudio

OpenStudio User Docs / Advanced Tutorials / Working with gbXML

gbXML is an industry supported file format for sharing building information between disparate building design software tools. The OpenStudio Application can import and export gbXML files through the File->Import and File->Export menus.

NREL include a very basic version of the Spider gbXML Viewer in current releases of OpenStudio. The Ladybug Tools / Spider team is proud to be included in the project and makes best efforts to support users.

Screen capture NREL tutorial on Spider gbXML Viewer running in OpenStudio 2.8.0

Get old Chromium builds

For older versions of Chromium

See also ChromiumPortable_45.0.2453.0.paf.exe.txt file in assets folder. Drop the '.txt' at the end of the file name.

Using Chromium ~r45

  • Do not use let or const
  • Do not use default function parameters