com.esri.arcgis.globecore
Class IGlobeDisplayRenderingProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.globecore.IGlobeDisplayRenderingProxy

All Implemented Interfaces:

IGlobeDisplayRendering, Externalizable, Serializable

public class IGlobeDisplayRenderingProxy
extends com.esri.arcgis.interop.Dispatch
implements IGlobeDisplayRendering, 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.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IGlobeDisplayRenderingProxy()
	IGlobeDisplayRenderingProxy(Object obj)
protected	IGlobeDisplayRenderingProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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	removeListener(String iidStr, Object theListener)
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.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IGlobeDisplayRenderingProxy

public IGlobeDisplayRenderingProxy()

IGlobeDisplayRenderingProxy

public IGlobeDisplayRenderingProxy(Object obj)
                            throws IOException

Throws:

IOException

IGlobeDisplayRenderingProxy

protected IGlobeDisplayRenderingProxy(Object obj,
                                      String iid)
                               throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

setIsSunEnabled

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

Specified by:

setIsSunEnabled in interface IGlobeDisplayRendering

Parameters:

pbSun - The pbSun (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSunEnabled

public boolean isSunEnabled()
                     throws IOException,
                            AutomationException

Indicates if the sun lighting is enabled.

Product Availability

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

Specified by:

isSunEnabled in interface IGlobeDisplayRendering

Returns:

The pbSun

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGlobeBackgroundOption

public int getGlobeBackgroundOption()
                             throws IOException,
                                    AutomationException

The background option.

Product Availability

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

Specified by:

getGlobeBackgroundOption in interface IGlobeDisplayRendering

Returns:

A com.esri.arcgis.globecore.esriGlobeBackgroundOption constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGlobeBackgroundOption

public void setGlobeBackgroundOption(int pOption)
                              throws IOException,
                                     AutomationException

The background option.

Product Availability

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

Specified by:

setGlobeBackgroundOption in interface IGlobeDisplayRendering

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

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

Specified by:

setLowBackgroundColor in interface IGlobeDisplayRendering

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

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

Specified by:

getLowBackgroundColor in interface IGlobeDisplayRendering

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

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

Specified by:

setBackgroundTransitionDistances in interface IGlobeDisplayRendering

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

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

Specified by:

getBackgroundTransitionDistances in interface IGlobeDisplayRendering

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

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

Specified by:

setSunPosition in interface IGlobeDisplayRendering

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

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

Specified by:

getSunPosition in interface IGlobeDisplayRendering

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

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

Specified by:

setSunColor in interface IGlobeDisplayRendering

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

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

Specified by:

getSunColor in interface IGlobeDisplayRendering

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

public void setSunContrast(int pContrast)
                    throws IOException,
                           AutomationException

The illumination contrast.

Product Availability

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

Specified by:

setSunContrast in interface IGlobeDisplayRendering

Parameters:

pContrast - The pContrast (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSunContrast

public int getSunContrast()
                   throws IOException,
                          AutomationException

The illumination contrast.

Product Availability

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

Specified by:

getSunContrast in interface IGlobeDisplayRendering

Returns:

The pContrast

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAmbientLight

public void setAmbientLight(float pLightValue)
                     throws IOException,
                            AutomationException

The sun's ambient light value.

Product Availability

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

Specified by:

setAmbientLight in interface IGlobeDisplayRendering

Parameters:

pLightValue - The pLightValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAmbientLight

public float getAmbientLight()
                      throws IOException,
                             AutomationException

The sun's ambient light value.

Product Availability

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

Specified by:

getAmbientLight in interface IGlobeDisplayRendering

Returns:

The pLightValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBaseExaggeration

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

Specified by:

setBaseExaggeration in interface IGlobeDisplayRendering

Parameters:

pFactor - The pFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBaseExaggeration

public double getBaseExaggeration()
                           throws IOException,
                                  AutomationException

The vertical exaggeration for the base globe.

Product Availability

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

Specified by:

getBaseExaggeration in interface IGlobeDisplayRendering

Returns:

The pFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOverlayExaggeration

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

Specified by:

setOverlayExaggeration in interface IGlobeDisplayRendering

Parameters:

pFactor - The pFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOverlayExaggeration

public double getOverlayExaggeration()
                              throws IOException,
                                     AutomationException

The vertical exaggeration for the overlay layers.

Product Availability

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

Specified by:

getOverlayExaggeration in interface IGlobeDisplayRendering

Returns:

The pFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGlobeRadius

public double getGlobeRadius()
                      throws IOException,
                             AutomationException

The radius of the globe in meters.

Product Availability

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

Specified by:

getGlobeRadius in interface IGlobeDisplayRendering

Returns:

The pRadiusInMeters

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.