com.esri.arcgis.display
Interface IIlluminationProps

All Superinterfaces:

Serializable

All Known Implementing Classes:

IlluminationProps

public interface IIlluminationProps
extends Serializable

Provides access to members that control Illumination Properties.

Product Availability

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

Method Summary

double	getAltitude() Altitude angle of illumination.
double	getAzimuth() Azimuth angle of illumination.
double	getContrast() Ratio of bright to shadow illumination.
_WKSPointZ	getSunPosition() Illumination vector as cosines of angles to X,Y,Z axes.
void	setAltitude(double pAltitude) Altitude angle of illumination.
void	setAzimuth(double pAzimuth) Azimuth angle of illumination.
void	setContrast(double contrast) Ratio of bright to shadow illumination.
void	setSunPosition(_WKSPointZ position) Illumination vector as cosines of angles to X,Y,Z axes.

Method Detail

getSunPosition

_WKSPointZ getSunPosition()
                          throws IOException,
                                 AutomationException

Illumination vector as cosines of angles to X,Y,Z axes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A Structure: com.esri.arcgis.system._WKSPointZ (A com.esri.arcgis.system._WKSPointZ COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSunPosition

void setSunPosition(_WKSPointZ position)
                    throws IOException,
                           AutomationException

Illumination vector as cosines of angles to X,Y,Z axes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

position - A Structure: com.esri.arcgis.system._WKSPointZ (A com.esri.arcgis.system._WKSPointZ COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContrast

double getContrast()
                   throws IOException,
                          AutomationException

Ratio of bright to shadow illumination.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The contrast

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setContrast

void setContrast(double contrast)
                 throws IOException,
                        AutomationException

Ratio of bright to shadow illumination.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

contrast - The contrast (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAzimuth

double getAzimuth()
                  throws IOException,
                         AutomationException

Azimuth angle of illumination.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

Azimuth angle of illumination.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

Altitude angle of illumination.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

Altitude angle of illumination.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pAltitude - The pAltitude (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.