Public Member Functions
void	updateSpectra ()
	Function to update spectra based on saved information.

void	updateCameras ()
	Function to update cameras based on saved information.

void	record ()
	Function to "record", or save camera images with bounding boxes for each rig.

void	buildFromXML ()
	Function to build context from XML.

void	buildFromXML (std::string xml_input_file)
	Function to build context from XML.

void	visualize ()
	Function to visualize XML plot.

void	buildAndVisualize ()
	Function to build and visualize XML simulation.

void	buildAndVisualize (std::string xml_input_file)
	Function to build and visualize XML simulation.

void	xmlSetValues ()
	Function to set all values in GUI from XML.

void	xmlSetValues (std::string xml_path)
	Function to set all values in GUI from XML.

void	xmlGetValues ()
	Function to get all values from current XML.

void	xmlGetValues (std::string xml_input_file)
	Function to get all values from current XML.

std::map< std::string, int >	getNodeLabels (const std::string &label_name, const std::string &node_name, std::vector< std::string > &labels_vec)
	Function to get node labels for a given set of nodes.

void	getKeypoints (const std::string &name, const std::string &field, std::vector< std::vector< int > > &keypoints)
	Function to get keypoints for every rig.

void	setKeypoints (const std::string &name, const std::string &field, std::vector< std::vector< int > > &keypoints)
	Function to set keypoints for every rig.

void	xmlGetValue (const std::string &name, const std::string &parent, int &default_value)
	Function to get value of an XML field.

void	xmlGetValue (const std::string &name, const std::string &parent, float &default_value)
	Function to get value of an XML field.

void	xmlGetValue (const std::string &name, const std::string &parent, std::string &default_value)
	Function to get value of an XML field.

void	xmlGetValue (const std::string &name, const std::string &parent, helios::vec2 &default_value)
	Function to get value of an XML field.

void	xmlGetValue (const std::string &name, const std::string &parent, helios::vec3 &default_value)
	Function to get value of an XML field.

void	xmlGetValue (const std::string &name, const std::string &parent, helios::int2 &default_value)
	Function to get value of an XML field.

void	xmlGetDistribution (const std::string &name, const std::string &parent, distribution &distribution)
	Function to get distribution from an XML field.

void	xmlSetDistribution (const std::string &name, const std::string &parent, distribution &distribution)
	Function to set distribution from an XML field.

void	xmlGetValues (const std::string &name, const std::string &parent, std::vector< helios::vec2 > &default_vec)
	Function to get values of an XML field.

void	xmlGetValues (const std::string &name, const std::string &parent, std::vector< helios::vec3 > &default_vec)
	Function to get values of an XML field.

void	xmlGetValues (const std::string &name, const std::string &parent, std::vector< helios::int2 > &default_vec)
	Function to get values of an XML field.

void	xmlGetValues (const std::string &name, const std::string &parent, std::vector< std::string > &default_vec)
	Function to get values of an XML field.

void	xmlGetValues (const std::string &name, const std::string &parent, std::vector< float > &default_vec)
	Function to get values of an XML field.

void	xmlGetValues (const std::string &name, const std::string &parent, std::vector< int > &default_vec)
	Function to get values of an XML field.

void	xmlGetValues (const std::string &name, const std::string &parent, std::vector< helios::RGBcolor > &default_vec)
	Function to get values of an XML field.

void	xmlGetValues (const std::string &name, const std::string &parent, std::vector< std::vector< helios::vec3 > > &default_vec)
	Function to get values of an XML field.

void	xmlGetValues (const std::string &name, const std::string &parent, std::vector< std::set< std::string > > &default_vec)
	Function to get values of an XML field.

void	xmlGetValues (const std::string &name, const std::string &parent, std::set< std::string > &default_set)
	Function to get values of an XML field.

void	xmlRemoveField (const std::string &name, const std::string &parent)
	Function to remove XML field in the XML file.

void	xmlSetValue (const std::string &name, const std::string &parent, int &default_value)
	Function to set value of an XML field in the XML file.

void	xmlSetValue (const std::string &name, const std::string &parent, float &default_value)
	Function to set value of an XML field in the XML file.

