#include "IlluminanceMap.hpp"
Static Public Member Functions | |
static IddObjectType | iddObjectType () |
Related Functions | |
typedef std::vector < IlluminanceMap > | IlluminanceMapVector |
typedef boost::optional < IlluminanceMap > | OptionalIlluminanceMap |
IlluminanceMap is a SpaceItem and is an interface to the OpenStudio IDD object named "OS:IlluminanceMap".
IlluminanceMap is a child of the Space object and is used to report daylighting illuminance values over a grid. The grid of points to calculate daylight illuminance over is defined by the minimum and maximum corners of a rectangle aligned with the parent Space's coordinate system.
|
explicit |
|
inlinevirtual |
std::vector<Point3d> openstudio::model::IlluminanceMap::corners | ( | ) | const |
Returns a vector of the 4 corner reference points in the calculation grid in illuminance map coordinates.
The points returned are [0, yLength, 0], [0, 0, 0], [xLength, 0, 0], [xLength, yLength, 0] To get the points in space coordinates use transformation * referencePoints
|
static |
bool openstudio::model::IlluminanceMap::isNumberofXGridPointsDefaulted | ( | ) | const |
bool openstudio::model::IlluminanceMap::isNumberofYGridPointsDefaulted | ( | ) | const |
bool openstudio::model::IlluminanceMap::isPhiRotationAroundZAxisDefaulted | ( | ) | const |
bool openstudio::model::IlluminanceMap::isPsiRotationAroundXAxisDefaulted | ( | ) | const |
bool openstudio::model::IlluminanceMap::isThetaRotationAroundYAxisDefaulted | ( | ) | const |
bool openstudio::model::IlluminanceMap::isXLengthDefaulted | ( | ) | const |
bool openstudio::model::IlluminanceMap::isYLengthDefaulted | ( | ) | const |
int openstudio::model::IlluminanceMap::numberofXGridPoints | ( | ) | const |
int openstudio::model::IlluminanceMap::numberofYGridPoints | ( | ) | const |
double openstudio::model::IlluminanceMap::originXCoordinate | ( | ) | const |
double openstudio::model::IlluminanceMap::originYCoordinate | ( | ) | const |
double openstudio::model::IlluminanceMap::originZCoordinate | ( | ) | const |
double openstudio::model::IlluminanceMap::phiRotationAroundZAxis | ( | ) | const |
double openstudio::model::IlluminanceMap::psiRotationAroundXAxis | ( | ) | const |
std::vector<Point3d> openstudio::model::IlluminanceMap::referencePoints | ( | ) | const |
Returns a vector of all the reference points in the calculation grid in illuminance map coordinates.
The points are returned in order such as [0, 0, 0], ..., [xLength, 0, 0], [0, yLength/numberofYGridPoints, 0], ..., [xLength, yLength, 0] To get the points in space coordinates use transformation * referencePoints
void openstudio::model::IlluminanceMap::resetNumberofXGridPoints | ( | ) |
void openstudio::model::IlluminanceMap::resetNumberofYGridPoints | ( | ) |
void openstudio::model::IlluminanceMap::resetPhiRotationAroundZAxis | ( | ) |
void openstudio::model::IlluminanceMap::resetPsiRotationAroundXAxis | ( | ) |
void openstudio::model::IlluminanceMap::resetThetaRotationAroundYAxis | ( | ) |
void openstudio::model::IlluminanceMap::resetXLength | ( | ) |
void openstudio::model::IlluminanceMap::resetYLength | ( | ) |
bool openstudio::model::IlluminanceMap::setNumberofXGridPoints | ( | int | numberofXGridPoints | ) |
bool openstudio::model::IlluminanceMap::setNumberofYGridPoints | ( | int | numberofYGridPoints | ) |
void openstudio::model::IlluminanceMap::setOriginXCoordinate | ( | double | originXCoordinate | ) |
void openstudio::model::IlluminanceMap::setOriginYCoordinate | ( | double | originYCoordinate | ) |
void openstudio::model::IlluminanceMap::setOriginZCoordinate | ( | double | originZCoordinate | ) |
bool openstudio::model::IlluminanceMap::setPhiRotationAroundZAxis | ( | double | phiRotationAroundZAxis | ) |
bool openstudio::model::IlluminanceMap::setPsiRotationAroundXAxis | ( | double | psiRotationAroundXAxis | ) |
bool openstudio::model::IlluminanceMap::setThetaRotationAroundYAxis | ( | double | thetaRotationAroundYAxis | ) |
bool openstudio::model::IlluminanceMap::setTransformation | ( | const openstudio::Transformation & | transformation | ) |
Set the transformation from illuminance map coordinates to space coordinates.
void openstudio::model::IlluminanceMap::setXLength | ( | double | xLength | ) |
void openstudio::model::IlluminanceMap::setYLength | ( | double | yLength | ) |
double openstudio::model::IlluminanceMap::thetaRotationAroundYAxis | ( | ) | const |
openstudio::Transformation openstudio::model::IlluminanceMap::transformation | ( | ) | const |
Get the transformation from illuminance map coordinates to space coordinates.
double openstudio::model::IlluminanceMap::xLength | ( | ) | const |
double openstudio::model::IlluminanceMap::yLength | ( | ) | const |
|
related |
|
related |