HillshadeRenderer QML Type

  • Esri.ArcGISRuntime
  • HillshadeRenderer
  • A hillshade raster renderer. More...

    Import Statement: import Esri.ArcGISRuntime
    Since: Esri.ArcGISRuntime 100.0
    Inherits:

    RasterRenderer

    Inherited By:

    BlendRenderer

    Properties

    Signals

    Detailed Description

    A hillshade renderer can help visualize raster data using RasterLayer. Also known as shaded relief, a hillshade is a grayscale representation of a 3D surface, with the light source's relative position used for shading the image.

    Note: 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.

    Note: This type is immutable once created. Once the renderer is created and applied to a layer, none of its properties can be changed. Instead, create a new renderer and apply it to the layer.

    Map {
        Basemap {
            // add a raster to the basemap
            RasterLayer {
                id: rasterLayer
    
                Raster {
                    path: dataPath + "/srtm.tiff"
                }
    
                // declare a HillshadeRaster as a child of RasterLayer,
                // as renderer is a default property of RasterLayer
                HillshadeRenderer {
                    altitude: 45
                    azimuth: 315
                    zFactor: 0.000016
                    slopeType: Enums.SlopeTypeNone
                    pixelSizeFactor: 1
                    pixelSizePower: 1
                    outputBitDepth: 8
                }
            }
        }

    Property Documentation

    altitude : double

    The sun's angle of elevation above the horizon and ranges from 0 to 90 degrees.

    A value of 0 degrees indicates that the sun is on the horizon, that is, on the same horizontal plane as the frame of reference. A value of 90 degrees indicates that the sun is directly overhead. Together the altitude and azimuth indicate the sun's relative position.

    The default value is 45 degrees.


    azimuth : double

    Returns the sun's relative position along the horizon (in degrees).

    This position is indicated by the angle of the sun measured clockwise from due north. An azimuth of 0 degrees indicates north, east is 90 degrees, south is 180 degrees, and west is 270 degrees.

    The default is 315 degrees.


    outputBitDepth : int

    Returns the bit depth (pixel depth) of a raster cell.

    Determines the range of values that a particular raster can store, which is based on the formula 2n (where n is the bit depth). For example, an 8-bit raster can have 256 unique values that range from 0 to 255.

    The default bit depth is 8.


    pixelSizeFactor : double

    Returns 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)

    The default value is 1.


    pixelSizePower : double

    Returns 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)

    The default value is 1.


    slopeType : Enums.SlopeType

    The manner in which inclination of the slope is calculated.

    The default is Enums.SlopeTypeNone.

    See also Enums.SlopeType.


    zFactor : double

    Returns a scaling factor.

    This is used to convert the elevation values for two purposes:

    • To convert the elevation units (such as meters or feet) to the horizontal coordinate units (x,y) of the dataset, which may be feet, meters, or degrees.
    • To add vertical exaggeration for visual effect.

    If the x,y units and z units are in the same units of measure the z-factor is 1, unless a vertical exaggeration needs to be applied. If the x,y units and z units are in different units of measure the z-factor must be set to the appropriate factor, or the results will be incorrect. For example, if your z units are feet and your x,y units are meters, you would use a z-factor of 0.3048 to convert your z units from feet to meters (1 foot = 0.3048 meter).

    The default value is 1.


    Signal Documentation

    altitudeChanged()

    Emitted when the altitude property changes.

    Note: The corresponding handler is onAltitudeChanged.


    azimuthChanged()

    Emitted when the azimuth property changes.

    Note: The corresponding handler is onAzimuthChanged.


    outputBitDepthChanged()

    Emitted when the outputBitDepth property changes.

    Note: The corresponding handler is onOutputBitDepthChanged.


    pixelSizeFactorChanged()

    Emitted when the pixelSizeFactor property changes.

    Note: The corresponding handler is onPixelSizeFactorChanged.


    pixelSizePowerChanged()

    Emitted when the pixelSizePower property changes.

    Note: The corresponding handler is onPixelSizePowerChanged.


    slopeTypeChanged()

    Emitted when the slopeType property changes.

    Note: The corresponding handler is onSlopeTypeChanged.


    zFactorChanged()

    Emitted when the zFactor property changes.

    Note: The corresponding handler is onZFactorChanged.


    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.