void	xmlSetValue (const std::string &name, const std::string &parent, std::string &default_value)
	Function to set value of an XML field in the XML file.

void	xmlSetValue (const std::string &name, const std::string &parent, helios::vec2 &default_value)
	Function to set value of an XML field in the XML file.

void	xmlSetValue (const std::string &name, const std::string &parent, helios::vec3 &default_value)
	Function to set value of an XML field in the XML file.

void	xmlSetValue (const std::string &name, const std::string &parent, helios::int2 &default_value)
	Function to set value of an XML field in the XML file.

void	xmlSetValues (const std::string &field_name, const std::string &node_name, std::vector< helios::vec2 > &values_vec, std::map< std::string, int > &node_map)
	Function to set values to an XML field.

void	xmlSetValues (const std::string &field_name, const std::string &node_name, std::vector< helios::vec3 > &values_vec, std::map< std::string, int > &node_map)
	Function to set values to an XML field.

void	xmlSetValues (const std::string &field_name, const std::string &node_name, std::vector< helios::int2 > &values_vec, std::map< std::string, int > &node_map)
	Function to set values to an XML field.

void	xmlSetValues (const std::string &field_name, const std::string &node_name, std::vector< std::string > &values_vec, std::map< std::string, int > &node_map)
	Function to set values to an XML field.

void	xmlSetValues (const std::string &field_name, const std::string &node_name, std::vector< int > &values_vec, std::map< std::string, int > &node_map)
	Function to set values to an XML field.

void	xmlSetValues (const std::string &field_name, const std::string &node_name, std::vector< float > &values_vec, std::map< std::string, int > &node_map)
	Function to set values to an XML field.

void	xmlSetValues (const std::string &field_name, const std::string &node_name, std::vector< helios::RGBcolor > &values_vec, std::map< std::string, int > &node_map)
	Function to set values to an XML field.

void	xmlSetValues (const std::string &field_name, const std::string &node_name, std::vector< std::vector< helios::vec3 > > &values_vec, std::map< std::string, int > &node_map)
	Function to set values to an XML field.

void	xmlSetValues (const std::string &field_name, const std::string &node_name, std::vector< std::set< std::string > > &values_vec, std::map< std::string, int > &node_map)
	Function to set values to an XML field.

void	xmlSetValues (const std::string &field_name, const std::string &node_name, std::set< std::string > &values_set)
	Function to set values to an XML field.

void	setNodeLabels (const std::string &label_name, const std::string &node_name, std::set< std::string > &labels_set)
	Function to set node labels for a given set of nodes.

void	randomizePopup (std::string popup_name, taggedPtr ptr)

void	noisePopup (std::string popup_name, std::vector< distribution > &dist_vec)

void	applyDistribution (std::string var_name, taggedPtr ptr)
	Function to apply random distribution to a variable.

void	applyDistribution (std::string var_name, distribution dist, taggedPtr ptr)
	Function to apply random distribution to a variable.

void	randomize (bool randomize_all)
	Function to randomize variables that have assigned distributions.

void	randomizerParams (std::string var_name)

void	sample (std::string var_name)
	Set value of variable with random sample from respective distribution.

void	sampleAll ()
	Set value of all variables using random samples from their respective distributions.

void	outputConsole ()

void	updateColor (std::string curr_obj, std::string obj_type, float *new_color)
	Update color of object, rig, etc.

void	updateObject (std::string curr_obj)
	Update object in visualizer (e.g. position, orientation, scale, color, etc.)

void	updateRigs ()
	Update rig in visualizer (e.g. rig position, arrow count, arrow color, arrow direction, etc.)

void	deleteRig (std::string curr_rig)
	Delete rig.

void	dropDown (std::string widget_name, std::string &selected, std::vector< std::string > choices)

void	dropDown (std::string widget_name, std::string &selected, std::set< std::string > choices)

void	refreshVisualization ()

void	refreshVisualizationTypes ()

void	recordPopup ()

void	updateLocation ()
	Update location.

void	updateGround ()
	Update ground.

void	deleteGround ()
	Delete ground.

void	updateContext ()
	Update context.

