SORTIE Core C++ Documentation
Public Member Functions | List of all members
clShadingEffectBase Class Referenceabstract

Provides a base for objects that calculate a shading effect. More...

#include <ShadingEffectBase.h>

Inheritance diagram for clShadingEffectBase:
clShadingEffectDefault clShadingEffectNone

Public Member Functions

virtual double CalculateShadingEffect (clTree *p_oTree)=0
 Calculates shading effect. More...
 
virtual void DoSetup (clTreePopulation *p_oPop, clBehaviorBase *p_oNCI, xercesc::DOMElement *p_oElement)=0
 Does any desired setup. More...
 
virtual ~clShadingEffectBase ()
 Destructor. More...
 
virtual void PreCalcs (clTreePopulation *p_oPop)
 Performs calculations like either clGrowthBase::PreGrowthCalcs or clMortalityBase::PreMortCalcs. More...
 

Detailed Description

Provides a base for objects that calculate a shading effect.

Constructor & Destructor Documentation

◆ ~clShadingEffectBase()

virtual clShadingEffectBase::~clShadingEffectBase ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ CalculateShadingEffect()

virtual double clShadingEffectBase::CalculateShadingEffect ( clTree p_oTree)
pure virtual

Calculates shading effect.

Parameters
p_oTreeTree for which to calculate shading effect.

Implemented in clShadingEffectDefault, and clShadingEffectNone.

◆ DoSetup()

virtual void clShadingEffectBase::DoSetup ( clTreePopulation p_oPop,
clBehaviorBase p_oNCI,
xercesc::DOMElement *  p_oElement 
)
pure virtual

Does any desired setup.

Parameters
p_oPopTree population.
p_oNCINCI behavior object.
p_oElementRoot element of the behavior.

Implemented in clShadingEffectDefault, and clShadingEffectNone.

◆ PreCalcs()

virtual void clShadingEffectBase::PreCalcs ( clTreePopulation p_oPop)
inlinevirtual

Performs calculations like either clGrowthBase::PreGrowthCalcs or clMortalityBase::PreMortCalcs.


The documentation for this class was generated from the following file: