Parameters defining the bean plant canopy. More...

#include <CanopyGenerator.h>

Inheritance diagram for BeanParameters:

Public Member Functions
	BeanParameters ()
	Default constructor.

	BeanParameters (const pugi::xml_node canopy_node)

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

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

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

Public Member Functions inherited from BaseCanopyParameters
	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.

Data Fields
float	leaf_length
	Maximum width of leaves.

helios::int2	leaf_subdivisions
	Number of sub-division segments per leaf.

std::string	leaf_texture_file
	Path to texture map file for leaves.

helios::RGBcolor	shoot_color
	Color of shoots.

int	shoot_subdivisions
	Number of radial subdivisions for shoot tubes.

float	stem_radius
	Radius of main stem at base.

float	stem_length
	Length of stems before splitting to leaflets.

float	leaflet_length
	Length of the leaflet from base to tip leaf.

float	plant_spacing
	Spacing between adjacent plants along the row direction.

float	row_spacing
	Spacing between plant rows.

helios::int2	plant_count
	Number of crowns/plants in the x- and y-directions.

float	germination_probability
	Probability that a plant in the canopy germinated.

float	pod_length
	Length of bean pods.

helios::RGBcolor	pod_color
	Color of bean pods.

uint	pod_subdivisions
	Number of lengthwise subdivisions making up pods.

Data Fields inherited from BaseCanopyParameters
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

Parameters defining the bean plant canopy.

Definition at line 969 of file CanopyGenerator.h.

Constructor & Destructor Documentation

◆ BeanParameters() [1/2]

BeanParameters::BeanParameters ( )

Default constructor.

Definition at line 1755 of file CanopyGenerator.cpp.

◆ BeanParameters() [2/2]

BeanParameters::BeanParameters ( const pugi::xml_node canopy_node )

Parameters

[in] canopy_node XML node containing the canopy parameters

Definition at line 1788 of file CanopyGenerator.cpp.

Member Function Documentation

◆ buildCanopy()

void BeanParameters::buildCanopy ( CanopyGenerator & canopy_generator )

overridevirtual

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

Implements BaseCanopyParameters.

Definition at line 1875 of file CanopyGenerator.cpp.

◆ buildPlant()

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

overridevirtual

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

Implements BaseCanopyParameters.

Definition at line 1871 of file CanopyGenerator.cpp.

◆ readParametersFromXML()

void BeanParameters::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 1792 of file CanopyGenerator.cpp.

Field Documentation

◆ germination_probability

float BeanParameters::germination_probability

Probability that a plant in the canopy germinated.

Definition at line 1025 of file CanopyGenerator.h.

◆ leaf_length

float BeanParameters::leaf_length

Maximum width of leaves.

Definition at line 992 of file CanopyGenerator.h.

◆ leaf_subdivisions

helios::int2 BeanParameters::leaf_subdivisions

Number of sub-division segments per leaf.

Definition at line 995 of file CanopyGenerator.h.

◆ leaf_texture_file

std::string BeanParameters::leaf_texture_file

Path to texture map file for leaves.

Definition at line 998 of file CanopyGenerator.h.

◆ leaflet_length

float BeanParameters::leaflet_length

Length of the leaflet from base to tip leaf.

Definition at line 1013 of file CanopyGenerator.h.

◆ plant_count

helios::int2 BeanParameters::plant_count

Number of crowns/plants in the x- and y-directions.

Definition at line 1022 of file CanopyGenerator.h.

◆ plant_spacing

float BeanParameters::plant_spacing

Spacing between adjacent plants along the row direction.

Definition at line 1016 of file CanopyGenerator.h.

◆ pod_color

helios::RGBcolor BeanParameters::pod_color

Color of bean pods.

Definition at line 1031 of file CanopyGenerator.h.

◆ pod_length

float BeanParameters::pod_length

Length of bean pods.

Definition at line 1028 of file CanopyGenerator.h.

◆ pod_subdivisions

uint BeanParameters::pod_subdivisions

Number of lengthwise subdivisions making up pods.

Definition at line 1034 of file CanopyGenerator.h.

◆ row_spacing

float BeanParameters::row_spacing

Spacing between plant rows.

Definition at line 1019 of file CanopyGenerator.h.

◆ shoot_color

helios::RGBcolor BeanParameters::shoot_color

Color of shoots.

Definition at line 1001 of file CanopyGenerator.h.

◆ shoot_subdivisions

int BeanParameters::shoot_subdivisions

Number of radial subdivisions for shoot tubes.

Definition at line 1004 of file CanopyGenerator.h.

◆ stem_length

float BeanParameters::stem_length

Length of stems before splitting to leaflets.

Definition at line 1010 of file CanopyGenerator.h.

◆ stem_radius

float BeanParameters::stem_radius

Radius of main stem at base.

Definition at line 1007 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