std::string	shortenPath (std::string path_name)
	Shorten absolute path to file name.

void	setBoundingBoxObjects ()
	Set object_number primitive data for.

void	buildTiledGround (const helios::vec3 &ground_origin, const helios::vec2 &ground_extent, const helios::int2 &texture_subtiles, const helios::int2 &texture_subpatches, const char *ground_texture_file, float ground_rotation)
	Build a ground with azimuthal rotation consisting of texture sub-tiles and sub-patches, which can be different sizes (from `buildGround` Canopy Generator plugin)

void	buildTiledGround (const helios::vec3 &ground_origin, const helios::vec2 &ground_extent, const helios::int2 &texture_subtiles, const helios::int2 &texture_subpatches, helios::RGBcolor ground_color, float ground_rotation)
	Build a ground with azimuthal rotation consisting of texture sub-tiles and sub-patches, which can be different sizes (from `buildGround` Canopy Generator plugin)

	ProjectBuilder ()
	Constructor.

	~ProjectBuilder ()
	Destructor.

Static Public Member Functions
static int	selfTest (int argc=0, char **argv=nullptr)
	Method to run through automated tests.

Data Fields
helios::Context *	context = nullptr
	Context.

Visualizer *	visualizer = nullptr
	Visualizer.

PlantArchitecture *	plantarchitecture = nullptr
	Plant Architecture.

CanopyGenerator *	canopygenerator = nullptr
	Canopy Generator.

RadiationModel *	radiation = nullptr
	Radiation Model.

SolarPosition *	solarposition = nullptr
	Solar Position.

EnergyBalanceModel *	energybalancemodel = nullptr
	Energy Balance Model.

BLConductanceModel *	boundarylayerconductance = nullptr
	Boundary Layer Conductance.

CameraProperties *	cameraproperties = nullptr
	Camera Properties.

Detailed Description

Definition at line 269 of file ProjectBuilder.h.

Constructor & Destructor Documentation

◆ ProjectBuilder()

ProjectBuilder::ProjectBuilder ( )

inline

Constructor.

Definition at line 1820 of file ProjectBuilder.h.

◆ ~ProjectBuilder()

ProjectBuilder::~ProjectBuilder ( )

inline

Destructor.

Definition at line 1859 of file ProjectBuilder.h.

Member Function Documentation

◆ applyDistribution() [1/2]

void ProjectBuilder::applyDistribution	(	std::string	var_name,
		distribution	dist,
		taggedPtr	ptr
	)

Function to apply random distribution to a variable.

Parameters

[in]	var_name	Name of the variable being randomized
[in]	dist	Distribution to be applied
[in]	ptr	Pointer to the variable to be randomized

Definition at line 5496 of file ProjectBuilder.cpp.

◆ applyDistribution() [2/2]

void ProjectBuilder::applyDistribution	(	std::string	var_name,
		taggedPtr	ptr
	)

Function to apply random distribution to a variable.

Parameters

[in]	var_name	Name of the variable being randomized
[in]	ptr	Pointer to the variable to be randomized

Definition at line 5468 of file ProjectBuilder.cpp.

◆ buildAndVisualize() [1/2]

void ProjectBuilder::buildAndVisualize ( )

Function to build and visualize XML simulation.

Definition at line 4314 of file ProjectBuilder.cpp.

◆ buildAndVisualize() [2/2]

void ProjectBuilder::buildAndVisualize ( std::string xml_input_file )

Function to build and visualize XML simulation.

Parameters

[in] xml_input_file Name of XML input file

Definition at line 4308 of file ProjectBuilder.cpp.

◆ buildFromXML() [1/2]

void ProjectBuilder::buildFromXML ( )

Function to build context from XML.

Definition at line 816 of file ProjectBuilder.cpp.

◆ buildFromXML() [2/2]

void ProjectBuilder::buildFromXML ( std::string xml_input_file )

Function to build context from XML.

Parameters

[in] xml_input_file Name of XML input file

Definition at line 1063 of file ProjectBuilder.cpp.

◆ buildTiledGround() [1/2]

