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

#include <ThreeJS.hpp>

Public Member Functions

boost::optional< double > aboveCeilingPlenumHeight () const
 applies to Story or Space More...
 
boost::optional< double > belowFloorPlenumHeight () const
 applies to Story or Space More...
 
std::string color () const
 
boost::optional< double > floorToCeilingHeight () const
 applies to Story or Space More...
 
std::string handle () const
 
std::string iddObjectType () const
 
boost::optional< unsigned > multiplier () const
 applies to Story or Space More...
 
std::string name () const
 
boost::optional< double > nominalZCoordinate () const
 applies to Story More...
 
bool openToBelow () const
 applies to Space More...
 
void resetAboveCeilingPlenumHeight ()
 
void resetBelowFloorPlenumHeight ()
 
void resetColor ()
 
void resetFloorToCeilingHeight ()
 
void resetMultiplier ()
 
void resetNominalZCoordinate ()
 
void resetOpenToBelow ()
 
bool setAboveCeilingPlenumHeight (double height)
 
bool setBelowFloorPlenumHeight (double height)
 
bool setColor (const std::string &c)
 
bool setFloorToCeilingHeight (double height)
 
bool setMultiplier (unsigned mult)
 
bool setNominalZCoordinate (double z)
 
bool setOpenToBelow (bool t)
 
 ThreeModelObjectMetadata ()
 
 ThreeModelObjectMetadata (const std::string &iddObjectType, const std::string &handle, const std::string &name)
 

Detailed Description

ThreeModelObjectMetadata includes metadata about an OpenStudio ModelObject not associated with a ThreeSceneChild in the ThreeJS scene.

Constructor & Destructor Documentation

openstudio::ThreeModelObjectMetadata::ThreeModelObjectMetadata ( )
openstudio::ThreeModelObjectMetadata::ThreeModelObjectMetadata ( const std::string &  iddObjectType,
const std::string &  handle,
const std::string &  name 
)

Member Function Documentation

boost::optional<double> openstudio::ThreeModelObjectMetadata::aboveCeilingPlenumHeight ( ) const

applies to Story or Space

boost::optional<double> openstudio::ThreeModelObjectMetadata::belowFloorPlenumHeight ( ) const

applies to Story or Space

std::string openstudio::ThreeModelObjectMetadata::color ( ) const
boost::optional<double> openstudio::ThreeModelObjectMetadata::floorToCeilingHeight ( ) const

applies to Story or Space

std::string openstudio::ThreeModelObjectMetadata::handle ( ) const
std::string openstudio::ThreeModelObjectMetadata::iddObjectType ( ) const
boost::optional<unsigned> openstudio::ThreeModelObjectMetadata::multiplier ( ) const

applies to Story or Space

std::string openstudio::ThreeModelObjectMetadata::name ( ) const
boost::optional<double> openstudio::ThreeModelObjectMetadata::nominalZCoordinate ( ) const

applies to Story

bool openstudio::ThreeModelObjectMetadata::openToBelow ( ) const

applies to Space

void openstudio::ThreeModelObjectMetadata::resetAboveCeilingPlenumHeight ( )
void openstudio::ThreeModelObjectMetadata::resetBelowFloorPlenumHeight ( )
void openstudio::ThreeModelObjectMetadata::resetColor ( )
void openstudio::ThreeModelObjectMetadata::resetFloorToCeilingHeight ( )
void openstudio::ThreeModelObjectMetadata::resetMultiplier ( )
void openstudio::ThreeModelObjectMetadata::resetNominalZCoordinate ( )
void openstudio::ThreeModelObjectMetadata::resetOpenToBelow ( )
bool openstudio::ThreeModelObjectMetadata::setAboveCeilingPlenumHeight ( double  height)
bool openstudio::ThreeModelObjectMetadata::setBelowFloorPlenumHeight ( double  height)
bool openstudio::ThreeModelObjectMetadata::setColor ( const std::string &  c)
bool openstudio::ThreeModelObjectMetadata::setFloorToCeilingHeight ( double  height)
bool openstudio::ThreeModelObjectMetadata::setMultiplier ( unsigned  mult)
bool openstudio::ThreeModelObjectMetadata::setNominalZCoordinate ( double  z)
bool openstudio::ThreeModelObjectMetadata::setOpenToBelow ( bool  t)