Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.raster

Class HillshadeRenderer

java.lang.Object
com.esri.arcgisruntime.raster.RasterRenderer
com.esri.arcgisruntime.raster.HillshadeRenderer
Direct Known Subclasses:
BlendRenderer
public class HillshadeRenderer extends RasterRenderer
A hillshade renderer uses a grayscale representation of a 3D surface to help visualize the raster data in a RasterLayer.

A hillshade (also known as shaded relief) is a grayscale representation of a 3D surface, with the sun's relative position taken into account for shading the image. The getAltitude() and getAzimuth() properties specify the light's position.

Since:
100.0.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    HillshadeRenderer(double altitude, double azimuth, double zFactor)
    Creates a HillshadeRenderer with specified values and following defaults.
    HillshadeRenderer(double altitude, double azimuth, double zFactor, SlopeType slopeType, double pixelSizeFactor, double pixelSizePower, int outputBitDepth)
    Creates a HillshadeRenderer with specified values.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getAltitude()
    Gets the light's angle of elevation above the horizon, in degrees
    double
    getAzimuth()
    Gets the light's relative angle along the horizon, in degrees; measured clockwise, 0 is north
    int
    getOutputBitDepth()
    Gets the output bit depth.
    double
    getPixelSizeFactor()
    Gets the pixel size factor to account altitude changes as the viewer zooms.
    double
    getPixelSizePower()
    Gets the pixel size power to account altitude changes as the viewer zooms.
    SlopeType
    getSlopeType()
    Gets the slope type.
    double
    getZFactor()
    Gets the factor to convert z units to x,y.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • HillshadeRenderer

      public HillshadeRenderer(double altitude, double azimuth, double zFactor)
      Creates a HillshadeRenderer with specified values and following defaults.
      • Slope type - none
      • Pixel size factor - 1
      • Pixel size power - 1
      • Output bit depth - 8
      Parameters:
      altitude - light's angle of elevation above the horizon, in degrees
      azimuth - light's relative angle along the horizon, in degrees; measured clockwise, 0 is north
      zFactor - factor to convert z unit to x,y units
      Since:
      100.0.0

    • HillshadeRenderer

      public HillshadeRenderer(double altitude, double azimuth, double zFactor, SlopeType slopeType, double pixelSizeFactor, double pixelSizePower, int outputBitDepth)
      Creates a HillshadeRenderer with specified values.
      Parameters:
      altitude - light's angle of elevation above the horizon, in degrees
      azimuth - light's relative angle along the horizon, in degrees; measured clockwise, 0 is north
      zFactor - factor to convert z unit to x,y units
      slopeType - slope type
      pixelSizeFactor - pixel size factor to account altitude changes as the viewer zooms
      pixelSizePower - pixel size power to account altitude changes as the viewer zooms
      outputBitDepth - output bit depth
      Throws:
      IllegalArgumentException - if slopeType is null
      Since:
      100.0.0

  • Method Details

    • getAltitude

      public double getAltitude()
      Gets the light's angle of elevation above the horizon, in degrees
      Returns:
      the altitude angle of the light source, default is 45
      Since:
      100.0.0

    • getAzimuth

      public double getAzimuth()
      Gets the light's relative angle along the horizon, in degrees; measured clockwise, 0 is north
      Returns:
      the azimuth the azimuth of the light source, default is 315
      Since:
      100.0.0

    • getZFactor

      public double getZFactor()
      Gets the factor to convert z units to x,y.
      Returns:
      the factor to convert z units to x,y; default is 1
      Since:
      100.0.0

    • getSlopeType

      public SlopeType getSlopeType()
      Gets the slope type.
      Returns:
      the slope type, default is SlopeType.NONE
      Since:
      100.0.0

    • getPixelSizeFactor

      public double getPixelSizeFactor()
      Gets the pixel size factor to account altitude changes as the viewer zooms.
      Returns:
      the pixel size factor to account altitude changes as the viewer zooms, default is 1
      Since:
      100.0.0

    • getPixelSizePower

      public double getPixelSizePower()
      Gets the pixel size power to account altitude changes as the viewer zooms.
      Returns:
      the pixel size power to account altitude changes as the viewer zooms, default is 1
      Since:
      100.0.0

    • getOutputBitDepth

      public int getOutputBitDepth()
      Gets the output bit depth.
      Returns:
      the output bit depth, default is 8
      Since:
      100.0.0