void ProjectBuilder::buildTiledGround	(	const helios::vec3 &	ground_origin,
		const helios::vec2 &	ground_extent,
		const helios::int2 &	texture_subtiles,
		const helios::int2 &	texture_subpatches,
		const char *	ground_texture_file,
		float	ground_rotation
	)

Build a ground with azimuthal rotation consisting of texture sub-tiles and sub-patches, which can be different sizes (from buildGround Canopy Generator plugin)

Parameters

[in]	ground_origin	x-, y-, and z-position of the ground center point.
[in]	ground_extent	Width of the ground in the x- and y-directions.
[in]	texture_subtiles	Number of sub-divisions of the ground into texture map tiles in the x- and y-directions.
[in]	texture_subpatches	Number of sub-divisions of each texture tile into sub-patches in the x- and y-directions.
[in]	ground_texture_file	Path to file used for tile texture mapping.
[in]	ground_rotation	Azimuthal rotation angle of ground in radians.

Definition at line 6142 of file ProjectBuilder.cpp.

◆ buildTiledGround() [2/2]

void ProjectBuilder::buildTiledGround	(	const helios::vec3 &	ground_origin,
		const helios::vec2 &	ground_extent,
		const helios::int2 &	texture_subtiles,
		const helios::int2 &	texture_subpatches,
		helios::RGBcolor	ground_color,
		float	ground_rotation
	)

Build a ground with azimuthal rotation consisting of texture sub-tiles and sub-patches, which can be different sizes (from buildGround Canopy Generator plugin)

Parameters

[in]	ground_origin	x-, y-, and z-position of the ground center point.
[in]	ground_extent	Width of the ground in the x- and y-directions.
[in]	texture_subtiles	Number of sub-divisions of the ground into texture map tiles in the x- and y-directions.
[in]	texture_subpatches	Number of sub-divisions of each texture tile into sub-patches in the x- and y-directions.
[in]	ground_color	Ground color.
[in]	ground_rotation	Azimuthal rotation angle of ground in radians.

Definition at line 6177 of file ProjectBuilder.cpp.

◆ deleteGround()

void ProjectBuilder::deleteGround ( )

Delete ground.

Definition at line 6066 of file ProjectBuilder.cpp.

◆ deleteRig()

void ProjectBuilder::deleteRig ( std::string curr_rig )

Delete rig.

Parameters

[in] curr_rig Rig to be deleted

Definition at line 5815 of file ProjectBuilder.cpp.

◆ dropDown() [1/2]

void ProjectBuilder::dropDown	(	std::string	widget_name,
		std::string &	selected,
		std::set< std::string >	choices
	)

Definition at line 5860 of file ProjectBuilder.cpp.

◆ dropDown() [2/2]

void ProjectBuilder::dropDown	(	std::string	widget_name,
		std::string &	selected,
		std::vector< std::string >	choices
	)

Definition at line 5856 of file ProjectBuilder.cpp.

◆ getKeypoints()

void ProjectBuilder::getKeypoints	(	const std::string &	name,
		const std::string &	field,
		std::vector< std::vector< int > > &	keypoints
	)

Function to get keypoints for every rig.

Parameters

[in]	name	Name of the label (e.g. name="keypoint")
[in]	field	Name of the XML fields to get labels from (e.g. field="camera_position")
[out]	keypoints	Vector of keypoint (int) vectors

Definition at line 1087 of file ProjectBuilder.cpp.

◆ getNodeLabels()

std::map< std::string, int > ProjectBuilder::getNodeLabels	(	const std::string &	label_name,
		const std::string &	node_name,
		std::vector< std::string > &	labels_vec
	)

Function to get node labels for a given set of nodes.

Parameters

[in]	label_name	Name of the label
[in]	node_name	Name of the XML nodes to get labels from
[out]	labels_vec	Vector of labels of XML "parent" nodes

Definition at line 1069 of file ProjectBuilder.cpp.

◆ noisePopup()

void ProjectBuilder::noisePopup	(	std::string	popup_name,
		std::vector< distribution > &	dist_vec
	)

Definition at line 5462 of file ProjectBuilder.cpp.

◆ outputConsole()

void ProjectBuilder::outputConsole ( )

