Mercator  0.4.0
Public Member Functions | Static Public Attributes | List of all members
Mercator::LowShader Class Reference

Surface shader that defines the surface below a given level. More...

#include <ThresholdShader.h>

Inheritance diagram for Mercator::LowShader:
Mercator::Shader

Public Member Functions

 LowShader (float threshold=default_threshold)
 Constructor. More...
 
 LowShader (const Parameters &params)
 Constructor. More...
 
float threshold () const
 Accessor for level below which the shader renders.
 
bool checkIntersect (const Segment &) const override
 Check whether this Shader has any effect on the given Segment. More...
 
void shade (Surface &) const override
 Populate a Surface with data.
 
- Public Member Functions inherited from Mercator::Shader
virtual ~Shader ()
 Destructor does nothing interesting.
 
bool getColor () const
 Accessor for color flag.
 
bool getAlpha () const
 Accessor for alpha flag.
 
SurfacenewSurface (const Segment &) const
 Create a new Surface which matches the requirements of this shader. More...
 

Static Public Attributes

static const std::string key_threshold
 Key string used when specifying the threshold parameter.
 
static const float default_threshold = -1.f
 Default level below which the shader renders.
 

Additional Inherited Members

- Public Types inherited from Mercator::Shader
typedef std::map< std::string, float > Parameters
 STL map of parameter values for a shader constructor.
 
- Protected Member Functions inherited from Mercator::Shader
 Shader (bool color=false, bool alpha=true)
 Protected constructor for classes which inherit from this one. More...
 

Detailed Description

Surface shader that defines the surface below a given level.

Constructor & Destructor Documentation

Mercator::LowShader::LowShader ( float  threshold = default_threshold)
explicit

Constructor.

Parameters
thresholdlevel below which the shader renders.
Mercator::LowShader::LowShader ( const Parameters params)
explicit

Constructor.

Parameters
paramsa map of parameters for the shader.

Member Function Documentation

bool Mercator::LowShader::checkIntersect ( const Segment ) const
overridevirtual

Check whether this Shader has any effect on the given Segment.

Returns
true if the given Segment height range is within the range that this Shader uses. e.g. A high altitude snow shader will have no effect on low level terrain.

Implements Mercator::Shader.


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