public class

HillshadeRenderer

extends Object
implements RasterRenderer
java.lang.Object
   ↳ com.esri.core.renderer.HillshadeRenderer
Known Direct Subclasses

Class Overview

HillshadeRenderer can be applied to a RasterLayer created with single band raster data. For a multi band raster data, RGBRenderer might be a better fit.

Summary

Fields
protected double mAltitude
protected double mAzimuth
protected double mPixelSizeFactor
protected double mPixelSizePower
protected SlopeType mSlopeType
protected double mZFactor
Public Constructors
HillshadeRenderer()
Creates an instance of HillshadeRenderer.
Public Methods
double getAltitude()
Gets the altitude of the HillshadeRenderer.
double getAzimuth()
Gets the azimuth of the HillshadeRenderer.
double getPixelSizeFactor()
Gets the pixel size factor.
double getPixelSizePower()
Gets the pixel size power.
SlopeType getSlopeType()
Gets the SlopeType of the HillshadeRenderer.
double getZfactor()
Gets the ZFactor of the HillshadeRenderer.
void setAltitude(double altitude)
Sets the altitude of the HillshadeRenderer.
void setAzimuth(double azimuth)
Sets the azimuth of the HillshadeRenderer.
void setPixelSizeFactor(double pixelSizeFactor)
Sets the pixel size factor.
void setPixelSizePower(double pixelSizePower)
Sets the pixel size power.
void setSlopeType(SlopeType slopeType)
Sets the SlopeType of the HillshadeRenderer.
void setZfactor(double zfactor)
Sets the ZFactor of the HillshadeRenderer.
String toJson()
Generates a json representation of the renderer
Protected Methods
void toJson(JsonGenerator node)
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.esri.core.renderer.RasterRenderer

Fields

protected double mAltitude

protected double mAzimuth

protected double mPixelSizeFactor

protected double mPixelSizePower

protected SlopeType mSlopeType

protected double mZFactor

Public Constructors

public HillshadeRenderer ()

Creates an instance of HillshadeRenderer.

Public Methods

public double getAltitude ()

Gets the altitude of the HillshadeRenderer. Altitude refers to the sun's angle of elevation above the horizon, with values ranging from 0-90. A value of 0 indicates that the sun is on the horizon, while a value of 90 indicates that the sun is directly overhead.

Returns
double the altitude of the HillshadeRenderer

public double getAzimuth ()

Gets the azimuth of the HillshadeRenderer. Azimuth refers to the sun's relative position along the horizon. This position is measured clockwise from due north. values range from 0-360, with 0 indicating north, 90 indicating east, 180 indicating south, and 270 indicating west.

Returns
double the azimuth of the HillshadeRenderer

public double getPixelSizeFactor ()

Gets the pixel size factor. Pixel size factor and pixel size power allow nonlinear adjustments to be made to elevation scaling. This is typically recommended when working with world-wide datasets projected using World Mercator. These values adjust the ZFactor as follows: Adjusted ZFactor = (ZFactor) + (PixelSize)^PixelSizePower * (PixelSizeFactor)

Returns
double the pixel size factor

public double getPixelSizePower ()

Gets the pixel size power. Pixel size factor and pixel size power allow nonlinear adjustments to be made to elevation scaling. This is typically recommended when working with world-wide datasets projected using World Mercator. These values adjust the ZFactor as follows: Adjusted ZFactor = (ZFactor) + (PixelSize)^PixelSizePower * (PixelSizeFactor)

Returns
double the pixel size power

public SlopeType getSlopeType ()

Gets the SlopeType of the HillshadeRenderer.

Returns
SlopeType the slope type of the HillshadeRenderer

public double getZfactor ()

Gets the ZFactor of the HillshadeRenderer. ZFactor is used to convert elevation values, which is typically done for one of two reasons:

  1. To convert units of measure for the Z values to the units of measure for the X,Y values
  2. To add vertical exaggeration for visual effect

Returns
double the ZFactor of the HillshadeRenderer

public void setAltitude (double altitude)

Sets the altitude of the HillshadeRenderer. Altitude refers to the sun's angle of elevation above the horizon, with values ranging from 0-90. A value of 0 indicates that the sun is on the horizon, while a value of 90 indicates that the sun is directly overhead.

Parameters
altitude double: the altitude to set on the HillshadeRenderer

public void setAzimuth (double azimuth)

Sets the azimuth of the HillshadeRenderer. Azimuth refers to the sun's relative position along the horizon. This position is measured clockwise from due north. values range from 0-360, with 0 indicating north, 90 indicating east, 180 indicating south, and 270 indicating west.

Parameters
azimuth double: the azimuth to set on the HillshadeRenderer

public void setPixelSizeFactor (double pixelSizeFactor)

Sets the pixel size factor. Pixel size factor and pixel size power allow nonlinear adjustments to be made to elevation scaling. This is typically recommended when working with world-wide datasets projected using World Mercator. These values adjust the ZFactor as follows: Adjusted ZFactor = (ZFactor) + (PixelSize)^PixelSizePower * (PixelSizeFactor)

Parameters
pixelSizeFactor double: the pixel size factor to set

public void setPixelSizePower (double pixelSizePower)

Sets the pixel size power. Pixel size factor and pixel size power allow nonlinear adjustments to be made to elevation scaling. This is typically recommended when working with world-wide datasets projected using World Mercator. These values adjust the ZFactor as follows: Adjusted ZFactor = (ZFactor) + (PixelSize)^PixelSizePower * (PixelSizeFactor)

Parameters
pixelSizePower double: the pixel size power to set

public void setSlopeType (SlopeType slopeType)

Sets the SlopeType of the HillshadeRenderer.

Parameters
slopeType SlopeType: the slope type to set

public void setZfactor (double zfactor)

Sets the ZFactor of the HillshadeRenderer. ZFactor is used to convert elevation values, which is typically done for one of two reasons:

  1. To convert units of measure for the Z values to the units of measure for the X,Y values
  2. To add vertical exaggeration for visual effect

Parameters
zfactor double: the ZFactor to set on the HillshadeRenderer

public String toJson ()

Generates a json representation of the renderer

Returns
String a String containing the json representation of the renderer
Throws
Exception

Protected Methods

protected void toJson (JsonGenerator node)

Parameters
node JsonGenerator
Throws
Exception