ArcGIS Runtime SDK for iOS: AGSBlendRenderer Class Reference
ArcGIS Runtime SDK for iOS  100.14
AGSBlendRenderer Class Reference

Description

A blend renderer for elevation raster data.

An instance of this class represents a blend renderer that can be used to visualize elevation raster data. The renderer allows a hillshade to be computed and blended with the original raster. This provides a look similar to the original raster, but with some terrain shading, giving it a rich, textured look.

Since
100
Inheritance diagram for AGSBlendRenderer:
AGSHillshadeRenderer AGSRasterRenderer AGSObject

Instance Methods

(instancetype) - init
 
(instancetype) - initWithAltitude:azimuth:zFactor:slopeType:pixelSizeFactor:pixelSizePower:outputBitDepth:
 
(instancetype) - initWithElevationRaster:outputMinValues:outputMaxValues:sourceMinValues:sourceMaxValues:noDataValues:gammas:colorRamp:altitude:azimuth:zFactor:slopeType:pixelSizeFactor:pixelSizePower:outputBitDepth:
 

Class Methods

(instancetype) + blendRendererWithElevationRaster:outputMinValues:outputMaxValues:sourceMinValues:sourceMaxValues:noDataValues:gammas:colorRamp:altitude:azimuth:zFactor:slopeType:pixelSizeFactor:pixelSizePower:outputBitDepth:
 
(instancetype) + hillshadeRendererWithAltitude:azimuth:zFactor:slopeType:pixelSizeFactor:pixelSizePower:outputBitDepth:
 
(instancetype) + rasterRenderer
 

Properties

double altitude
 
double azimuth
 
AGSColorRampcolorRamp
 
AGSRasterelevationRaster
 
NSArray< NSNumber * > * gammas
 
NSArray< NSNumber * > * noDataValues
 
NSInteger outputBitDepth
 
NSArray< NSNumber * > * outputMaxValues
 
NSArray< NSNumber * > * outputMinValues
 
double pixelSizeFactor
 
double pixelSizePower
 
AGSSlopeType slopeType
 
NSArray< NSNumber * > * sourceMaxValues
 
NSArray< NSNumber * > * sourceMinValues
 
double zFactor
 

Method Documentation

◆ blendRendererWithElevationRaster:outputMinValues:outputMaxValues:sourceMinValues:sourceMaxValues:noDataValues:gammas:colorRamp:altitude:azimuth:zFactor:slopeType:pixelSizeFactor:pixelSizePower:outputBitDepth:

+ (instancetype) blendRendererWithElevationRaster: (AGSRaster *)  elevationRaster
outputMinValues: (NSArray< NSNumber * > *)  outputMinValues
outputMaxValues: (NSArray< NSNumber * > *)  outputMaxValues
sourceMinValues: (NSArray< NSNumber * > *)  sourceMinValues
sourceMaxValues: (NSArray< NSNumber * > *)  sourceMaxValues
noDataValues: (NSArray< NSNumber * > *)  noDataValues
gammas: (NSArray< NSNumber * > *)  gammas
colorRamp: (nullable AGSColorRamp *)  colorRamp
altitude: (double)  altitude
azimuth: (double)  azimuth
zFactor: (double)  zFactor
slopeType: (AGSSlopeType slopeType
pixelSizeFactor: (double)  pixelSizeFactor
pixelSizePower: (double)  pixelSizePower
outputBitDepth: (NSInteger)  outputBitDepth 

Initialize a blend raster renderer with the provided parameters.

Parameters
elevationRastercontaining the elevation data.
outputMinValuesMin output stretch values, one for each band in the raster.
outputMaxValuesMax output stretch values, one for each band in the raster.
sourceMinValuesMin input stretch values, one for each band in the raster.
sourceMaxValuesMax input stretch values, one for each band in the raster.
noDataValuesNoData values, one for each band in the raster.
gammasGamma adjustment for each band in the raster.
colorRampThe spectrum of colors to use.
altitudeSun's angle of elevation above the horizon ranging from 0 to 90 degrees.
azimuthSun's relative position along the horizon ranging from 0 to 360 degrees.
zFactorScaling factor used to convert the elevation values to horizontal coordinate units. For default, use 1.
slopeTypespecifying how inclination of the slope is calculated.
pixelSizeFactorto account for altitude changes (scale) as the viewer zooms in and out. For default, use 1.
pixelSizePowerto account for altitude changes (scale) as the viewer zooms in and out. For default, use 1.
outputBitDepthof a raster cell. For default, use 8.
Returns
A new blend renderer.
Since
100

◆ hillshadeRendererWithAltitude:azimuth:zFactor:slopeType:pixelSizeFactor:pixelSizePower:outputBitDepth:

+ (instancetype) hillshadeRendererWithAltitude: (double)  altitude
azimuth: (double)  azimuth
zFactor: (double)  zFactor
slopeType: (AGSSlopeType slopeType
pixelSizeFactor: (double)  pixelSizeFactor
pixelSizePower: (double)  pixelSizePower
outputBitDepth: (NSInteger)  outputBitDepth 

Initialize a hillshade raster renderer with the provided parameters

Parameters
altitudeSun's angle of elevation above the horizon ranging from 0 to 90 degrees
azimuthSun's relative position along the horizon ranging from 0 to 360 degrees
zFactorScaling factor used to convert the elevation values to horizontal coordinate units. For default, use 1.
slopeTypespecifying how inclination of the slope is calculated
pixelSizeFactorto account for altitude changes (scale) as the viewer zooms in and out. For default, use 1.
pixelSizePowerto account for altitude changes (scale) as the viewer zooms in and out. For default, use 1.
outputBitDepthof a raster cell. For default, use 8.
Returns
Initialized hillshade raster renderer
Since
100

◆ init

- (instancetype) init

◆ initWithAltitude:azimuth:zFactor:slopeType:pixelSizeFactor:pixelSizePower:outputBitDepth:

- (instancetype) initWithAltitude: (double)  altitude
azimuth: (double)  azimuth
zFactor: (double)  zFactor
slopeType: (AGSSlopeType slopeType
pixelSizeFactor: (double)  pixelSizeFactor
pixelSizePower: (double)  pixelSizePower
outputBitDepth: (NSInteger)  outputBitDepth 

Initialize a hillshade raster renderer with the provided parameters

Parameters
altitudeSun's angle of elevation above the horizon ranging from 0 to 90 degrees
azimuthSun's relative position along the horizon ranging from 0 to 360 degrees
zFactorScaling factor used to convert the elevation values to horizontal coordinate units. For default, use 1.
slopeTypespecifying how inclination of the slope is calculated
pixelSizeFactorto account for altitude changes (scale) as the viewer zooms in and out. For default, use 1.
pixelSizePowerto account for altitude changes (scale) as the viewer zooms in and out. For default, use 1.
outputBitDepthof a raster cell. For default, use 8.
Returns
Initialized hillshade raster renderer
Since
100

◆ initWithElevationRaster:outputMinValues:outputMaxValues:sourceMinValues:sourceMaxValues:noDataValues:gammas:colorRamp:altitude:azimuth:zFactor:slopeType:pixelSizeFactor:pixelSizePower:outputBitDepth:

- (instancetype) initWithElevationRaster: (AGSRaster *)  elevationRaster
outputMinValues: (NSArray< NSNumber * > *)  outputMinValues
outputMaxValues: (NSArray< NSNumber * > *)  outputMaxValues
sourceMinValues: (NSArray< NSNumber * > *)  sourceMinValues
sourceMaxValues: (NSArray< NSNumber * > *)  sourceMaxValues
noDataValues: (NSArray< NSNumber * > *)  noDataValues
gammas: (NSArray< NSNumber * > *)  gammas
colorRamp: (nullable AGSColorRamp *)  colorRamp
altitude: (double)  altitude
azimuth: (double)  azimuth
zFactor: (double)  zFactor
slopeType: (AGSSlopeType slopeType
pixelSizeFactor: (double)  pixelSizeFactor
pixelSizePower: (double)  pixelSizePower
outputBitDepth: (NSInteger)  outputBitDepth 

Initialize a blend raster renderer with the provided parameters.

Parameters
elevationRastercontaining the elevation data.
outputMinValuesMin output stretch values, one for each band in the raster.
outputMaxValuesMax output stretch values, one for each band in the raster.
sourceMinValuesMin input stretch values, one for each band in the raster.
sourceMaxValuesMax input stretch values, one for each band in the raster.
noDataValuesNoData values, one for each band in the raster.
gammasGamma adjustment for each band in the raster.
colorRampThe spectrum of colors to use.
altitudeSun's angle of elevation above the horizon ranging from 0 to 90 degrees.
azimuthSun's relative position along the horizon ranging from 0 to 360 degrees.
zFactorScaling factor used to convert the elevation values to horizontal coordinate units. For default, use 1.
slopeTypespecifying how inclination of the slope is calculated.
pixelSizeFactorto account for altitude changes (scale) as the viewer zooms in and out. For default, use 1.
pixelSizePowerto account for altitude changes (scale) as the viewer zooms in and out. For default, use 1.
outputBitDepthof a raster cell. For default, use 8.
Since
100

◆ rasterRenderer

+ (instancetype) rasterRenderer

Property Documentation

◆ altitude

- (double) altitude
readnonatomicassigninherited

Altitude is 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 together indicate the sun's relative position.

Since
100

◆ azimuth

- (double) azimuth
readnonatomicassigninherited

Azimuth is 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.

Together the altitude and azimuth together indicate the sun's relative position.

Since
100

◆ colorRamp

- (AGSColorRamp*) colorRamp
readnonatomicstrong

The color ramp for creating the blend renderer.

Since
100.8

◆ elevationRaster

- (AGSRaster*) elevationRaster
readnonatomicstrong

The elevation data for the renderer.

Since
100

◆ gammas

- (NSArray<NSNumber*>*) gammas
readnonatomiccopy

Gamma correction for each band in the raster.

Since
100

◆ noDataValues

- (NSArray<NSNumber*>*) noDataValues
readnonatomiccopy

NoData values, one for each band in the raster.

Since
100

◆ outputBitDepth

- (NSInteger) outputBitDepth
readnonatomicassigninherited

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.

Since
100

◆ outputMaxValues

- (NSArray<NSNumber*>*) outputMaxValues
readnonatomiccopy

Maximum output values, one for each band in the raster.

Since
100

◆ outputMinValues

- (NSArray<NSNumber*>*) outputMinValues
readnonatomiccopy

Minimum output values, one for each band in the raster.

Since
100

◆ pixelSizeFactor

- (double) pixelSizeFactor
readnonatomicassigninherited

pixelSizeFactor and pixelSizePower values account for altitude changes (scale) as the viewer zooms in and out. This is recommended when using worldwide datasets.

Only applicable is slopeType is AGSSlopeTypeScaled

Since
100

◆ pixelSizePower

- (double) pixelSizePower
readnonatomicassigninherited

pixelSizePower and pixelSizeFactor values account for altitude changes (scale) as the viewer zooms in and out. This is recommended when using worldwide datasets.

Only applicable is slopeType is AGSSlopeTypeScaled

Since
100

◆ slopeType

- (AGSSlopeType) slopeType
readnonatomicassigninherited

The manner in which inclination of the slope is calculated.

Since
100

◆ sourceMaxValues

- (NSArray<NSNumber*>*) sourceMaxValues
readnonatomiccopy

Maximum input values, one for each band in the raster.

Since
100

◆ sourceMinValues

- (NSArray<NSNumber*>*) sourceMinValues
readnonatomiccopy

Minimum input values, one for each band in the raster.

Since
100

◆ zFactor

- (double) zFactor
readnonatomicassigninherited

A scaling factor 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).

Since
100