Definition at line 5696 of file ProjectBuilder.cpp.

◆ randomize()

void ProjectBuilder::randomize ( bool randomize_all )

Function to randomize variables that have assigned distributions.

Parameters

[in] randomize_all If true, randomize all variables. Else, only randomize those with selection "randomize for every image".

Definition at line 5526 of file ProjectBuilder.cpp.

◆ randomizePopup()

void ProjectBuilder::randomizePopup	(	std::string	popup_name,
		taggedPtr	ptr
	)

Definition at line 5365 of file ProjectBuilder.cpp.

◆ randomizerParams()

void ProjectBuilder::randomizerParams ( std::string var_name )

Definition at line 5612 of file ProjectBuilder.cpp.

◆ record()

void ProjectBuilder::record ( )

Function to "record", or save camera images with bounding boxes for each rig.

Definition at line 684 of file ProjectBuilder.cpp.

◆ recordPopup()

void ProjectBuilder::recordPopup ( )

Definition at line 5992 of file ProjectBuilder.cpp.

◆ refreshVisualization()

void ProjectBuilder::refreshVisualization ( )

Definition at line 5977 of file ProjectBuilder.cpp.

◆ refreshVisualizationTypes()

void ProjectBuilder::refreshVisualizationTypes ( )

Definition at line 6099 of file ProjectBuilder.cpp.

◆ sample()

void ProjectBuilder::sample ( std::string var_name )

Set value of variable with random sample from respective distribution.

Parameters

[in] var_name Variable to generate a random variable for

Definition at line 5617 of file ProjectBuilder.cpp.

◆ sampleAll()

void ProjectBuilder::sampleAll ( )

Set value of all variables using random samples from their respective distributions.

Definition at line 5671 of file ProjectBuilder.cpp.

◆ selfTest()

int ProjectBuilder::selfTest	(	int	argc = `0`,
		char **	argv = `nullptr`
	)

static

Method to run through automated tests.

Definition at line 18 of file selfTest.cpp.

◆ setBoundingBoxObjects()

void ProjectBuilder::setBoundingBoxObjects ( )

Set object_number primitive data for.

Definition at line 6120 of file ProjectBuilder.cpp.

◆ setKeypoints()

void ProjectBuilder::setKeypoints	(	const std::string &	name,
		const std::string &	field,
		std::vector< std::vector< int > > &	keypoints
	)

Function to set keypoints for every rig.

Parameters

[in]	name	Name of the label (e.g. name="keypoint")
[in]	field	Name of the XML fields to get labels from (e.g. field="camera_position")
[out]	keypoints	Vector of keypoint (int) vectors

Definition at line 1110 of file ProjectBuilder.cpp.

◆ setNodeLabels()

void ProjectBuilder::setNodeLabels	(	const std::string &	label_name,
		const std::string &	node_name,
		std::set< std::string > &	labels_set
	)

Function to set node labels for a given set of nodes.

Parameters

[in]	label_name	Name of the label
[in]	node_name	Name of the XML nodes to get labels from
[out]	labels_set	Set of labels of XML "parent" nodes to set

Definition at line 1560 of file ProjectBuilder.cpp.

◆ shortenPath()

std::string ProjectBuilder::shortenPath ( std::string path_name )

Shorten absolute path to file name.

Parameters

[in] path_name Absolute path to be shortened

Definition at line 6105 of file ProjectBuilder.cpp.

◆ updateCameras()

void ProjectBuilder::updateCameras ( )

Function to update cameras based on saved information.

Definition at line 647 of file ProjectBuilder.cpp.

◆ updateColor()

void ProjectBuilder::updateColor	(	std::string	curr_obj,
		std::string	obj_type,
		float *	new_color
	)

Update color of object, rig, etc.

Parameters

[in]	curr_obj	Object to update the color of
[in]	obj_type	Object type (options: object, rig, arrow, or camera)
[in]	new_color	New color represented by float[3]

Definition at line 5701 of file ProjectBuilder.cpp.

◆ updateContext()

void ProjectBuilder::updateContext ( )

Update context.

Definition at line 5659 of file ProjectBuilder.cpp.

◆ updateGround()

