openstudiocoalition / openstudio-sketchup-plugin

The OpenStudio SketchUp Plug-in is an extension to Trimble’s popular 3D modeling tool that adds OpenStudio context to the SketchUp program.

Important!

After the v1.0.0 final NREL software distribution (04/27/2020), the OpenStudio SketchUp Plug-in is now independently supported and maintained with open source contributions by The OpenStudio Coalition and members of the software community at the GitHub repository https://github.com/openstudiocoalition/openstudio-sketchup-plugin. The NREL OpenStudio SketchUp Plug-in repository no longer accepts new issues or pull requests. Please submit new issues or enhancement requests in the new OpenStudio Coalition repository at https://github.com/openstudiocoalition/openstudio-sketchup-plugin/issues.

The OpenStudio SketchUp Plug-in depends on the OpenStudio Application, follow the instructions at https://openstudiocoalition.org/getting_started/getting_started/ to install the OpenStudio Application first and then install the OpenStudio SketchUp Plug-in. After installing a new version of the OpenStudio Application, the OpenStudio SketchUp Plug-in can be configured to use the new OpenStudio Application version by pointing to the new installation directory using the OpenStudio SketchUp Plug-in's Preferences menu. The OpenStudio SketchUp Plug-in version compatibility-matrix details the versions of SketchUp, OpenStudio Application, and OpenStudio SketchUp Plug-in that are compatible with each other.

OpenStudio SketchUp Plug-in

The OpenStudio SketchUp Plug-in is an extension to Trimble’s popular 3D modeling tool that adds OpenStudio context to the SketchUp program. The Plug-in allows users to quickly create geometry needed for OpenStudio using the built-in functionality of Trimble SketchUp including existing drawing tools, integration with Google Earth, Building Maker, and Photo Match.

openstudio-sketchup-plugin's Issues

Diagnostic script does not remove orphan surfaces

Clean up dialogs and menus

• Add reset OpenStudio Application Directory (requires restart)
• Update About
• Update Help
• Update Preferences
• Update Preferences->Check for Update
• Add Preferences->OpenStudio App Dir
• Remove Preferences->Text Editor Path
• Remove Preferences->EnergyPlus Path
• Remove Preferences->Template

Diagnostic script should test that sub surface points are within base surface

