com.esri.arcgis.globecore
Interface IGlobeLayerInfo

All Superinterfaces:
Serializable
All Known Subinterfaces:
IGlobeLayerInfo2
All Known Implementing Classes:
GlobeLayerInfo

public interface IGlobeLayerInfo
extends Serializable

Provides access to the available properties of a globe layer info object.

Superseded By

IGlobeLayerInfo2

Product Availability

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


Method Summary
 int getBaseImageDrawingPriority()
          Indicates the drawing priority for images on the globe.
 int getBaseOption()
          The base option.
 int getBaseSurfaceID()
          The layer ID of the base surface, (-1 if it doesn't exist).
 short getCompressionQuality()
          The compression quality used.
 String getCopyrightText()
          Copyright information associated with the layer.
 int getDataType()
          The globe data type.
 String getDescription()
          The description of the layer.
 String getDisplayField()
          Primary display field.
 String getElevationExpression()
          The elevation expression string for features, in globe units.
 IEnvelope getExtent()
          The geographic extent of the layer.
 String getExtrusionExpression()
          The extrusion expression string.
 int getExtrusionType()
          The extrusion type.
 int getFaceCulling()
          The face culling option.
 IFields getFields()
          Array of attribute fields contained in the layer.
 int getFloatingSeeThroughOrder()
          Indicates the see-through order for a floating layer.
 IGlobeGraphicsLayer getGraphicsLayer()
          The embedded Graphics Layer.
 int getID()
          The layer identifier.
 int getImageCatalogCrossoverLevel()
          Crossover Level of Detail (0-31) for image catalog layers.
 int getImageSamplingMode()
          Image sampling mode for display.
 int getMaxFeatureLevelOfDetail()
          Level of Detail (0-31) for feature layers.
 double getMaximumDistance()
          The maximum visibility distance.
 double getMinimumCellSize()
          Minimum cell size for rasters, in meters.
 double getMinimumDistance()
          The minimum visibility distance.
 String getName()
          The name of the layer.
 double getOffset()
          The constant elevation offset in meters.
 int getParentLayerID()
          The parent layer ID if it's a member of a composite layer.
 double getSymbologyScalingFactor()
          The scaling factor of meters-per-point to be applied on symbol sizes during rasterization.
 int getTransparency()
          The transparency percentage of the layer.
 String getType()
          The layer type.
 double getZFactor()
          The z factor.
 boolean isComposite()
          Indicates if the layer is a composite layer.
 boolean isDynamicallyRasterized()
          Indicates if the feature data is to be rasterized.
 boolean isExtruded()
          Indicates if the feature data is to be extruded.
 boolean isGroup()
          Indicates if the layer is a group layer.
 boolean isHasElevationValues()
          Indicates whether the feature layer has elevation values.
 boolean isIlluminate()
          The illumination option.
 boolean isLossyCompression()
          Indicates if lossy compression is used.
 boolean isPerTileVisibility()
          Inidicates if visibility is checked for each tile.
 boolean isScale3DSymbols()
          Indicates if the the 3D symbols will be scaled with the distance.
 boolean isSmoothShading()
          The smooth shading option.
 boolean isUse16ColorBits()
          Indicates whether to use 16 bits for color.
 boolean isUse16ElevationBits()
          Indicates whether to use 16 bits for elevation.
 boolean isUseElevationValues()
          Indicates whether elevation values in the feature layer are used.
 boolean isVisible()
          Indicates if the layer is visible.
 

Method Detail

getID

int getID()
          throws IOException,
                 AutomationException
The layer identifier. This ID is used throughout to uniquely identify the layer for all requests.

Product Availability

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

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

getName

String getName()
               throws IOException,
                      AutomationException
The name of the layer.

Product Availability

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

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

getDescription

String getDescription()
                      throws IOException,
                             AutomationException
The description of the layer. This property is set in the General tab of the Layer Properties dialog.

Product Availability

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

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

isVisible

boolean isVisible()
                  throws IOException,
                         AutomationException
Indicates if the layer is visible.

Product Availability

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

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

getType

String getType()
               throws IOException,
                      AutomationException
The layer type.

Product Availability

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

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

getExtent

IEnvelope getExtent()
                    throws IOException,
                           AutomationException
The geographic extent of the layer.

Product Availability

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

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

getFields

IFields getFields()
                  throws IOException,
                         AutomationException
Array of attribute fields contained in the layer.

Product Availability

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

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

getDisplayField

String getDisplayField()
                       throws IOException,
                              AutomationException
Primary display field.

Product Availability

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

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

getTransparency

int getTransparency()
                    throws IOException,
                           AutomationException
The transparency percentage of the layer.

Product Availability

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

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

isComposite

boolean isComposite()
                    throws IOException,
                           AutomationException
Indicates if the layer is a composite layer.

Product Availability

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

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

isGroup

boolean isGroup()
                throws IOException,
                       AutomationException
Indicates if the layer is a group layer.

Product Availability

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

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

getParentLayerID

int getParentLayerID()
                     throws IOException,
                            AutomationException
The parent layer ID if it's a member of a composite layer.

Product Availability

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

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

getDataType

int getDataType()
                throws IOException,
                       AutomationException
The globe data type.

Product Availability

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

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

getMaximumDistance

double getMaximumDistance()
                          throws IOException,
                                 AutomationException
The maximum visibility distance.

Product Availability

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

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

getMinimumDistance

double getMinimumDistance()
                          throws IOException,
                                 AutomationException
The minimum visibility distance.

Product Availability

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

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

isPerTileVisibility

boolean isPerTileVisibility()
                            throws IOException,
                                   AutomationException
Inidicates if visibility is checked for each tile.

Product Availability

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

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

isUse16ColorBits

boolean isUse16ColorBits()
                         throws IOException,
                                AutomationException
Indicates whether to use 16 bits for color.

Product Availability

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

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

isUse16ElevationBits

boolean isUse16ElevationBits()
                             throws IOException,
                                    AutomationException
Indicates whether to use 16 bits for elevation.

Product Availability

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

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

isLossyCompression

boolean isLossyCompression()
                           throws IOException,
                                  AutomationException
Indicates if lossy compression is used.

Product Availability

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

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

getCompressionQuality

short getCompressionQuality()
                            throws IOException,
                                   AutomationException
The compression quality used.

Product Availability

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

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

isScale3DSymbols

boolean isScale3DSymbols()
                         throws IOException,
                                AutomationException
Indicates if the the 3D symbols will be scaled with the distance.

Product Availability

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

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

getBaseImageDrawingPriority

int getBaseImageDrawingPriority()
                                throws IOException,
                                       AutomationException
Indicates the drawing priority for images on the globe.

Product Availability

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

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

getFloatingSeeThroughOrder

int getFloatingSeeThroughOrder()
                               throws IOException,
                                      AutomationException
Indicates the see-through order for a floating layer.

Product Availability

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

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

getImageSamplingMode

int getImageSamplingMode()
                         throws IOException,
                                AutomationException
Image sampling mode for display.

Product Availability

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

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

getMinimumCellSize

double getMinimumCellSize()
                          throws IOException,
                                 AutomationException
Minimum cell size for rasters, in meters.

Product Availability

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

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

isDynamicallyRasterized

boolean isDynamicallyRasterized()
                                throws IOException,
                                       AutomationException
Indicates if the feature data is to be rasterized.

Product Availability

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

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

getSymbologyScalingFactor

double getSymbologyScalingFactor()
                                 throws IOException,
                                        AutomationException
The scaling factor of meters-per-point to be applied on symbol sizes during rasterization.

Product Availability

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

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

isExtruded

boolean isExtruded()
                   throws IOException,
                          AutomationException
Indicates if the feature data is to be extruded.

Product Availability

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

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

getMaxFeatureLevelOfDetail

int getMaxFeatureLevelOfDetail()
                               throws IOException,
                                      AutomationException
Level of Detail (0-31) for feature layers.

Product Availability

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

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

getImageCatalogCrossoverLevel

int getImageCatalogCrossoverLevel()
                                  throws IOException,
                                         AutomationException
Crossover Level of Detail (0-31) for image catalog layers.

Product Availability

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

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

getBaseSurfaceID

int getBaseSurfaceID()
                     throws IOException,
                            AutomationException
The layer ID of the base surface, (-1 if it doesn't exist).

Product Availability

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

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

getBaseOption

int getBaseOption()
                  throws IOException,
                         AutomationException
The base option.

Product Availability

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

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

getElevationExpression

String getElevationExpression()
                              throws IOException,
                                     AutomationException
The elevation expression string for features, in globe units.

Product Availability

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

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

getOffset

double getOffset()
                 throws IOException,
                        AutomationException
The constant elevation offset in meters.

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.

getZFactor

double getZFactor()
                  throws IOException,
                         AutomationException
The z factor.

Product Availability

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

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

isHasElevationValues

boolean isHasElevationValues()
                             throws IOException,
                                    AutomationException
Indicates whether the feature layer has elevation values.

Product Availability

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

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

isUseElevationValues

boolean isUseElevationValues()
                             throws IOException,
                                    AutomationException
Indicates whether elevation values in the feature layer are used.

Product Availability

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

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

getExtrusionType

int getExtrusionType()
                     throws IOException,
                            AutomationException
The extrusion type.

Product Availability

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

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

getExtrusionExpression

String getExtrusionExpression()
                              throws IOException,
                                     AutomationException
The extrusion expression string.

Product Availability

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

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

isIlluminate

boolean isIlluminate()
                     throws IOException,
                            AutomationException
The illumination option.

Product Availability

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

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

isSmoothShading

boolean isSmoothShading()
                        throws IOException,
                               AutomationException
The smooth shading option.

Product Availability

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

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

getFaceCulling

int getFaceCulling()
                   throws IOException,
                          AutomationException
The face culling option.

Product Availability

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

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

getGraphicsLayer

IGlobeGraphicsLayer getGraphicsLayer()
                                     throws IOException,
                                            AutomationException
The embedded Graphics Layer.

Product Availability

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

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

getCopyrightText

String getCopyrightText()
                        throws IOException,
                               AutomationException
Copyright information associated with the layer.

Product Availability

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

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