org.geotools.styling
Interface ShadedRelief

All Superinterfaces:

GTComponent

All Known Implementing Classes:

ShadedReliefImpl

public interface ShadedRelief

extends GTComponent

The ShadedRelief element selects the application of relief shading (or ?hill shading?) to an image for a three-dimensional visual effect. It is defined as:

 <xs:element name="ShadedRelief">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="sld:BrightnessOnly" minOccurs="0"/>
       <xs:element ref="sld:ReliefFactor" minOccurs="0"/>
     </xs:sequence>
   </xs:complexType>
 </xs:element>
 <xs:element name="BrightnessOnly" type="xs:boolean"/>
 <xs:element name="ReliefFactor" type="xs:double"/>
 

Exact parameters of the shading are system-dependent (for now). If the BrightnessOnly flag is ?0? (false, default), the shading is applied to the layer being rendered as the current RasterSymbol. If BrightnessOnly is ?1? (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.

Author:

iant

Method Summary

Expression	getReliefFactor() 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.
boolean	isBrightnessOnly() indicates if brightnessOnly is true or false.
void	setBrightnessOnly(boolean flag) turns brightnessOnly on or off depending on value of flag.
void	setReliefFactor(Expression reliefFactor) 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.

Methods inherited from interface org.geotools.event.GTComponent

changed, getNote, getParent, removed, setNote

Method Detail

setBrightnessOnly

public void setBrightnessOnly(boolean flag)

turns brightnessOnly on or off depending on value of flag.

Parameters:

flag - boolean

isBrightnessOnly

public boolean isBrightnessOnly()

indicates if brightnessOnly is true or false. Default is false.

Returns:

boolean brightnessOn.

setReliefFactor

public void setReliefFactor(Expression reliefFactor)

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.

Parameters:

reliefFactor - an expression which evaluates to a double.

getReliefFactor

public Expression getReliefFactor()

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.

Returns:

an expression which evaluates to a double.