ShadedRelief (Groovy Documentation)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

geoscript.style.ShadedRelief

Symbolize a Raster with a ShadedRelief or hill shading.
You can create ShadedRelief Symbolizer by using defaults (relief factor of 55 and brightness only to false):
```
 def shadedRelief = new ShadedRelief()
 
```
Or you can create explicity set those values:
```
 def shadedRelief = new ShadedRelief(35, true)
 
```
Authors:
Jared Erickson

Properties Summary

Properties
Type	Name and description
`boolean`	`brightnessOnly` Whether to turn on the brightness only flag
`Expression`	`reliefFactor` The relief factor

Constructor Summary

Constructors
Constructor and description
`ShadedRelief (java.lang.Object reliefFactor = 55, boolean brightnessOnly = false)` Create a new ShadedRelief Symbolizer

Methods Summary

Methods
Type	Name and description
`protected void`	`apply(org.geotools.styling.Symbolizer sym)` Apply this Symbolizer to the GeoTools Symbolizer
`protected void`	`prepare(org.geotools.styling.Rule rule)` Prepare the GeoTools Rule by applying this Symbolizer
`java.lang.String`	`toString()` The string representation

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class RasterSymbolizer`	`apply, geometry, opacity, overlap, prepare, setGeometry, setOpacity, setOverlap, toString`
`interface org.geotools.styling.Symbolizer`	org.geotools.styling.Symbolizer#accept(org.geotools.styling.StyleVisitor), org.geotools.styling.Symbolizer#setName(java.lang.String), org.geotools.styling.Symbolizer#hasOption(java.lang.String), org.geotools.styling.Symbolizer#getOptions(), org.geotools.styling.Symbolizer#getDescription(), org.geotools.styling.Symbolizer#getDescription(), org.geotools.styling.Symbolizer#setDescription(org.opengis.style.Description), org.geotools.styling.Symbolizer#getGeometry(), org.geotools.styling.Symbolizer#setGeometry(org.opengis.filter.expression.Expression), org.geotools.styling.Symbolizer#setUnitOfMeasure(javax.measure.unit.Unit), org.geotools.styling.Symbolizer#getGeometryPropertyName(), org.geotools.styling.Symbolizer#setGeometryPropertyName(java.lang.String), org.geotools.styling.Symbolizer#getName(), org.geotools.styling.Symbolizer#accept(org.opengis.style.StyleVisitor, java.lang.Object), org.geotools.styling.Symbolizer#getUnitOfMeasure()

- Property Detail
  - boolean brightnessOnly
    
    Whether to turn on the brightness only flag
  - Expression reliefFactor
    
    The relief factor
- Constructor Detail
  - ShadedRelief(java.lang.Object reliefFactor = 55, boolean brightnessOnly = false)
    
    Create a new ShadedRelief Symbolizer
    Parameters:
    reliefFactor - The relief factor
    brightnessOnly - Whether to turn on the brightness only flag
- Method Detail
  - @java.lang.Override protected void apply(org.geotools.styling.Symbolizer sym)
    
    Apply this Symbolizer to the GeoTools Symbolizer
    Parameters:
    sym - The GeoTools Symbolizer
  - @java.lang.Override protected void prepare(org.geotools.styling.Rule rule)
    
    Prepare the GeoTools Rule by applying this Symbolizer
    Parameters:
    rule - The GeoTools Rule
  - java.lang.String toString()
    
    The string representation
    Returns:
    The string representation

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation