OpenStudio:model
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | List of all members
openstudio::model::ThreeJSReverseTranslator Class Reference

#include <ThreeJSReverseTranslator.hpp>

Public Member Functions

std::vector< LogMessage > errors () const
 Get error messages generated by the last translation. More...
 
std::map< UUID, UUID > handleMapping () const
 Mapping between handles referenced in ThreeScene (keys) and handles of objects in returned model (values) for last translation This handle mapping can be used by the ModelMerger when merging returned model (new handles) with an existing model (existing handles) More...
 
boost::optional< ModelmodelFromThreeJS (const ThreeScene &scene)
 Convert a ThreeJs Scene to OpenStudio Model format, scene must be in OpenStudio format. More...
 
 ThreeJSReverseTranslator ()
 
std::vector< LogMessage > warnings () const
 Get warning messages generated by the last translation. More...
 

Detailed Description

ThreeJSReverseTranslator converts a ThreeJS JSON to OpenStudio Model.

There are two variations of the ThreeJS format, this translator requires that the ThreeJS JSON be in OpenStudio Model format rather than optimized for display.

After conversion a map of handles from the ThreeJS JSON to new handles in the returned OpenStudio Model can be retreived. This map is useful if merging the translated OpenStudio Model with an existing OpenStudio Model.

Constructor & Destructor Documentation

openstudio::model::ThreeJSReverseTranslator::ThreeJSReverseTranslator ( )

Member Function Documentation

std::vector<LogMessage> openstudio::model::ThreeJSReverseTranslator::errors ( ) const

Get error messages generated by the last translation.

std::map<UUID, UUID> openstudio::model::ThreeJSReverseTranslator::handleMapping ( ) const

Mapping between handles referenced in ThreeScene (keys) and handles of objects in returned model (values) for last translation This handle mapping can be used by the ModelMerger when merging returned model (new handles) with an existing model (existing handles)

boost::optional<Model> openstudio::model::ThreeJSReverseTranslator::modelFromThreeJS ( const ThreeScene &  scene)

Convert a ThreeJs Scene to OpenStudio Model format, scene must be in OpenStudio format.

std::vector<LogMessage> openstudio::model::ThreeJSReverseTranslator::warnings ( ) const

Get warning messages generated by the last translation.