Surface Search can fail after copying surface group objects (Bugzilla #1066)

Expose Surface/SubSurface Properties When Rendering by Construction

OpenStudio SketchUp Plug-in doesn't work in SketchUp 2021

OpenStudio Application v1.1.0 is based on OpenStudio 3.1.0 which is built using Ruby 2.5.5. SketchUp 2021 upgraded to Ruby 2.7.1 which is incompatible with Ruby 2.5.5. There is an enhancement request to upgrade OpenStudio's Ruby version to 2.7.1 for a future release.

Allow editing multiple elements of same type withinin SketchUp plugin

Project Loose Geometry doesn't work when just done on select vs. all loose surfaces

OpenStudio Inspector does not recognize Imported EnergyPlus Idf Constructions and Schedules

There are 2 features involved here. To access them:

• Extensions/OpenStudio/Import/Import EnergyPlus Idf Constructions
• Extensions/OpenStudio/Import/Import EnergyPlus Idf Schedules

After importing Constructions and Schedules from EnergyPlus Idfs, the number of OS:DefaultConstructionSet and OS:DefaultScheduleSet within the OpenStudio Inspector does not increase.

This issue is present within the Mac and Windows versions of the Plugin.

Bad URL comes up on first launch of SketchUp plugin

SpaceTypeAndConstructionSetWizard should warn user if data is missing

SketchUp Plugin can't handle rectangular room with filled in C shaped surfaces

PluginUserScriptRunner::result not cleared between runs

Run AddShadingControls with no args, will return false

Run AddZoneToSpaces, will return false even though it completes successfully

OpenStudio::Plugin.user_script_runner.result

License is still at 2019

Release Template - Clone for each release

• Release Notes
• Test Windows Installer
• Test Mac Installer
• Post to SketchUp Extension Warehouse
• Email Blast

Path to OpenStudio Application is incorrect

When I click in "Launch Openstudio" a message appears : " Windows couldn´t find \OpensStudioApp"....

https://unmethours.com/question/41430/openstudio-100-pre-1-installation-problem/?comment=41561#post-id-41561

Check For Updates Functionality Does Not Execute

The Check For Updates feature should return a dialogue box that reveals if there is/isn't a new update. To access this feature: Extensions/OpenStudio/Check For Update. Nothing happens after one clicks Check For Update. This issue is present within both the Windows and Mac Versions of the Plugin.

Running WWR user script in plugin on edge to edge walls breaks model

Plug-in crashes on startup

Reported at https://unmethours.com/question/45992/openstudio-sketchup-plugin-error-trouble-installing-plugin/

Sign extension and distribute in extension warehouse

• Set up developer on extension warehouse
• Change author in extension rb
• Conform to rubocop-sketchup

SketchUp Plugin keeps flipping vertical roof surface

Surfaces incorrectly matched after extrude and intersect of matched surface

SketchUp Import Schedules - Hardcode path prevents accessing schedules in app

"Link OSM and SketchUp File" Functionality Failure

The SketchUp Plug-in Interface Guide describes an avenue to link a SketchUp File with its OSM counterpart. To do this, save the (opened) OpenStudio Model, then save the SketchUp Model. To test the functionality, close Sketchup, find the SketchUp Model, and double click to open it.

After SketchUp launches, the User receives an error message that reads, "Removing previously linked OpenStudio content". I also noticed that, when I launch the SketchUp App by opening a SketchUp Model, the Extensions Menu (which is associated with the Plugin) does not load with SketchUp.

This issue is present within the Mac and Windows versions of the Plugin.

Diagnostic script does not remove subsurfaces not contained by its base surface

Update OpenStudio SketchUp Plug-in Wiki - Add version compatibility info, update build docs, remove dead pages

Run measures from inside SketchUp plugin

Surface Search for non-convex shading surfaces is failing on user model

OpenStudio Inspector does not recognised a "copied and pasted" Glare Sensor

In order to create a new object, a User can typically copy and paste an existing object. When an existing Glare Sensor is copied and pasted, the resulting new Glare Sensor is not recognized by the OpenStudio Inspector. The resulting error message reads, "Unknown object of type OpenStudio::GlareSensor added". This issue is present within both the Windows and Mac versions of the Plugin.

On scanning the OpenStudio Inspector, I realized that the name of the object type for a Glare Sensor is OpenStudio:Glare:Sensor. This contradicts the name of the object type for a pasted Glare Sensor, OpenStudio::GlareSensor. The location of the second colon within both names differ. I believe this discrepancy triggers this error.

SketchUp RuntimeError: bad_weak_ptr

I've experienced the following error in the OS 2.6.0 and 2.8.0 SketchUp plugin with SketchUp 2018. The error occurs after importing a DXF into SU and before creating OpenStudio geometry.

SketchUp 2018.skp.txt

Error: #<RuntimeError: bad_weak_ptr>
C:/openstudio-2.8.0/SketchUpPlugin/openstudio/sketchup_plugin/lib/interfaces/RenderingColor.rb:197:in `rebuildInspectorGadget'
C:/openstudio-2.8.0/SketchUpPlugin/openstudio/sketchup_plugin/lib/interfaces/RenderingColor.rb:197:in `update_entity'
C:/openstudio-2.8.0/SketchUpPlugin/openstudio/sketchup_plugin/lib/interfaces/DrawingInterface.rb:173:in `draw_entity'
C:/openstudio-2.8.0/SketchUpPlugin/openstudio/sketchup_plugin/lib/interfaces/ModelInterface.rb:944:in `block in attach_openstudio_model'
C:/openstudio-2.8.0/SketchUpPlugin/openstudio/sketchup_plugin/lib/interfaces/ModelInterface.rb:942:in `each'
C:/openstudio-2.8.0/SketchUpPlugin/openstudio/sketchup_plugin/lib/interfaces/ModelInterface.rb:942:in `each_with_index'
C:/openstudio-2.8.0/SketchUpPlugin/openstudio/sketchup_plugin/lib/interfaces/ModelInterface.rb:942:in `attach_openstudio_model'
C:/openstudio-2.8.0/SketchUpPlugin/openstudio/sketchup_plugin/lib/ModelManager.rb:227:in `attach_openstudio_model'
C:/openstudio-2.8.0/SketchUpPlugin/openstudio/sketchup_plugin/lib/ModelManager.rb:177:in `open_openstudio'
C:/openstudio-2.8.0/SketchUpPlugin/openstudio/sketchup_plugin/lib/ModelManager.rb:142:in `new_from_path'
C:/openstudio-2.8.0/SketchUpPlugin/openstudio/sketchup_plugin/lib/ModelManager.rb:117:in `new_from_skp_model'
C:/openstudio-2.8.0/SketchUpPlugin/openstudio/sketchup_plugin/lib/observers/AppObserver.rb:63:in `onOpenModel'

Template files missing default constructions

Template files for the SketchUp plug-in seem to be missing default glass door, overhead door, and skylight constructions. Also missing TDD constructions in some cases. May be an issue in the upstream https://github.com/NREL/openstudio-standards. Causes simulations to fail which might be troubling for new users

Plant Component Setpoint Operation Scheme

The source code in the latest release rbz file is not the source code for that release

If you cross check the rbz contents with the zip contents from the same release, you will find they are very different. It is almost like an old rbz file was uploaded. I noticed this when attempting to use the "Create spaces from diagram" dialog, and eventually figuring out that old source code is being use, in particular source code that was attempting to reference "Sketchup::Face" constant, but instead was referencing "Face" causing the constant to resolve to the "OpenStudio" module and therefore not be found. See SpaceDiagramInterface.rb for an example of discrepancies between the rbz contents and the zip/master source contents.

OpenStudio plugin crashes Sketchup on Mac

Hi guys,

I installed Sketchup Studio 2019 and followed the installation steps here for installing the Openstudio plugin. However, when I click ok on the dialog box that appears for Openstudio Root that is automatically populated with /Applications/OpenStudioApplication-1.1.0, Sketchup crashes every single time, and the BugsplatReporter window shows up instead.

Here's how my Application folder looks like:

$ ls /Applications/                            
Autodesk			Microsoft Excel.app		Microsoft Teams.app		OpenStudioApp			SketchUp 2019			Utilities
GarageBand.app			Microsoft OneNote.app		Microsoft Word.app		OpenStudioApplication-1.1.0	Skype.app			WhatsApp.app
Honey.app			Microsoft Outlook.app		Numbers.app			Pages.app			Slack.app			iMovie.app
Keynote.app			Microsoft PowerPoint.app	OneDrive.app			Safari.app			Spotify.app			zoom.us.app

How do I debug why I can't get the extension to load up?

Additional information:
OS: macOS Catalina
Sketchup version: tried it with both 2019 and 2020 with the same result

OS SketchUp Plug-in’s Luminaire Tool

The OS SketchUp Plug-in’s Luminaire Tool functionality is no longer working when using the toolbar and this appears to be deliberate as the ability to create load “definitions” (people/lights/equipment) was removed from the SketchUp Plugin.

This may have been forgotten to remove from the toolbar? If so, it can be safely removed.

Copy and paste daylighting controls, glare sensors, illuminance maps does not work (Bugzilla #1218)

SketchUp plugin classifies doors as windows when pasting geometry in space

Bring over docs and scripts from OpenStudio?

https://github.com/NREL/OpenStudio/blob/1773b54ce1cb660818ac0114dd7eefae6639ca36/SketchUpInstallName.rb

https://github.com/NREL/OpenStudio/blob/1773b54ce1cb660818ac0114dd7eefae6639ca36/developer/ruby/OpenStudioSketchUpPluginRDoc.rb

https://github.com/NREL/OpenStudio/blob/1773b54ce1cb660818ac0114dd7eefae6639ca36/developer/doc/Building%20and%20Testing%20OpenStudio.md#sketchup-extension-signature

cf NREL/OpenStudio#4058

MisMatch of Vertices for Surface-Matched Surfaces

This vertex mismatch error is very common where matched surfaces are comprised of more that four vertices:

** Severe ** RoofCeiling:Detailed="SURFACE ???", Vertex size mismatch between base surface :SURFACE ??? and outside boundary surface: SURFACE ???

I suspect Sketchup defines a surface not just based on its component vertices, but also shared vertices. So, for example, if two surfaces have a shared vertex, only one of the surfaces will have that vertex in its definition. The other surface will be missing the vertex in it's definition.

Here is a detailed video of the problem and work-around I developed to resolve the issue: https://1drv.ms/v/s!AseQmgZxffwzgbN01VYhYjiIjfhXaQ?e=62GZTC

When I split matched surfaces all both new surfaces still match the same surface

1.1.0 OpenStudio SketchUp Plug-in Release

• Release Notes
• Test Windows Installer
• Test Mac Installer
• Test Linux Installer
• Email Blast

intersecting tool - loses surface (Bugzilla #1215)

SketchUp auto-save may clobber changes made in the app

OpenStudio Inspector does not support Imported Space Loads

The OpenStudio Inspector does not support Space Loads. Hence, a User cannot access imported Space Loads (Extensions/OpenStudio/Import/Import Space Loads). The issue is present within both the Mac and Windows versions of the Plugin.

Will this feature be removed from menu options, or will the OpenStudio Inspector be updated to support Space Loads?

When I split a matched surfaces, both new surfaces are now matched to a single surface in another group (Bugzilla #1232)

Inersect in SketchUp (is producing duplicate surface and sub-surface not contained by base)

Error Message - "Failed to import SDD file"

The Import SDD Model feature fails. To access this feature: Extensions/OpenStudio/Import/Import SDD Model. This issue is present within the Mac and Windows versions of the Plugin.

Model does not display in SketchUp

Model provided by @eringold (in issues repo) does not display in SketchUp when loaded. Double clicking spaces in the inspector causes the geometry to be shown. My guess is something is crashing silently when opening the file so that the sketchup entities are not created

Plugin and diagnostic script not catch all degenerate surfaces

No Hover Data Returned For OpenStudio Tools bar Icons

Hovering over icons on tool bars typically reveals the corresponding names of each icon. This is not the case for the OpenStudio Tools bar icons. This issue is only present within the Mac Version of the Plugin.