Base struct class for Canopy parameters. More...

#include <CanopyGenerator.h>

Inheritance diagram for BaseCanopyParameters:

Public Member Functions
	BaseCanopyParameters ()
	Default constructor.

	BaseCanopyParameters (const pugi::xml_node canopy_node)

void	readParametersFromXML (const pugi::xml_node canopy_node)
	Sets canopy parameters from the given XML node.

virtual void	buildPlant (CanopyGenerator &canopy_generator, helios::vec3 origin)=0
	Makes the given Canopy generator build a single plant of our canopy type with our parameters at the given position.

virtual void	buildCanopy (CanopyGenerator &canopy_generator)=0
	Makes the given Canopy generator build a canopy of our type with our parameters.

Data Fields
helios::vec3	canopy_origin
	Cartesian (x,y,z) coordinate of the bottom center point of the canopy (i.e., specifying z=0 places the bottom surface of the canopy at z=0).

float	canopy_rotation
	Azimuthal rotation of the canopy about the canopy origin. Note that if canopy_rotation is not equal to zero, the plant_spacing and plant_count parameters are defined in the x- and y-directions before rotation.

Detailed Description

Base struct class for Canopy parameters.

Definition at line 25 of file CanopyGenerator.h.

Constructor & Destructor Documentation

◆ BaseCanopyParameters() [1/2]

BaseCanopyParameters::BaseCanopyParameters ( )

Default constructor.

Definition at line 28 of file CanopyGenerator.cpp.

◆ BaseCanopyParameters() [2/2]

BaseCanopyParameters::BaseCanopyParameters ( const pugi::xml_node canopy_node )

Parameters

[in] canopy_node XML node containing the canopy parameters

Definition at line 33 of file CanopyGenerator.cpp.

Member Function Documentation

◆ buildCanopy()

virtual void BaseCanopyParameters::buildCanopy ( CanopyGenerator & canopy_generator )

pure virtual

Makes the given Canopy generator build a canopy of our type with our parameters.

Implemented in HomogeneousCanopyParameters, SphericalCrownsCanopyParameters, ConicalCrownsCanopyParameters, BaseGrapeVineParameters, VSPGrapevineParameters, SplitGrapevineParameters, UnilateralGrapevineParameters, GobletGrapevineParameters, WhiteSpruceCanopyParameters, TomatoParameters, StrawberryParameters, WalnutCanopyParameters, SorghumCanopyParameters, and BeanParameters.

◆ buildPlant()

virtual void BaseCanopyParameters::buildPlant	(	CanopyGenerator &	canopy_generator,
		helios::vec3	origin
	)

pure virtual

Makes the given Canopy generator build a single plant of our canopy type with our parameters at the given position.

Implemented in HomogeneousCanopyParameters, SphericalCrownsCanopyParameters, ConicalCrownsCanopyParameters, BaseGrapeVineParameters, VSPGrapevineParameters, SplitGrapevineParameters, UnilateralGrapevineParameters, GobletGrapevineParameters, WhiteSpruceCanopyParameters, TomatoParameters, StrawberryParameters, WalnutCanopyParameters, SorghumCanopyParameters, and BeanParameters.

◆ readParametersFromXML()

void BaseCanopyParameters::readParametersFromXML ( const pugi::xml_node canopy_node )

Sets canopy parameters from the given XML node.

Parameters

[in] canopy_node XML node containing the canopy parameters

Definition at line 37 of file CanopyGenerator.cpp.

Field Documentation

◆ canopy_origin

helios::vec3 BaseCanopyParameters::canopy_origin

Cartesian (x,y,z) coordinate of the bottom center point of the canopy (i.e., specifying z=0 places the bottom surface of the canopy at z=0).

Definition at line 50 of file CanopyGenerator.h.

◆ canopy_rotation

float BaseCanopyParameters::canopy_rotation

Azimuthal rotation of the canopy about the canopy origin. Note that if canopy_rotation is not equal to zero, the plant_spacing and plant_count parameters are defined in the x- and y-directions before rotation.

Definition at line 53 of file CanopyGenerator.h.

The documentation for this struct was generated from the following files:

plugins/canopygenerator/include/CanopyGenerator.h
plugins/canopygenerator/src/CanopyGenerator.cpp

Public Member Functions

Data Fields