com.esri.arcgis.datasourcesraster
Interface IHillshadeFunctionArguments

All Superinterfaces:

Serializable

All Known Implementing Classes:

HillshadeFunctionArguments

public interface IHillshadeFunctionArguments
extends Serializable

Provides access to members that control hillshade function arguments.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

double	getAltitude() The solar altitude angle in degrees.
double	getAzimuth() The solar azimuth angle in degrees with 0 toward North.
Object	getDEM() The input elevation model.
double	getZFactor() The Z scale factor that converts z value to the unit of x and y.
void	setAltitude(double pAltitude) The solar altitude angle in degrees.
void	setAzimuth(double pAzimuth) The solar azimuth angle in degrees with 0 toward North.
void	setDEMByRef(Object ppDEM) The input elevation model.
void	setZFactor(double pZfactor) The Z scale factor that converts z value to the unit of x and y.

Method Detail

getDEM

Object getDEM()
              throws IOException,
                     AutomationException

The input elevation model.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDEMByRef

void setDEMByRef(Object ppDEM)
                 throws IOException,
                        AutomationException

The input elevation model.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

ppDEM - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAzimuth

double getAzimuth()
                  throws IOException,
                         AutomationException

The solar azimuth angle in degrees with 0 toward North.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pAzimuth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAzimuth

void setAzimuth(double pAzimuth)
                throws IOException,
                       AutomationException

The solar azimuth angle in degrees with 0 toward North.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pAzimuth - The pAzimuth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAltitude

double getAltitude()
                   throws IOException,
                          AutomationException

The solar altitude angle in degrees.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pAltitude

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAltitude

void setAltitude(double pAltitude)
                 throws IOException,
                        AutomationException

The solar altitude angle in degrees.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pAltitude - The pAltitude (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZFactor

double getZFactor()
                  throws IOException,
                         AutomationException

The Z scale factor that converts z value to the unit of x and y.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pZfactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZFactor

void setZFactor(double pZfactor)
                throws IOException,
                       AutomationException

The Z scale factor that converts z value to the unit of x and y.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pZfactor - The pZfactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.