com.esri.arcgis.globecore
Interface IGlobeGraphicsElementProperties

All Superinterfaces:
Serializable
All Known Implementing Classes:
GlobeGraphicsElementProperties

public interface IGlobeGraphicsElementProperties
extends Serializable

Provides access to the Globe Graphics properties.

When To Use

This interface is used to get/set the graphics element properties of a GlobeGraphicsLayer. It is particularly useful for manipulating the globe graphics specific properties such as billboarding. It is also frequently used to control the properties of 3D callout graphics element.

Product Availability

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


Method Summary
 void getCallOutLineOffset(double[] pLongitudeInDegrees, double[] pLatitudeInDegrees, double[] pAltitudeInMeters)
          The offset introduced by the callout line in the graphics element position.
 ISimpleLineSymbol getCallOutLineSymbol()
          The symbol used for the callout line.
 double getDrapedDensificationDistance()
          For draped line elements, densification distance in meters.
 double getDrapeZOffset()
          The offset for elevation values when element is draped.
 int getOrientationMode()
          The orientation mode, if supported by the element.
 boolean isDrapeElement()
          The option to place the element as a vector on the Globe surface.
 boolean isDrapeQuality()
          The option to use maximum resolution elevation when draping.
 boolean isFixedScreenSize()
          The option to keep a fixed screen size, if supported by the element.
 boolean isIlluminate()
          The illumination option for a graphics element.
 boolean isRasterize()
          The option to rasterize the element on the Globe surface.
 boolean isUseCallOutLine()
          The option to add a callout line, if supported by the element.
 void putCallOutLineOffset(double longitudeInDegrees, double latitudeInDegrees, double altitudeInMeters)
          The offset introduced by the callout line in the graphics element position.
 void setCallOutLineSymbol(ISimpleLineSymbol ppLineSym)
          The symbol used for the callout line.
 void setDrapedDensificationDistance(double pMeters)
          For draped line elements, densification distance in meters.
 void setDrapeElement(boolean pbDrape)
          The option to place the element as a vector on the Globe surface.
 void setDrapeQuality(boolean pbUseMaximumResolution)
          The option to use maximum resolution elevation when draping.
 void setDrapeZOffset(double pOffset)
          The offset for elevation values when element is draped.
 void setFixedScreenSize(boolean pbFixed)
          The option to keep a fixed screen size, if supported by the element.
 void setIlluminate(boolean pbIlluminate)
          The illumination option for a graphics element.
 void setOrientationMode(int pMode)
          The orientation mode, if supported by the element.
 void setRasterize(boolean pbRasterize)
          The option to rasterize the element on the Globe surface.
 void setUseCallOutLine(boolean pbUseCallOut)
          The option to add a callout line, if supported by the element.
 

Method Detail

setIlluminate

void setIlluminate(boolean pbIlluminate)
                   throws IOException,
                          AutomationException
The illumination option for a graphics element.

Product Availability

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

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

isIlluminate

boolean isIlluminate()
                     throws IOException,
                            AutomationException
The illumination option for a graphics element.

Product Availability

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

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

setFixedScreenSize

void setFixedScreenSize(boolean pbFixed)
                        throws IOException,
                               AutomationException
The option to keep a fixed screen size, if supported by the element.

Product Availability

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

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

isFixedScreenSize

boolean isFixedScreenSize()
                          throws IOException,
                                 AutomationException
The option to keep a fixed screen size, if supported by the element.

Product Availability

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

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

setOrientationMode

void setOrientationMode(int pMode)
                        throws IOException,
                               AutomationException
The orientation mode, if supported by the element.

Product Availability

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

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

getOrientationMode

int getOrientationMode()
                       throws IOException,
                              AutomationException
The orientation mode, if supported by the element.

Product Availability

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

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

setUseCallOutLine

void setUseCallOutLine(boolean pbUseCallOut)
                       throws IOException,
                              AutomationException
The option to add a callout line, if supported by the element.

Product Availability

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

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

isUseCallOutLine

boolean isUseCallOutLine()
                         throws IOException,
                                AutomationException
The option to add a callout line, if supported by the element.

Product Availability

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

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

setCallOutLineSymbol

void setCallOutLineSymbol(ISimpleLineSymbol ppLineSym)
                          throws IOException,
                                 AutomationException
The symbol used for the callout line.

Product Availability

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

Parameters:
ppLineSym - A reference to a com.esri.arcgis.display.ISimpleLineSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCallOutLineSymbol

ISimpleLineSymbol getCallOutLineSymbol()
                                       throws IOException,
                                              AutomationException
The symbol used for the callout line.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.display.ISimpleLineSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putCallOutLineOffset

void putCallOutLineOffset(double longitudeInDegrees,
                          double latitudeInDegrees,
                          double altitudeInMeters)
                          throws IOException,
                                 AutomationException
The offset introduced by the callout line in the graphics element position.

Product Availability

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

Parameters:
longitudeInDegrees - The longitudeInDegrees (in)
latitudeInDegrees - The latitudeInDegrees (in)
altitudeInMeters - The altitudeInMeters (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCallOutLineOffset

void getCallOutLineOffset(double[] pLongitudeInDegrees,
                          double[] pLatitudeInDegrees,
                          double[] pAltitudeInMeters)
                          throws IOException,
                                 AutomationException
The offset introduced by the callout line in the graphics element position.

Product Availability

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

Parameters:
pLongitudeInDegrees - The pLongitudeInDegrees (out: use single element array)
pLatitudeInDegrees - The pLatitudeInDegrees (out: use single element array)
pAltitudeInMeters - The pAltitudeInMeters (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRasterize

void setRasterize(boolean pbRasterize)
                  throws IOException,
                         AutomationException
The option to rasterize the element on the Globe surface.

Product Availability

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

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

isRasterize

boolean isRasterize()
                    throws IOException,
                           AutomationException
The option to rasterize the element on the Globe surface.

Product Availability

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

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

setDrapeElement

void setDrapeElement(boolean pbDrape)
                     throws IOException,
                            AutomationException
The option to place the element as a vector on the Globe surface.

Product Availability

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

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

isDrapeElement

boolean isDrapeElement()
                       throws IOException,
                              AutomationException
The option to place the element as a vector on the Globe surface.

Product Availability

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

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

setDrapeQuality

void setDrapeQuality(boolean pbUseMaximumResolution)
                     throws IOException,
                            AutomationException
The option to use maximum resolution elevation when draping.

Product Availability

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

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

isDrapeQuality

boolean isDrapeQuality()
                       throws IOException,
                              AutomationException
The option to use maximum resolution elevation when draping.

Product Availability

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

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

setDrapeZOffset

void setDrapeZOffset(double pOffset)
                     throws IOException,
                            AutomationException
The offset for elevation values when element is draped.

Product Availability

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

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

getDrapeZOffset

double getDrapeZOffset()
                       throws IOException,
                              AutomationException
The offset for elevation values when element is draped.

Product Availability

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

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

setDrapedDensificationDistance

void setDrapedDensificationDistance(double pMeters)
                                    throws IOException,
                                           AutomationException
For draped line elements, densification distance in meters.

Product Availability

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

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

getDrapedDensificationDistance

double getDrapedDensificationDistance()
                                      throws IOException,
                                             AutomationException
For draped line elements, densification distance in meters.

Product Availability

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

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