te::se::ShadedRelief Class Reference

ShadedRelief specifies the application of relief shading (or "hill shading") to a DEM raster to give it somewhat of a three-dimensional effect and to make elevation changes more visible. More...

#include <ShadedRelief.h>

Inheritance diagram for te::se::ShadedRelief:

Public Member Functions

ShadedReliefclone () const
 It creates a new copy of this object. More...
 
Initializer Methods

Methods related to instantiation and destruction.

 ShadedRelief ()
 It initializes a new ShadedRelief. More...
 
 ~ShadedRelief ()
 Destructor. More...
 
Accessor methods

Methods used to get or set properties.

void setBrightnessOnly (bool b)
 
bool isBrightnessOnly () const
 
void setReliefFactor (const double &rf)
 
double getReliefFactor () const
 

Private Attributes

bool m_brightnessOnly
 It may be 0 (false) or 1 (true). (Optional) More...
 
double m_reliefFactor
 It gives the amount of exaggeration to use for the height of the "hills". (Optional) More...
 

Detailed Description

ShadedRelief specifies the application of relief shading (or "hill shading") to a DEM raster to give it somewhat of a three-dimensional effect and to make elevation changes more visible.

Exact parameters of the shading are system-dependent (for now). If the BrightnessOnly flag is "0" or "false" (false, default), the shading is applied to the layer being rendered as the current RasterSymbolizer. If BrightnessOnly is "1" or "true" (true), the shading is applied to the brightness of the colors in the rendering canvas generated so far by other layers, with the effect of relief-shading these other layers. The default for BrightnessOnly is "0" (false). The ReliefFactor gives the amount of exaggeration to use for the height of the "hills". A value of around 55 (times) gives reasonable results for Earth-based DEMs. The default value is system-dependent.

See also
RasterSymbolizer

Definition at line 58 of file ShadedRelief.h.

Constructor & Destructor Documentation

te::se::ShadedRelief::ShadedRelief ( )

It initializes a new ShadedRelief.

te::se::ShadedRelief::~ShadedRelief ( )

Destructor.

Member Function Documentation

ShadedRelief* te::se::ShadedRelief::clone ( ) const

It creates a new copy of this object.

double te::se::ShadedRelief::getReliefFactor ( ) const

relief factor parameter.

bool te::se::ShadedRelief::isBrightnessOnly ( ) const

brigtness parameter.

void te::se::ShadedRelief::setBrightnessOnly ( bool  b)

brigtness parameter.

void te::se::ShadedRelief::setReliefFactor ( const double &  rf)

relief factor parameter.

Member Data Documentation

bool te::se::ShadedRelief::m_brightnessOnly
private

It may be 0 (false) or 1 (true). (Optional)

Definition at line 99 of file ShadedRelief.h.

double te::se::ShadedRelief::m_reliefFactor
private

It gives the amount of exaggeration to use for the height of the "hills". (Optional)

Definition at line 100 of file ShadedRelief.h.


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