com.esri.arcgis.display
Interface IIlluminationProps

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IIlluminationPropsProxy, IlluminationProps

public interface IIlluminationProps

extends java.io.Serializable

Provides access to members that control Illumination Properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

public _WKSPointZ getSunPosition()
                          throws java.io.IOException,
                                 AutomationException

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSunPosition

public void setSunPosition(_WKSPointZ position)
                    throws java.io.IOException,
                           AutomationException

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContrast

public double getContrast()
                   throws java.io.IOException,
                          AutomationException

Ratio of bright to shadow illumination.

Supported Platforms

Windows, Solaris, Linux

Returns:

The contrast

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setContrast

public void setContrast(double contrast)
                 throws java.io.IOException,
                        AutomationException

Ratio of bright to shadow illumination.

Supported Platforms

Windows, Solaris, Linux

Parameters:

contrast - The contrast (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAzimuth

public double getAzimuth()
                  throws java.io.IOException,
                         AutomationException

Azimuth angle of illumination.

Supported Platforms

Windows, Solaris, Linux

Returns:

The pAzimuth

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAzimuth

public void setAzimuth(double pAzimuth)
                throws java.io.IOException,
                       AutomationException

Azimuth angle of illumination.

Supported Platforms

Windows, Solaris, Linux

Parameters:

pAzimuth - The pAzimuth (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAltitude

public double getAltitude()
                   throws java.io.IOException,
                          AutomationException

Altitude angle of illumination.

Supported Platforms

Windows, Solaris, Linux

Returns:

The pAltitude

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAltitude

public void setAltitude(double pAltitude)
                 throws java.io.IOException,
                        AutomationException

Altitude angle of illumination.

Supported Platforms

Windows, Solaris, Linux

Parameters:

pAltitude - The pAltitude (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.