openstudio::ThreeModelObjectMetadata Class Reference

#include <ThreeJS.hpp>

Public Member Functions
boost::optional< double >	aboveCeilingPlenumHeight () const
	applies to Story or Space
boost::optional< double >	belowFloorPlenumHeight () const
	applies to Story or Space
std::string	color () const
boost::optional< double >	floorToCeilingHeight () const
	applies to Story or Space
std::string	handle () const
std::string	iddObjectType () const
boost::optional< unsigned >	multiplier () const
	applies to Story or Space
std::string	name () const
boost::optional< double >	nominalZCoordinate () const
	applies to Story
bool	openToBelow () const
	applies to Space
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

ThreeModelObjectMetadata() [1/2]

openstudio::ThreeModelObjectMetadata::ThreeModelObjectMetadata

(

)

ThreeModelObjectMetadata() [2/2]

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

Member Function Documentation

aboveCeilingPlenumHeight()

boost::optional< double > openstudio::ThreeModelObjectMetadata::aboveCeilingPlenumHeight

(

)

const

applies to Story or Space

belowFloorPlenumHeight()

boost::optional< double > openstudio::ThreeModelObjectMetadata::belowFloorPlenumHeight

(

)

const

applies to Story or Space

color()

std::string openstudio::ThreeModelObjectMetadata::color

(

)

const

floorToCeilingHeight()

boost::optional< double > openstudio::ThreeModelObjectMetadata::floorToCeilingHeight

(

)

const

applies to Story or Space

handle()

std::string openstudio::ThreeModelObjectMetadata::handle

(

)

const

iddObjectType()

std::string openstudio::ThreeModelObjectMetadata::iddObjectType

(

)

const

multiplier()

boost::optional< unsigned > openstudio::ThreeModelObjectMetadata::multiplier

(

)

const

applies to Story or Space

name()

std::string openstudio::ThreeModelObjectMetadata::name

(

)

const

nominalZCoordinate()

boost::optional< double > openstudio::ThreeModelObjectMetadata::nominalZCoordinate

(

)

const

applies to Story

openToBelow()

bool openstudio::ThreeModelObjectMetadata::openToBelow

(

)

const

applies to Space

resetAboveCeilingPlenumHeight()

void openstudio::ThreeModelObjectMetadata::resetAboveCeilingPlenumHeight

(

)

resetBelowFloorPlenumHeight()

void openstudio::ThreeModelObjectMetadata::resetBelowFloorPlenumHeight

(

)

resetColor()

void openstudio::ThreeModelObjectMetadata::resetColor

(

)

resetFloorToCeilingHeight()

void openstudio::ThreeModelObjectMetadata::resetFloorToCeilingHeight

(

)

resetMultiplier()

void openstudio::ThreeModelObjectMetadata::resetMultiplier

(

)

resetNominalZCoordinate()

void openstudio::ThreeModelObjectMetadata::resetNominalZCoordinate

(

)

resetOpenToBelow()

void openstudio::ThreeModelObjectMetadata::resetOpenToBelow

(

)

setAboveCeilingPlenumHeight()

bool openstudio::ThreeModelObjectMetadata::setAboveCeilingPlenumHeight

(

double

height

)

setBelowFloorPlenumHeight()

bool openstudio::ThreeModelObjectMetadata::setBelowFloorPlenumHeight

(

double

height

)

setColor()

bool openstudio::ThreeModelObjectMetadata::setColor

(

const std::string &

c

)

setFloorToCeilingHeight()

bool openstudio::ThreeModelObjectMetadata::setFloorToCeilingHeight

(

double

height

)

setMultiplier()

bool openstudio::ThreeModelObjectMetadata::setMultiplier

(

unsigned

mult

)

setNominalZCoordinate()

bool openstudio::ThreeModelObjectMetadata::setNominalZCoordinate

(

double

z

)

setOpenToBelow()

bool openstudio::ThreeModelObjectMetadata::setOpenToBelow

(

bool

t

)