com.esri.arcgis.globecore
Interface IGlobeDisplayRendering3

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
GlobeDisplay, IGlobeDisplayRendering3Proxy

public interface IGlobeDisplayRendering3
extends java.io.Serializable

COM Interface 'IGlobeDisplayRendering3'. Generated 3/19/2015 1:20:58 PM from 'C:\ArcGIS\COM\esriGlobeCore.olb'

Description: 'Provides access to members that manipulate globe display rendering.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID83976305_34dc_4121_bb64_1dc1d15addf1
           
static int xxDummy
          Deprecated. Internal use only
 
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.
 int getGridDisplay()
          Indicates what type of grid/graticule to display.
 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 isHaloEnabled()
          Indicates if the halo effect is enabled.
 boolean isStarsEnabled()
          Indicates if the stars are enabled.
 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 setGridDisplay(int pGridType)
          Indicates what type of grid/graticule to display.
 void setIsHaloEnabled(boolean pbHalo)
          Indicates if the halo effect is enabled.
 void setIsStarsEnabled(boolean pbStars)
          Indicates if the stars are enabled.
 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.
 

Field Detail

IID83976305_34dc_4121_bb64_1dc1d15addf1

static final int IID83976305_34dc_4121_bb64_1dc1d15addf1
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

setIsSunEnabled

void setIsSunEnabled(boolean pbSun)
                     throws java.io.IOException,
                            AutomationException
Indicates if the sun lighting is enabled.

Parameters:
pbSun - The pbSun (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSunEnabled

boolean isSunEnabled()
                     throws java.io.IOException,
                            AutomationException
Indicates if the sun lighting is enabled.

Returns:
The pbSun
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGlobeBackgroundOption

int getGlobeBackgroundOption()
                             throws java.io.IOException,
                                    AutomationException
The background option.

Returns:
A com.esri.arcgis.globecore.esriGlobeBackgroundOption constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGlobeBackgroundOption

void setGlobeBackgroundOption(int pOption)
                              throws java.io.IOException,
                                     AutomationException
The background option.

Parameters:
pOption - A com.esri.arcgis.globecore.esriGlobeBackgroundOption constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLowBackgroundColor

void setLowBackgroundColor(float red,
                           float green,
                           float blue)
                           throws java.io.IOException,
                                  AutomationException
Sets the low altitude background color.

Parameters:
red - The red (in)
green - The green (in)
blue - The blue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLowBackgroundColor

void getLowBackgroundColor(float[] red,
                           float[] green,
                           float[] blue)
                           throws java.io.IOException,
                                  AutomationException
Returns the low altitude background color.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackgroundTransitionDistances

void setBackgroundTransitionDistances(float lowAltitude,
                                      float highAltitude)
                                      throws java.io.IOException,
                                             AutomationException
Sets the altitude values in kilometers for the transition in the background color.

Parameters:
lowAltitude - The lowAltitude (in)
highAltitude - The highAltitude (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackgroundTransitionDistances

void getBackgroundTransitionDistances(float[] pLowAltitude,
                                      float[] pHighAltitude)
                                      throws java.io.IOException,
                                             AutomationException
Gets the altitude values in kilometers for the transition in the background color.

Parameters:
pLowAltitude - The pLowAltitude (out: use single element array)
pHighAltitude - The pHighAltitude (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSunPosition

void setSunPosition(double latitude,
                    double longitude)
                    throws java.io.IOException,
                           AutomationException
Sets the sun position in lat, lon.

Parameters:
latitude - The latitude (in)
longitude - The longitude (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSunPosition

void getSunPosition(double[] pLatitude,
                    double[] pLongitude)
                    throws java.io.IOException,
                           AutomationException
Gets the sun position in lat, lon.

Parameters:
pLatitude - The pLatitude (out: use single element array)
pLongitude - The pLongitude (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSunColor

void setSunColor(float sunRed,
                 float sunGreen,
                 float sunBlue)
                 throws java.io.IOException,
                        AutomationException
Sets the sun RGB color.

Parameters:
sunRed - The sunRed (in)
sunGreen - The sunGreen (in)
sunBlue - The sunBlue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSunColor

void getSunColor(float[] pSunRed,
                 float[] pSunGreen,
                 float[] pSunBlue)
                 throws java.io.IOException,
                        AutomationException
Gets the sun RGB color.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSunContrast

void setSunContrast(int pContrast)
                    throws java.io.IOException,
                           AutomationException
The illumination contrast.

Parameters:
pContrast - The pContrast (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSunContrast

int getSunContrast()
                   throws java.io.IOException,
                          AutomationException
The illumination contrast.

Returns:
The pContrast
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAmbientLight

void setAmbientLight(float pLightValue)
                     throws java.io.IOException,
                            AutomationException
The sun's ambient light value.

Parameters:
pLightValue - The pLightValue (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAmbientLight

float getAmbientLight()
                      throws java.io.IOException,
                             AutomationException
The sun's ambient light value.

Returns:
The pLightValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBaseExaggeration

void setBaseExaggeration(double pFactor)
                         throws java.io.IOException,
                                AutomationException
The vertical exaggeration for the base globe.

Parameters:
pFactor - The pFactor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBaseExaggeration

double getBaseExaggeration()
                           throws java.io.IOException,
                                  AutomationException
The vertical exaggeration for the base globe.

Returns:
The pFactor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOverlayExaggeration

void setOverlayExaggeration(double pFactor)
                            throws java.io.IOException,
                                   AutomationException
The vertical exaggeration for the overlay layers.

Parameters:
pFactor - The pFactor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOverlayExaggeration

double getOverlayExaggeration()
                              throws java.io.IOException,
                                     AutomationException
The vertical exaggeration for the overlay layers.

Returns:
The pFactor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGlobeRadius

double getGlobeRadius()
                      throws java.io.IOException,
                             AutomationException
The radius of the globe in meters.

Returns:
The pRadiusInMeters
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsStarsEnabled

void setIsStarsEnabled(boolean pbStars)
                       throws java.io.IOException,
                              AutomationException
Indicates if the stars are enabled.

Parameters:
pbStars - The pbStars (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isStarsEnabled

boolean isStarsEnabled()
                       throws java.io.IOException,
                              AutomationException
Indicates if the stars are enabled.

Returns:
The pbStars
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsHaloEnabled

void setIsHaloEnabled(boolean pbHalo)
                      throws java.io.IOException,
                             AutomationException
Indicates if the halo effect is enabled.

Parameters:
pbHalo - The pbHalo (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHaloEnabled

boolean isHaloEnabled()
                      throws java.io.IOException,
                             AutomationException
Indicates if the halo effect is enabled.

Returns:
The pbHalo
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGridDisplay

void setGridDisplay(int pGridType)
                    throws java.io.IOException,
                           AutomationException
Indicates what type of grid/graticule to display.

Parameters:
pGridType - A com.esri.arcgis.globecore.esriGlobeDisplayGridType constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGridDisplay

int getGridDisplay()
                   throws java.io.IOException,
                          AutomationException
Indicates what type of grid/graticule to display.

Returns:
A com.esri.arcgis.globecore.esriGlobeDisplayGridType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.