PlanarSurfaceGroup Class Reference

#include "PlanarSurfaceGroup.hpp"

Inheritance diagram for openstudio::model::PlanarSurfaceGroup:

Public Member Functions
openstudio::BoundingBox	boundingBox () const
openstudio::Transformation	buildingTransformation () const
bool	changeTransformation (const openstudio::Transformation &transformation)
bool	setTransformation (const openstudio::Transformation &transformation)
openstudio::Transformation	siteTransformation () const
openstudio::Transformation	transformation () const
virtual	~PlanarSurfaceGroup ()
double	directionofRelativeNorth () const
bool	isDirectionofRelativeNorthDefaulted () const
double	xOrigin () const
bool	isXOriginDefaulted () const
double	yOrigin () const
bool	isYOriginDefaulted () const
double	zOrigin () const
bool	isZOriginDefaulted () const
bool	setDirectionofRelativeNorth (double directionofRelativeNorth)
void	resetDirectionofRelativeNorth ()
bool	setXOrigin (double xOrigin)
void	resetXOrigin ()
bool	setYOrigin (double yOrigin)
void	resetYOrigin ()
bool	setZOrigin (double zOrigin)
void	resetZOrigin ()

Protected Member Functions
	PlanarSurfaceGroup (IddObjectType iddObjectType, const Model &model)

Related Functions
typedef boost::optional < PlanarSurfaceGroup >	OptionalPlanarSurfaceGroup
typedef std::vector < PlanarSurfaceGroup >	PlanarSurfaceGroupVector

Detailed Description

PlanarSurfaceGroup is an abstract class representing a group that holds many PlanarSurfaces.

Constructor & Destructor Documentation

virtual openstudio::model::PlanarSurfaceGroup::~PlanarSurfaceGroup ( )

inlinevirtual

openstudio::model::PlanarSurfaceGroup::PlanarSurfaceGroup ( IddObjectType  iddObjectType, const Model &  model  )

explicitprotected

Member Function Documentation

openstudio::BoundingBox openstudio::model::PlanarSurfaceGroup::boundingBox

(

)

const

Get the BoundingBox in local coordinates.

openstudio::Transformation openstudio::model::PlanarSurfaceGroup::buildingTransformation

(

)

const

Returns the transformation from local coordinates to building coordinates.

bool openstudio::model::PlanarSurfaceGroup::changeTransformation

(

const openstudio::Transformation &

transformation

)

Changes the transformation from local coordinates to parent coordinates, this method alter geometry of children relative to the group so that it stays in the same place with the new transformation.

double openstudio::model::PlanarSurfaceGroup::directionofRelativeNorth

(

)

const

bool openstudio::model::PlanarSurfaceGroup::isDirectionofRelativeNorthDefaulted

(

)

const

bool openstudio::model::PlanarSurfaceGroup::isXOriginDefaulted

(

)

const

bool openstudio::model::PlanarSurfaceGroup::isYOriginDefaulted

(

)

const

bool openstudio::model::PlanarSurfaceGroup::isZOriginDefaulted

(

)

const

void openstudio::model::PlanarSurfaceGroup::resetDirectionofRelativeNorth

(

)

void openstudio::model::PlanarSurfaceGroup::resetXOrigin

(

)

void openstudio::model::PlanarSurfaceGroup::resetYOrigin

(

)

void openstudio::model::PlanarSurfaceGroup::resetZOrigin

(

)

bool openstudio::model::PlanarSurfaceGroup::setDirectionofRelativeNorth

(

double

directionofRelativeNorth

)

bool openstudio::model::PlanarSurfaceGroup::setTransformation

(

const openstudio::Transformation &

transformation

)

Sets the transformation from local coordinates to parent coordinates, this method can be used to move the group.

bool openstudio::model::PlanarSurfaceGroup::setXOrigin

(

double

xOrigin

)

bool openstudio::model::PlanarSurfaceGroup::setYOrigin

(

double

yOrigin

)

bool openstudio::model::PlanarSurfaceGroup::setZOrigin

(

double

zOrigin

)

openstudio::Transformation openstudio::model::PlanarSurfaceGroup::siteTransformation

(

)

const

Returns the transformation from local coordinates to site coordinates.

openstudio::Transformation openstudio::model::PlanarSurfaceGroup::transformation

(

)

const

Returns the transformation from local coordinates to parent coordinates.

double openstudio::model::PlanarSurfaceGroup::xOrigin

(

)

const

double openstudio::model::PlanarSurfaceGroup::yOrigin

(

)

const

double openstudio::model::PlanarSurfaceGroup::zOrigin

(

)

const

Friends And Related Function Documentation

typedef boost::optional<PlanarSurfaceGroup> OptionalPlanarSurfaceGroup

related

typedef std::vector<PlanarSurfaceGroup> PlanarSurfaceGroupVector

related