void ProjectBuilder::updateGround ( )

Update ground.

Definition at line 6007 of file ProjectBuilder.cpp.

◆ updateLocation()

void ProjectBuilder::updateLocation ( )

Update location.

Definition at line 5998 of file ProjectBuilder.cpp.

◆ updateObject()

void ProjectBuilder::updateObject ( std::string curr_obj )

Update object in visualizer (e.g. position, orientation, scale, color, etc.)

Parameters

[in] curr_obj Object to update

Definition at line 5746 of file ProjectBuilder.cpp.

◆ updateRigs()

void ProjectBuilder::updateRigs ( )

Update rig in visualizer (e.g. rig position, arrow count, arrow color, arrow direction, etc.)

Definition at line 5802 of file ProjectBuilder.cpp.

◆ updateSpectra()

void ProjectBuilder::updateSpectra ( )

Function to update spectra based on saved information.

Definition at line 532 of file ProjectBuilder.cpp.

◆ visualize()

void ProjectBuilder::visualize ( )

Function to visualize XML plot.

Definition at line 1868 of file ProjectBuilder.cpp.

◆ xmlGetDistribution()

void ProjectBuilder::xmlGetDistribution	(	const std::string &	name,
		const std::string &	parent,
		distribution &	distribution
	)

Function to get distribution from an XML field.

Parameters

[in]	name	Name of the XML field
[in]	parent	Name of the parent XML node
[out]	distribution	Distribution if one is provided for name in the XML file

Definition at line 1243 of file ProjectBuilder.cpp.

◆ xmlGetValue() [1/6]

void ProjectBuilder::xmlGetValue	(	const std::string &	name,
		const std::string &	parent,
		float &	default_value
	)

Function to get value of an XML field.

Parameters

[in]	name	Name of the XML field
[in]	parent	Name of the parent XML node
[out]	default_value	Field value if one exists

Definition at line 1146 of file ProjectBuilder.cpp.

◆ xmlGetValue() [2/6]

void ProjectBuilder::xmlGetValue	(	const std::string &	name,
		const std::string &	parent,
		helios::int2 &	default_value
	)

Function to get value of an XML field.

Parameters

[in]	name	Name of the XML field
[in]	parent	Name of the parent XML node
[out]	default_value	Field value if one exists

Definition at line 1222 of file ProjectBuilder.cpp.

◆ xmlGetValue() [3/6]

void ProjectBuilder::xmlGetValue	(	const std::string &	name,
		const std::string &	parent,
		helios::vec2 &	default_value
	)

Function to get value of an XML field.

Parameters

[in]	name	Name of the XML field
[in]	parent	Name of the parent XML node
[out]	default_value	Field value if one exists

Definition at line 1183 of file ProjectBuilder.cpp.

◆ xmlGetValue() [4/6]

void ProjectBuilder::xmlGetValue	(	const std::string &	name,
		const std::string &	parent,
		helios::vec3 &	default_value
	)

Function to get value of an XML field.

Parameters

[in]	name	Name of the XML field
[in]	parent	Name of the parent XML node
[out]	default_value	Field value if one exists

Definition at line 1203 of file ProjectBuilder.cpp.

◆ xmlGetValue() [5/6]

void ProjectBuilder::xmlGetValue	(	const std::string &	name,
		const std::string &	parent,
		int &	default_value
	)

Function to get value of an XML field.

Parameters

[in]	name	Name of the XML field
[in]	parent	Name of the parent XML node
[out]	default_value	Field value if one exists

Definition at line 1126 of file ProjectBuilder.cpp.

◆ xmlGetValue() [6/6]

void ProjectBuilder::xmlGetValue	(	const std::string &	name,
		const std::string &	parent,
		std::string &	default_value
	)

Function to get value of an XML field.

Parameters

[in]	name	Name of the XML field
[in]	parent	Name of the parent XML node
[out]	default_value	Field value if one exists

Definition at line 1167 of file ProjectBuilder.cpp.

◆ xmlGetValues() [1/12]

void ProjectBuilder::xmlGetValues ( )

Function to get all values from current XML.

Definition at line 4547 of file ProjectBuilder.cpp.