com.esri.arcgis.globecore
Interface IGlobeDisplayRendering

All Superinterfaces:

Serializable

All Known Implementing Classes:

IGlobeDisplayRenderingProxy

public interface IGlobeDisplayRendering
extends Serializable

Provides access to members that manipulate globe display rendering.

Superseded By

IGlobeDisplayRendering2

Description

IGlobeDisplayRendering interface provides access to members that control display rendering in the Globe.

AmbientLight – the globe’s sun effect ambient light value between 0 to 1, BaseExaggeration – the value of exageration to be applied for layers in the Draped and Elevation category, GlobeBackgroundOption – the Globe's background color, GlobeRadius – the Globe's radius. IsSunEnabled – indicates if the sun is enabled,OverlayExaggeration – the vertical exaggeration for Floating Layers, and SunContrast - the sun's illumination contrast.

It also has the following methods to: GetBackgroundTransitionDistances (pLowAltitute, pHighAltitude ) and SetBackgroundTransitionDistances (pLowAltitute, pHighAltitude ) a method to get\set the transition distance where the space color changes to sky color.

Product Availability

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

Method Summary

float	getAmbientLight() The sun's ambient light value.
void	getBackgroundTransitionDistances(float[] pLowAltitude, float[] pHighAltitude) Gets the altitude values in kilometers for the transition in the background color.
double	getBaseExaggeration() The vertical exaggeration for the base globe.
int	getGlobeBackgroundOption() The background option.
double	getGlobeRadius() The radius of the globe in meters.
void	getLowBackgroundColor(float[] red, float[] green, float[] blue) Returns the low altitude background color.
double	getOverlayExaggeration() The vertical exaggeration for the overlay layers.
void	getSunColor(float[] pSunRed, float[] pSunGreen, float[] pSunBlue) Gets the sun RGB color.
int	getSunContrast() The illumination contrast.
void	getSunPosition(double[] pLatitude, double[] pLongitude) Gets the sun position in lat, lon.
boolean	isSunEnabled() Indicates if the sun lighting is enabled.
void	setAmbientLight(float pLightValue) The sun's ambient light value.
void	setBackgroundTransitionDistances(float lowAltitude, float highAltitude) Sets the altitude values in kilometers for the transition in the background color.
void	setBaseExaggeration(double pFactor) The vertical exaggeration for the base globe.
void	setGlobeBackgroundOption(int pOption) The background option.
void	setIsSunEnabled(boolean pbSun) Indicates if the sun lighting is enabled.
void	setLowBackgroundColor(float red, float green, float blue) Sets the low altitude background color.
void	setOverlayExaggeration(double pFactor) The vertical exaggeration for the overlay layers.
void	setSunColor(float sunRed, float sunGreen, float sunBlue) Sets the sun RGB color.
void	setSunContrast(int pContrast) The illumination contrast.
void	setSunPosition(double latitude, double longitude) Sets the sun position in lat, lon.

Method Detail

setIsSunEnabled

void setIsSunEnabled(boolean pbSun)
                     throws IOException,
                            AutomationException

Indicates if the sun lighting is enabled.

Product Availability

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

Parameters:

