com.esri.arcgis.datasourcesraster
Interface IShadedReliefFunctionArguments

All Superinterfaces:
Serializable
All Known Implementing Classes:
ShadedReliefFunctionArguments

public interface IShadedReliefFunctionArguments
extends Serializable

Provides access to members that control shaded relief 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.
 IRasterColormap getColormap()
          The raster colormap.
 IColorRamp getColorRamp()
          The colorramp.
 Object getRaster()
          The input image.
 Object getRGB()
          The input RGB image.
 double getZFactor()
          The zfactor.
 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 setColormapByRef(IRasterColormap ppColormap)
          The raster colormap.
 void setColorRampByRef(IColorRamp ppColorRamp)
          The colorramp.
 void setRasterByRef(Object ppRaster)
          The input image.
 void setRGBByRef(Object ppRaster)
          The input RGB image.
 void setZFactor(double pZfactor)
          The zfactor.
 

Method Detail

getRaster

Object getRaster()
                 throws IOException,
                        AutomationException
The input image.

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.

setRasterByRef

void setRasterByRef(Object ppRaster)
                    throws IOException,
                           AutomationException
The input image.

Product Availability

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

Parameters:
ppRaster - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRGB

Object getRGB()
              throws IOException,
                     AutomationException
The input RGB image.

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.

setRGBByRef

void setRGBByRef(Object ppRaster)
                 throws IOException,
                        AutomationException
The input RGB image.

Product Availability

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

Parameters:
ppRaster - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColorRamp

IColorRamp getColorRamp()
                        throws IOException,
                               AutomationException
The colorramp.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.display.IColorRamp
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColorRampByRef

void setColorRampByRef(IColorRamp ppColorRamp)
                       throws IOException,
                              AutomationException
The colorramp.

Product Availability

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

Parameters:
ppColorRamp - A reference to a com.esri.arcgis.display.IColorRamp (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColormap

IRasterColormap getColormap()
                            throws IOException,
                                   AutomationException
The raster colormap.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.geodatabase.IRasterColormap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColormapByRef

void setColormapByRef(IRasterColormap ppColormap)
                      throws IOException,
                             AutomationException
The raster colormap.

Product Availability

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

Parameters:
ppColormap - A reference to a com.esri.arcgis.geodatabase.IRasterColormap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getZFactor

double getZFactor()
                  throws IOException,
                         AutomationException
The zfactor.

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 zfactor.

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.

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.