pbSun - The pbSun (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSunEnabled

boolean isSunEnabled()
                     throws IOException,
                            AutomationException

Indicates if the sun lighting is enabled.

Product Availability

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

Returns:

The pbSun

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGlobeBackgroundOption

int getGlobeBackgroundOption()
                             throws IOException,
                                    AutomationException

The background option.

Product Availability

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

Returns:

A com.esri.arcgis.globecore.esriGlobeBackgroundOption constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGlobeBackgroundOption

void setGlobeBackgroundOption(int pOption)
                              throws IOException,
                                     AutomationException

The background option.

Product Availability

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

Parameters:

pOption - A com.esri.arcgis.globecore.esriGlobeBackgroundOption constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLowBackgroundColor

void setLowBackgroundColor(float red,
                           float green,
                           float blue)
                           throws IOException,
                                  AutomationException

Sets the low altitude background color.

Product Availability

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

Parameters:

red - The red (in)

green - The green (in)

blue - The blue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLowBackgroundColor

void getLowBackgroundColor(float[] red,
                           float[] green,
                           float[] blue)
                           throws IOException,
                                  AutomationException

Returns the low altitude background color.

Product Availability

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

Parameters:

red - The red (out: use single element array)

green - The green (out: use single element array)

blue - The blue (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundTransitionDistances

void setBackgroundTransitionDistances(float lowAltitude,
                                      float highAltitude)
                                      throws IOException,
                                             AutomationException

Sets the altitude values in kilometers for the transition in the background color.

Product Availability

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

Parameters:

lowAltitude - The lowAltitude (in)

highAltitude - The highAltitude (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackgroundTransitionDistances

void getBackgroundTransitionDistances(float[] pLowAltitude,
                                      float[] pHighAltitude)
                                      throws IOException,
                                             AutomationException

Gets the altitude values in kilometers for the transition in the background color.

Product Availability

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

Parameters:

pLowAltitude - The pLowAltitude (out: use single element array)

pHighAltitude - The pHighAltitude (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSunPosition

void setSunPosition(double latitude,
                    double longitude)
                    throws IOException,
                           AutomationException

Sets the sun position in lat, lon.

Product Availability

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

Parameters:

latitude - The latitude (in)

longitude - The longitude (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSunPosition

void getSunPosition(double[] pLatitude,
                    double[] pLongitude)
                    throws IOException,
                           AutomationException

Gets the sun position in lat, lon.

Product Availability

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

Parameters:

pLatitude - The pLatitude (out: use single element array)

pLongitude - The pLongitude (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSunColor

void setSunColor(float sunRed,
                 float sunGreen,
                 float sunBlue)
                 throws IOException,
                        AutomationException

Sets the sun RGB color.

Product Availability

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

Parameters:

sunRed - The sunRed (in)

sunGreen - The sunGreen (in)

sunBlue - The sunBlue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSunColor

void getSunColor(float[] pSunRed,
                 float[] pSunGreen,
                 float[] pSunBlue)
                 throws IOException,
                        AutomationException

Gets the sun RGB color.

Product Availability

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

Parameters:

pSunRed - The pSunRed (out: use single element array)

pSunGreen - The pSunGreen (out: use single element array)

pSunBlue - The pSunBlue (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSunContrast

void setSunContrast(int pContrast)
                    throws IOException,
                           AutomationException

The illumination contrast.

Product Availability

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

Parameters:

pContrast - The pContrast (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSunContrast

int getSunContrast()
                   throws IOException,
                          AutomationException

The illumination contrast.

Product Availability

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

Returns:

The pContrast

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAmbientLight

void setAmbientLight(float pLightValue)
                     throws IOException,
                            AutomationException

The sun's ambient light value.

Product Availability

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

Parameters:

pLightValue - The pLightValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAmbientLight

float getAmbientLight()
                      throws IOException,
                             AutomationException

The sun's ambient light value.

Product Availability

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

Returns:

The pLightValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBaseExaggeration

void setBaseExaggeration(double pFactor)
                         throws IOException,
                                AutomationException

The vertical exaggeration for the base globe.

Product Availability

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

Parameters:

pFactor - The pFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBaseExaggeration

double getBaseExaggeration()
                           throws IOException,
                                  AutomationException

The vertical exaggeration for the base globe.

Product Availability

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

Returns:

The pFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOverlayExaggeration

void setOverlayExaggeration(double pFactor)
                            throws IOException,
                                   AutomationException

The vertical exaggeration for the overlay layers.

Product Availability

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

Parameters:

pFactor - The pFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOverlayExaggeration

double getOverlayExaggeration()
                              throws IOException,
                                     AutomationException

The vertical exaggeration for the overlay layers.

Product Availability

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

Returns:

The pFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGlobeRadius

double getGlobeRadius()
                      throws IOException,
                             AutomationException

The radius of the globe in meters.

Product Availability

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

Returns:

The pRadiusInMeters

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.