GlobeGraphicsLayer (ArcObjects Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.globecore
Class GlobeGraphicsLayer

java.lang.Object
  com.esri.arcgis.globecore.GlobeGraphicsLayer

All Implemented Interfaces:: IGraphicsContainer3D, IGraphicsSelection, IGraphicsContainer, IGraphicsLayer, ILayer, ILayerEffects, ILayerEvents, ILayerExtensions, IPublishLayer, IConnectionPointContainer, IGeoDataset, ICustomGlobeLayer, IGlobeGraphicsLayer, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable, EventListener

public class GlobeGraphicsLayer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ILayer, IGraphicsLayer, IGlobeGraphicsLayer, ICustomGlobeLayer, IGraphicsContainer, IGraphicsContainer3D, IGraphicsSelection, ILayerExtensions, ILayerEvents, ILayerEffects, IGeoDataset, IConnectionPointContainer, IPersistStream, IPublishLayer, IXMLSerialize, IXMLVersionSupport, Externalizable
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ILayer, IGraphicsLayer, IGlobeGraphicsLayer, ICustomGlobeLayer, IGraphicsContainer, IGraphicsContainer3D, IGraphicsSelection, ILayerExtensions, ILayerEvents, ILayerEffects, IGeoDataset, IConnectionPointContainer, IPersistStream, IPublishLayer, IXMLSerialize, IXMLVersionSupport, Externalizable

The Globe Graphics Layer.

Remarks

The GlobeGraphicsLayer, the equivalent of the GraphicsLayer3D object for ArcScene, is the object to use for creating graphics layers in ArcGlobe. Similar to that for the Scene object, a basic (hidden) graphics layer is automatically added to the Globe object.

Developers can add additional globe graphics layers to a globe object in an application or a globe control through customization via ArcObjects. As with ArcGIS 9.2, globe graphics layers can only be added or managed via ArcObjects; there is not user interface yet to manually create one the ArcGlobe application program. When a globe graphics layer is added by customization (see the following sample code), it needs to be specified as the active graphics layer (via IScene.ActiveGraphicsLayer property) before it can be selected by the Select Graphics tool on the user interface.

Product Availability

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

The following code example demonstrates how to add a Marker3DSymbol to a GlobeGraphicsLayer in a GlobeBean. The symbol is created from a 3D Studio file (.3ds).

// Here, the hookHelper is a GlobeHookHelper

IScene scene = (IScene)hookHelper.getGlobe();

GlobeGraphicsLayer gl = (GlobeGraphicsLayer)scene.getActiveGraphicsLayer();



Marker3DSymbol m3dsym = new Marker3DSymbol();           

m3dsym.createFromFile("C:/temp/thead.3ds");

RgbColor color = new RgbColor();

color.setRed(255);

color.setGreen(0);

color.setBlue(0);

m3dsym.setColor(color);

m3dsym.setSize(500000.0);       

m3dsym.setMaintainAspectRatio(true);

m3dsym.setUseMaterialDraping(false);    



//Simple geometry to place symbol                       

Point point = new Point();      

point.setX(-116.0);

point.setY(34.0);

point.setZ( 0.0 );                      



MarkerElement markerElement = new MarkerElement();

markerElement.setSymbol(m3dsym);

markerElement.setGeometry(point);

gl.addElement(markerElement, 0);

hookHelper.getGlobe().getGlobeDisplay().refreshViewers();

See Also:: Serialized Form

Constructor Summary
`GlobeGraphicsLayer()` Constructs a GlobeGraphicsLayer using ArcGIS Engine.
`GlobeGraphicsLayer(Object obj)` Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. `GlobeGraphicsLayer theGlobeGraphicsLayer = (GlobeGraphicsLayer) obj;`

Method Summary
`void`	`activate(IScreenDisplay containerScreen)` Prepare to display graphic on screen.
`void`	`addElement(IElement element)` Adds a new graphic element to the container.
`void`	`addElement(IElement pElement, IGlobeGraphicsElementProperties pProps, int[] pElementIndex)` Adds a Graphics Element with specific Globe properties.
`void`	`addElement(IElement element, int zorder)` Add a new graphic element to the layer.
`void`	`addElements(IElementCollection elements)` Adds a collection of new graphic elements to the container.
`void`	`addElements(IElementCollection elements, int zorder)` Add new graphic elements to the layer.
`void`	`addExtension(Object ext)` Adds a new extension.
`void`	`addIActiveViewEventsListener(IActiveViewEvents theListener)` addIActiveViewEventsListener.
`void`	`beginBatchUpdate()` Initiates a batch update of the container.
`void`	`bringForward(IEnumElement elements)` Move the specified elements one step closer to the top of the stack of elements.
`void`	`bringToFront(IEnumElement elements)` Make the specified elements draw in front of all other elements.
`void`	`deactivate()` ActiveView that graphics are displayed on is no longer visible.
`void`	`deleteAllElements()` Delete all the elements.
`void`	`deleteAllSelectedElements()` Deletes all selected elements.
`void`	`deleteElement(IElement element)` Delete the given element.
`void`	`deserialize(IXMLSerializeData data)` Deserializes an object from XML.
`void`	`draw(int drawPhase, IDisplay display, ITrackCancel trackCancel)` Draws the layer to the specified display for the given draw phase.
`void`	`drawImmediate(IGlobeViewer pGlobeViewer)` For custom OpenGL layers, perform immediate drawing.
`boolean`	`elementSelected(IElement element)` Indicates if the element selected.
`void`	`endBatchUpdate()` Terminates a batch update of the container.
`void`	`enumConnectionPoints(IEnumConnectionPoints[] ppEnum)` enumConnectionPoints
`boolean`	`equals(Object o)` Compare this object with another
`void`	`findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)` findConnectionPoint
`void`	`findElement(String name, IElement[] ppElement, int[] pElementIndex)` Find an element by name.
`void`	`findElementIndex(IElement pElement, int[] pElementIndex)` Find an element index for fast access.
`IFrameElement`	`findFrame(Object frameObject)` Find the frame that contains the specified object.
`IEnvelope`	`getAreaOfInterest()` The default area of interest for the layer.
`ILayer`	`getAssociatedLayer()` Layer that is associated with this graphics layer.
`short`	`getBrightness()` Layer brightness in percent (-100 - 100).
`void`	`getClassID(GUID[] pClassID)` getClassID
`static String`	`getClsid()` getClsid.
`short`	`getContrast()` Layer contrast in percent (-100 - 100).
`String`	`getDataDetails(String bsPadding)` Details of the layer's data.
`int`	`getDrawType()` The custom draw method.
`IElement`	`getElement(int index)` The element in the container defined by the given index.
`int`	`getElementCount()` The number of elements in the container.
`void`	`getElementName(IElement pElement, String[] pName)` Gets the name of an element.
`Object`	`getElementOrder(IEnumElement elements)` Private order object.
`void`	`getElementTransformation(int elementIndex, IVector3D[] ppTrans, IVector3D[] ppScale, IVector3D[] ppRotate)` Get the transformation of an element.
`Object`	`getExtension(int index)` The extension at the specified index.
`int`	`getExtensionCount()` Number of extensions.
`IEnvelope`	`getExtent()` The extent of the GeoDataset.
`void`	`getGlobeProperties(IElement pElement, IGlobeGraphicsElementProperties[] ppProps)` Gets specific Globe properties.
`void`	`getIsElementVisible(int elementIndex, boolean[] pbVisible)` Get the visibility of an element.
`double`	`getMaximumScale()` Maximum scale (representative fraction) at which the layer will display.
`double`	`getMinimumCellSize()` For rasterized types, defines highest resolution.
`double`	`getMinimumScale()` Minimum scale (representative fraction) at which the layer will display.
`String`	`getMinNamespaceSupported()` The minimum namespace the class can serialize to (eg the 90 namespace).
`String`	`getName()` Layer name.
`String`	`getPublishingDescription()` The layer description reported to the publisher.
`int`	`getSelectedElementCount()` The number of selected elements.
`IEnumElement`	`getSelectedElements()` The selected elements.
`IEnvelope`	`getSelectedElementsExtent()` The extent of selected elements.
`void`	`getSizeMax(_ULARGE_INTEGER[] pcbSize)` getSizeMax
`ISpatialReference`	`getSpatialReference()` The spatial reference of the GeoDataset.
`int`	`getSupportedDrawPhases()` Supported draw phases.
`double`	`getSymbologyScalingFactor()` The symbol scale factor for the custom rasterized type.
`void`	`getTile(int tilesize, int face, int level, int row, int col, byte[][] pData)` Gets a rasterized data tile for the given globe tesselation coordinates.
`String`	`getTipText(double x, double y, double tolerance)` Map tip text at the specified location.
`short`	`getTransparency()` Layer transparency in percent (0-100).
`int`	`hashCode()` the hashcode for this object
`void`	`hit(int hitObjectID, IHit3D pHit3D)` The layer is hit by a picking operation.
`boolean`	`isCached()` Indicates if the layer needs its own display cache.
`boolean`	`isDataValid()` Indicates if the data for the layer is currently valid.
`void`	`isDirty()` isDirty
`boolean`	`isHandlesLocalOrigin()` The option to use a local coordinate system origin for high precision drawing.
`boolean`	`isHasPerElementIllumination()` The option to apply per-element illumination.
`boolean`	`isHasVisibleRasterizedElements()` Indicates if there are visible rasterized elements.
`boolean`	`isHidden()` The option to hide the graphics layer from the TOC and avoid persistency.
`boolean`	`isSelectable()` The option to allow element selection.
`boolean`	`isShowTips()` Indicates if the layer shows map tips.
`boolean`	`isSupportsBrightnessChange()` Indicates if the layer supports brightness changes.
`boolean`	`isSupportsContrastChange()` Indicates if the layer supports contrast changes.
`boolean`	`isSupportsInteractive()` Indicates if the layer supports interactive effects changes.
`boolean`	`isSupportsPublishing()` Indicates if the layer supports the publishing process.
`boolean`	`isSupportsTransparency()` Indicates if the layer supports transparency.
`boolean`	`isUseAssociatedLayerVisibility()` Indicates if the layer that is associated with this graphics layer controls the visibility.
`boolean`	`isUseCache()` The option to use Globe's disk caching.
`boolean`	`isValid()` Indicates if the layer is currently valid.
`boolean`	`isVisible()` Indicates if the layer is currently visible.
`void`	`load(IStream pstm)` load
`IEnumElement`	`locateElements(IPoint point, double tolerance)` Returns the elements at the given coordinate.
`IEnumElement`	`locateElementsByEnvelope(IEnvelope envelope)` Returns the elements inside the given envelope.
`void`	`moveElementFromGroup(IGroupElement pGroup, IElement pElement)` Move the specified element from the group to the container.
`void`	`moveElementFromGroup(IGroupElement group, IElement element, int zorder)` Move the element from the group to the container.
`void`	`moveElementToGroup(IElement element, IGroupElement group)` Move the element from the container to the group.
`IElement`	`next()` Returns the next graphic in the container.
`void`	`prepareForPublishing()` Prepare the layer for the publishing process.
`void`	`putElementName(IElement pElement, String name)` Puts the name of an element.
`void`	`putElementOrder(Object order)` Private order object.
`void`	`putIsElementVisible(int elementIndex, boolean bVisible)` Set the visibility of an element.
`void`	`readExternal(ObjectInput in)`
`void`	`removeExtension(int index)` Removes the specified extension.
`void`	`removeIActiveViewEventsListener(IActiveViewEvents theListener)` removeIActiveViewEventsListener.
`void`	`reset()` Reset internal cursor so that Next returns the first element.
`void`	`save(IStream pstm, int fClearDirty)` save
`void`	`selectAllElements()` Selects all elements.
`void`	`selectElement(IElement pElement)` Selects the specified element.
`void`	`selectElements(IEnumElement pElements)` Selects the specified elements.
`void`	`sendBackward(IEnumElement elements)` Move the specified elements one step closer to the bottom of the stack of elements.
`void`	`sendToBack(IEnumElement elements)` Make the specified elements draw behind all other elements.
`void`	`serialize(IXMLSerializeData data)` Serializes an object to XML.
`void`	`setAssociatedLayerByRef(ILayer layer)` Layer that is associated with this graphics layer.
`void`	`setBrightness(short brightnessValue)` Layer brightness in percent (-100 - 100).
`void`	`setCached(boolean cached)` Indicates if the layer needs its own display cache.
`void`	`setContrast(short contrastValue)` Layer contrast in percent (-100 - 100).
`void`	`setElementTransformation(int elementIndex, IVector3D pTrans, IVector3D pScale, IVector3D pRotate)` Set the transformation of an element.
`void`	`setGlobeProperties(IElement pElement, IGlobeGraphicsElementProperties pProps)` Sets specific Globe properties.
`void`	`setHasPerElementIllumination(boolean bHasPerElementIllumination)` The option to apply per-element illumination.
`void`	`setIsHidden(boolean pbHide)` The option to hide the graphics layer from the TOC and avoid persistency.
`void`	`setIsSelectable(boolean bIsSelectable)` The option to allow element selection.
`void`	`setLocalOrigin(_WKSPointZ rhs1)` The local coordinate system origin for high precision drawing.
`void`	`setMaximumScale(double maxScale)` Maximum scale (representative fraction) at which the layer will display.
`void`	`setMinimumScale(double minScale)` Minimum scale (representative fraction) at which the layer will display.
`void`	`setName(String name)` Layer name.
`void`	`setRasterizedSymbologyScalingFactor(double rhs1)` The symbol scale factor for rasterized graphics elements.
`void`	`setShowTips(boolean show)` Indicates if the layer shows map tips.
`void`	`setSpatialReferenceByRef(ISpatialReference rhs1)` Spatial reference for the layer.
`void`	`setSupportsInteractive(boolean supported)` Indicates if the layer supports interactive effects changes.
`void`	`setTransparency(short alpha)` Layer transparency in percent (0-100).
`void`	`setUseAssociatedLayerVisibility(boolean useLayer)` Indicates if the layer that is associated with this graphics layer controls the visibility.
`void`	`setVisible(boolean visible)` Indicates if the layer is currently visible.
`void`	`switchSelection()` Switches the selection between elements.
`void`	`unselectAllElements()` Unselects all elements.
`void`	`unselectElement(IElement pElement)` Unselects the specified element.
`void`	`unselectElements(IEnumElement pElements)` Unselects the specified elements.
`void`	`updateAllElements()` Refresh all elements.
`void`	`updateElement(IElement element)` The graphic element's properties have changed.
`void`	`updateElementByIndex(int elementIndex)` Updates an element given its index.
`void`	`visibilityChanged(ILayerEventsVisibilityChangedEvent theEvent)` Occurs when layer visibility changes.
`void`	`writeExternal(ObjectOutput out)`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
`getJintegraDispatch, release`

Constructor Detail

GlobeGraphicsLayer

public GlobeGraphicsLayer()
                   throws IOException,
                          UnknownHostException

Constructs a GlobeGraphicsLayer using ArcGIS Engine.

Throws:: IOException - if there are interop problems; UnknownHostException - if there are interop problems

GlobeGraphicsLayer

public GlobeGraphicsLayer(Object obj)
                   throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GlobeGraphicsLayer theGlobeGraphicsLayer = (GlobeGraphicsLayer) obj;

Construct a GlobeGraphicsLayer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GlobeGraphicsLayer.

Parameters:: obj - an object returned from ArcGIS Engine or Server
Throws:: IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:: equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:: hashCode in class Object

addIActiveViewEventsListener

public void addIActiveViewEventsListener(IActiveViewEvents theListener)
                                  throws IOException

addIActiveViewEventsListener. Listen to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.carto.IActiveViewEvents interface.
Throws:: IOException - If there are communications problems.

removeIActiveViewEventsListener

public void removeIActiveViewEventsListener(IActiveViewEvents theListener)
                                     throws IOException

removeIActiveViewEventsListener. Stop listening to events generated by this class.

Parameters:: theListener - An object that implements the com.esri.arcgis.carto.IActiveViewEvents interface.
Throws:: IOException - If there are communications problems.

getName

public String getName()
               throws IOException,
                      AutomationException

Layer name.

Description

Remarks

Use this property to associate a string with a layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getName in interface ILayer

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

setName

public void setName(String name)
             throws IOException,
                    AutomationException

Layer name.

Description

Use the Name property to associate a string with the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setName in interface ILayer

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

isValid

public boolean isValid()
                throws IOException,
                       AutomationException

Indicates if the layer is currently valid.

Remarks

The valid property indicates if the layer is currently valid. Layers that reference feature classes are valid when they hold a reference to a valid feature class. The property does not however validate the integrity of the feature classes reference to the database. Therefore, in rare situations if a datasource is removed after a layer is initialized, the layer will report itself as valid but query attempts to the data source will error due to the lack of underlying data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isValid in interface ILayer

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

getAreaOfInterest

public IEnvelope getAreaOfInterest()
                            throws IOException,
                                   AutomationException

The default area of interest for the layer.

Remarks

Returns the spatial-referenced extent of the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getAreaOfInterest in interface ILayer

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.

getMinimumScale

public double getMinimumScale()
                       throws IOException,
                              AutomationException

Minimum scale (representative fraction) at which the layer will display.

Remarks

Specifies the minimum scale at which the layer will be displayed. This means that if you zoom out beyond this scale, the layer will not display. For example, specify 1000 to have the layer not display when zoomed out beyond 1:1000.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMinimumScale in interface ILayer

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

setMinimumScale

public void setMinimumScale(double minScale)
                     throws IOException,
                            AutomationException

Minimum scale (representative fraction) at which the layer will display.

Description

MinimumScale property specifies the minimum scale at which the layer will be displayed. Assign a Double value to set this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setMinimumScale in interface ILayer

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

getMaximumScale

public double getMaximumScale()
                       throws IOException,
                              AutomationException

Maximum scale (representative fraction) at which the layer will display.

Remarks

Specifies the maximum scale at which the layer will be displayed. This means that if you zoom in beyond this scale, the layer will not display. For example, specify 500 to have the layer not display when zoomed in beyond 1:500.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getMaximumScale in interface ILayer

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

setMaximumScale

public void setMaximumScale(double maxScale)
                     throws IOException,
                            AutomationException

Maximum scale (representative fraction) at which the layer will display.

Description

MaximumScale property specifies the maximum scale at which the layer will be displayed. Assign a Double value to set this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setMaximumScale in interface ILayer

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

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the layer is currently visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isVisible in interface ILayer

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

setVisible

public void setVisible(boolean visible)
                throws IOException,
                       AutomationException

Indicates if the layer is currently visible.

Description

Use Visible property to set the visibility of the layer. When assigned False, the layer is invisible in the current view.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setVisible in interface ILayer

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

isShowTips

public boolean isShowTips()
                   throws IOException,
                          AutomationException

Indicates if the layer shows map tips.

Remarks

Indicates whether or not map tips are shown for the layer. If set to True, then map tips will be shown for the layer. You can determine the text that will be shown via TipText. For a FeatureLayer, this text comes from the data for IFeatureLayer::DisplayField.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isShowTips in interface ILayer

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

setShowTips

public void setShowTips(boolean show)
                 throws IOException,
                        AutomationException

Indicates if the layer shows map tips.

Description

ShowTips is set to True when the layer shows map tips specified in the TipText property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setShowTips in interface ILayer

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

getTipText

public String getTipText(double x,
                         double y,
                         double tolerance)
                  throws IOException,
                         AutomationException

Map tip text at the specified location.

Product Availability

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

Specified by:: getTipText in interface ILayer

Parameters:: x - The x (in); y - The y (in); tolerance - The tolerance (in)
Returns:: The text
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isCached

public boolean isCached()
                 throws IOException,
                        AutomationException

Indicates if the layer needs its own display cache.

Remarks

This property indicates whether or not the layer requires its own display cache. If this property is True, then the Map will use a separate display cache for the layer so that it can be refreshed indpendently of other layers.

The Map is responsible for cache management. See IScreenDisplay::AddCache for more information on caches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isCached in interface ILayer

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

setCached

public void setCached(boolean cached)
               throws IOException,
                      AutomationException

Indicates if the layer needs its own display cache.

Description

Use Cached property to indicate if the layer needs its own cache for display.

Remarks

Informational property. Container is responsible for cache management.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setCached in interface ILayer

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

getSupportedDrawPhases

public int getSupportedDrawPhases()
                           throws IOException,
                                  AutomationException

Supported draw phases.

Remarks

Indicates the draw phases supported by the layer (esriDPGeography, esriDPAnnotation, esriDPSelection, or any combination of the three). The supported draw phases are defined by esriDrawPhase. When multiple draw phases are supported, the sum of the constants is used. For example, if SupportedDrawPhases = 3 then the layer supports drawing in the geography and annotation phases.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSupportedDrawPhases in interface ILayer

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

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference rhs1)
                              throws IOException,
                                     AutomationException

Spatial reference for the layer.

Remarks

This property is only used for map display, setting this property does not change the spatial reference of the layer's underlying data. The ArcGIS framework uses this property to pass the spatial reference from the map to the layer in order to support on-the-fly projection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSpatialReferenceByRef in interface ILayer

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

draw

public void draw(int drawPhase,
                 IDisplay display,
                 ITrackCancel trackCancel)
          throws IOException,
                 AutomationException

Draws the layer to the specified display for the given draw phase.

Remarks

This method draws the layer to the Display for the specified DrawPhase. Use the TrackCancel object to allow the drawing of the layer to be interrupted by the user.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: draw in interface ILayer

Parameters:: drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in); display - A reference to a com.esri.arcgis.display.IDisplay (in); trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

activate

public void activate(IScreenDisplay containerScreen)
              throws IOException,
                     AutomationException

Prepare to display graphic on screen.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: activate in interface IGraphicsLayer

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

deactivate

public void deactivate()
                throws IOException,
                       AutomationException

ActiveView that graphics are displayed on is no longer visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: deactivate in interface IGraphicsLayer

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

isUseAssociatedLayerVisibility

public boolean isUseAssociatedLayerVisibility()
                                       throws IOException,
                                              AutomationException

Indicates if the layer that is associated with this graphics layer controls the visibility.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isUseAssociatedLayerVisibility in interface IGraphicsLayer

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

setUseAssociatedLayerVisibility

public void setUseAssociatedLayerVisibility(boolean useLayer)
                                     throws IOException,
                                            AutomationException

Indicates if the layer that is associated with this graphics layer controls the visibility.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setUseAssociatedLayerVisibility in interface IGraphicsLayer

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

getAssociatedLayer

public ILayer getAssociatedLayer()
                          throws IOException,
                                 AutomationException

Layer that is associated with this graphics layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getAssociatedLayer in interface IGraphicsLayer

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

setAssociatedLayerByRef

public void setAssociatedLayerByRef(ILayer layer)
                             throws IOException,
                                    AutomationException

Layer that is associated with this graphics layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setAssociatedLayerByRef in interface IGraphicsLayer

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

addElement

public void addElement(IElement pElement,
                       IGlobeGraphicsElementProperties pProps,
                       int[] pElementIndex)
                throws IOException,
                       AutomationException

Adds a Graphics Element with specific Globe properties.

Product Availability

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

Specified by:: addElement in interface IGlobeGraphicsLayer

Parameters:: pElement - A reference to a com.esri.arcgis.carto.IElement (in); pProps - A reference to a com.esri.arcgis.globecore.IGlobeGraphicsElementProperties (in); pElementIndex - The pElementIndex (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setGlobeProperties

public void setGlobeProperties(IElement pElement,
                               IGlobeGraphicsElementProperties pProps)
                        throws IOException,
                               AutomationException

Sets specific Globe properties.

Product Availability

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

Specified by:: setGlobeProperties in interface IGlobeGraphicsLayer

Parameters:: pElement - A reference to a com.esri.arcgis.carto.IElement (in); pProps - A reference to a com.esri.arcgis.globecore.IGlobeGraphicsElementProperties (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getGlobeProperties

public void getGlobeProperties(IElement pElement,
                               IGlobeGraphicsElementProperties[] ppProps)
                        throws IOException,
                               AutomationException

Gets specific Globe properties.

Product Availability

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

Specified by:: getGlobeProperties in interface IGlobeGraphicsLayer

Parameters:: pElement - A reference to a com.esri.arcgis.carto.IElement (in); ppProps - A reference to a com.esri.arcgis.globecore.IGlobeGraphicsElementProperties (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

putElementName

public void putElementName(IElement pElement,
                           String name)
                    throws IOException,
                           AutomationException

Puts the name of an element.

Product Availability

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

Specified by:: putElementName in interface IGlobeGraphicsLayer

Parameters:: pElement - A reference to a com.esri.arcgis.carto.IElement (in); name - The name (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getElementName

public void getElementName(IElement pElement,
                           String[] pName)
                    throws IOException,
                           AutomationException

Gets the name of an element.

Product Availability

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

Specified by:: getElementName in interface IGlobeGraphicsLayer

Parameters:: pElement - A reference to a com.esri.arcgis.carto.IElement (in); pName - The pName (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

findElement

public void findElement(String name,
                        IElement[] ppElement,
                        int[] pElementIndex)
                 throws IOException,
                        AutomationException

Find an element by name.

Product Availability

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

Specified by:: findElement in interface IGlobeGraphicsLayer

Parameters:: name - The name (in); ppElement - A reference to a com.esri.arcgis.carto.IElement (out: use single element array); pElementIndex - The pElementIndex (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

findElementIndex

public void findElementIndex(IElement pElement,
                             int[] pElementIndex)
                      throws IOException,
                             AutomationException

Find an element index for fast access.

Product Availability

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

Specified by:: findElementIndex in interface IGlobeGraphicsLayer

Parameters:: pElement - A reference to a com.esri.arcgis.carto.IElement (in); pElementIndex - The pElementIndex (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

updateElementByIndex

public void updateElementByIndex(int elementIndex)
                          throws IOException,
                                 AutomationException

Updates an element given its index.

Product Availability

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

Specified by:: updateElementByIndex in interface IGlobeGraphicsLayer

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

putIsElementVisible

public void putIsElementVisible(int elementIndex,
                                boolean bVisible)
                         throws IOException,
                                AutomationException

Set the visibility of an element.

Product Availability

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

Specified by:: putIsElementVisible in interface IGlobeGraphicsLayer

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

getIsElementVisible

public void getIsElementVisible(int elementIndex,
                                boolean[] pbVisible)
                         throws IOException,
                                AutomationException

Get the visibility of an element.

Product Availability

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

Specified by:: getIsElementVisible in interface IGlobeGraphicsLayer

Parameters:: elementIndex - The elementIndex (in); pbVisible - The pbVisible (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setElementTransformation

public void setElementTransformation(int elementIndex,
                                     IVector3D pTrans,
                                     IVector3D pScale,
                                     IVector3D pRotate)
                              throws IOException,
                                     AutomationException

Set the transformation of an element.

Product Availability

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

Specified by:: setElementTransformation in interface IGlobeGraphicsLayer

Parameters:: elementIndex - The elementIndex (in); pTrans - A reference to a com.esri.arcgis.geometry.IVector3D (in); pScale - A reference to a com.esri.arcgis.geometry.IVector3D (in); pRotate - A reference to a com.esri.arcgis.geometry.IVector3D (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getElementTransformation

public void getElementTransformation(int elementIndex,
                                     IVector3D[] ppTrans,
                                     IVector3D[] ppScale,
                                     IVector3D[] ppRotate)
                              throws IOException,
                                     AutomationException

Get the transformation of an element.

Product Availability

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

Specified by:: getElementTransformation in interface IGlobeGraphicsLayer

Parameters:: elementIndex - The elementIndex (in); ppTrans - A reference to a com.esri.arcgis.geometry.IVector3D (out: use single element array); ppScale - A reference to a com.esri.arcgis.geometry.IVector3D (out: use single element array); ppRotate - A reference to a com.esri.arcgis.geometry.IVector3D (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setIsHidden

public void setIsHidden(boolean pbHide)
                 throws IOException,
                        AutomationException

The option to hide the graphics layer from the TOC and avoid persistency.

Product Availability

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

Specified by:: setIsHidden in interface IGlobeGraphicsLayer

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

isHidden

public boolean isHidden()
                 throws IOException,
                        AutomationException

The option to hide the graphics layer from the TOC and avoid persistency.

Product Availability

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

Specified by:: isHidden in interface IGlobeGraphicsLayer

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

updateAllElements

public void updateAllElements()
                       throws IOException,
                              AutomationException

Refresh all elements.

Product Availability

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

Specified by:: updateAllElements in interface IGlobeGraphicsLayer

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

isHasVisibleRasterizedElements

public boolean isHasVisibleRasterizedElements()
                                       throws IOException,
                                              AutomationException

Indicates if there are visible rasterized elements.

Product Availability

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

Specified by:: isHasVisibleRasterizedElements in interface IGlobeGraphicsLayer

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

setRasterizedSymbologyScalingFactor

public void setRasterizedSymbologyScalingFactor(double rhs1)
                                         throws IOException,
                                                AutomationException

The symbol scale factor for rasterized graphics elements.

Product Availability

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

Specified by:: setRasterizedSymbologyScalingFactor in interface IGlobeGraphicsLayer

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

setHasPerElementIllumination

public void setHasPerElementIllumination(boolean bHasPerElementIllumination)
                                  throws IOException,
                                         AutomationException

The option to apply per-element illumination.

Product Availability

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

Specified by:: setHasPerElementIllumination in interface IGlobeGraphicsLayer

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

isHasPerElementIllumination

public boolean isHasPerElementIllumination()
                                    throws IOException,
                                           AutomationException

The option to apply per-element illumination.

Product Availability

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

Specified by:: isHasPerElementIllumination in interface IGlobeGraphicsLayer

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

setIsSelectable

public void setIsSelectable(boolean bIsSelectable)
                     throws IOException,
                            AutomationException

The option to allow element selection.

Product Availability

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

Specified by:: setIsSelectable in interface IGlobeGraphicsLayer

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

isSelectable

public boolean isSelectable()
                     throws IOException,
                            AutomationException

The option to allow element selection.

Product Availability

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

Specified by:: isSelectable in interface IGlobeGraphicsLayer

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

getDrawType

public int getDrawType()
                throws IOException,
                       AutomationException

The custom draw method.

Product Availability

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

Specified by:: getDrawType in interface ICustomGlobeLayer

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

isUseCache

public boolean isUseCache()
                   throws IOException,
                          AutomationException

The option to use Globe's disk caching.

Product Availability

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

Specified by:: isUseCache in interface ICustomGlobeLayer

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

getMinimumCellSize

public double getMinimumCellSize()
                          throws IOException,
                                 AutomationException

For rasterized types, defines highest resolution. Zero value indicates that globe-generated default value should be used.

Product Availability

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

Specified by:: getMinimumCellSize in interface ICustomGlobeLayer

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

getSymbologyScalingFactor

public double getSymbologyScalingFactor()
                                 throws IOException,
                                        AutomationException

The symbol scale factor for the custom rasterized type.

Product Availability

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

Specified by:: getSymbologyScalingFactor in interface ICustomGlobeLayer

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

getTile

public void getTile(int tilesize,
                    int face,
                    int level,
                    int row,
                    int col,
                    byte[][] pData)
             throws IOException,
                    AutomationException

Gets a rasterized data tile for the given globe tesselation coordinates.

Product Availability

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

Specified by:: getTile in interface ICustomGlobeLayer

Parameters:: tilesize - The tilesize (in); face - The face (in); level - The level (in); row - The row (in); col - The col (in); pData - An unsigned byte (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

drawImmediate

public void drawImmediate(IGlobeViewer pGlobeViewer)
                   throws IOException,
                          AutomationException

For custom OpenGL layers, perform immediate drawing.

Product Availability

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

Specified by:: drawImmediate in interface ICustomGlobeLayer

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

hit

public void hit(int hitObjectID,
                IHit3D pHit3D)
         throws IOException,
                AutomationException

The layer is hit by a picking operation.

Product Availability

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

Specified by:: hit in interface ICustomGlobeLayer

Parameters:: hitObjectID - The hitObjectID (in); pHit3D - A reference to a com.esri.arcgis.analyst3d.IHit3D (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isHandlesLocalOrigin

public boolean isHandlesLocalOrigin()
                             throws IOException,
                                    AutomationException

The option to use a local coordinate system origin for high precision drawing.

Product Availability

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

Specified by:: isHandlesLocalOrigin in interface ICustomGlobeLayer

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

setLocalOrigin

public void setLocalOrigin(_WKSPointZ rhs1)
                    throws IOException,
                           AutomationException

The local coordinate system origin for high precision drawing.

Product Availability

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

Specified by:: setLocalOrigin in interface ICustomGlobeLayer

Parameters:: rhs1 - A Structure: com.esri.arcgis.system._WKSPointZ (A com.esri.arcgis.system._WKSPointZ COM typedef) (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

public IElement next()
              throws IOException,
                     AutomationException

Returns the next graphic in the container.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: next in interface IGraphicsContainer3D
Specified by:: next in interface IGraphicsContainer

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

reset

public void reset()
           throws IOException,
                  AutomationException

Reset internal cursor so that Next returns the first element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: reset in interface IGraphicsContainer3D
Specified by:: reset in interface IGraphicsContainer

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

addElement

public void addElement(IElement element,
                       int zorder)
                throws IOException,
                       AutomationException

Add a new graphic element to the layer.

Description

This method adds the input element the graphics container referenced. The parameter zorder is currently not utilized by all of the IGraphicsContainer implementations and is typically set to 0 when calling this method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addElement in interface IGraphicsContainer

Parameters:: element - A reference to a com.esri.arcgis.carto.IElement (in); zorder - The zorder (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addElements

public void addElements(IElementCollection elements,
                        int zorder)
                 throws IOException,
                        AutomationException

Add new graphic elements to the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addElements in interface IGraphicsContainer

Parameters:: elements - A reference to a com.esri.arcgis.carto.IElementCollection (in); zorder - The zorder (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

deleteElement

public void deleteElement(IElement element)
                   throws IOException,
                          AutomationException

Delete the given element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: deleteElement in interface IGraphicsContainer3D
Specified by:: deleteElement in interface IGraphicsContainer

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

deleteAllElements

public void deleteAllElements()
                       throws IOException,
                              AutomationException

Delete all the elements.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: deleteAllElements in interface IGraphicsContainer3D
Specified by:: deleteAllElements in interface IGraphicsContainer

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

moveElementToGroup

public void moveElementToGroup(IElement element,
                               IGroupElement group)
                        throws IOException,
                               AutomationException

Move the element from the container to the group.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: moveElementToGroup in interface IGraphicsContainer3D
Specified by:: moveElementToGroup in interface IGraphicsContainer

Parameters:: element - A reference to a com.esri.arcgis.carto.IElement (in); group - A reference to a com.esri.arcgis.carto.IGroupElement (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

moveElementFromGroup

public void moveElementFromGroup(IGroupElement group,
                                 IElement element,
                                 int zorder)
                          throws IOException,
                                 AutomationException

Move the element from the group to the container.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: moveElementFromGroup in interface IGraphicsContainer

Parameters:: group - A reference to a com.esri.arcgis.carto.IGroupElement (in); element - A reference to a com.esri.arcgis.carto.IElement (in); zorder - The zorder (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

locateElements

public IEnumElement locateElements(IPoint point,
                                   double tolerance)
                            throws IOException,
                                   AutomationException

Returns the elements at the given coordinate.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: locateElements in interface IGraphicsContainer3D
Specified by:: locateElements in interface IGraphicsContainer

Parameters:: point - A reference to a com.esri.arcgis.geometry.IPoint (in); tolerance - The tolerance (in)
Returns:: A reference to a com.esri.arcgis.carto.IEnumElement
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

locateElementsByEnvelope

public IEnumElement locateElementsByEnvelope(IEnvelope envelope)
                                      throws IOException,
                                             AutomationException

Returns the elements inside the given envelope.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: locateElementsByEnvelope in interface IGraphicsContainer3D
Specified by:: locateElementsByEnvelope in interface IGraphicsContainer

Parameters:: envelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Returns:: A reference to a com.esri.arcgis.carto.IEnumElement
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

findFrame

public IFrameElement findFrame(Object frameObject)
                        throws IOException,
                               AutomationException

Find the frame that contains the specified object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: findFrame in interface IGraphicsContainer

Parameters:: frameObject - A Variant (in)
Returns:: A reference to a com.esri.arcgis.carto.IFrameElement
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

updateElement

public void updateElement(IElement element)
                   throws IOException,
                          AutomationException

The graphic element's properties have changed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: updateElement in interface IGraphicsContainer

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

getElementOrder

public Object getElementOrder(IEnumElement elements)
                       throws IOException,
                              AutomationException

Private order object. Used to undo ordering operations.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getElementOrder in interface IGraphicsContainer

Parameters:: elements - A reference to a com.esri.arcgis.carto.IEnumElement (in)
Returns:: A Variant
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

putElementOrder

public void putElementOrder(Object order)
                     throws IOException,
                            AutomationException

Private order object. Used to undo ordering operations.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: putElementOrder in interface IGraphicsContainer

Parameters:: order - A Variant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

bringToFront

public void bringToFront(IEnumElement elements)
                  throws IOException,
                         AutomationException

Make the specified elements draw in front of all other elements.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: bringToFront in interface IGraphicsContainer

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

sendToBack

public void sendToBack(IEnumElement elements)
                throws IOException,
                       AutomationException

Make the specified elements draw behind all other elements.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: sendToBack in interface IGraphicsContainer

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

sendBackward

public void sendBackward(IEnumElement elements)
                  throws IOException,
                         AutomationException

Move the specified elements one step closer to the bottom of the stack of elements.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: sendBackward in interface IGraphicsContainer

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

bringForward

public void bringForward(IEnumElement elements)
                  throws IOException,
                         AutomationException

Move the specified elements one step closer to the top of the stack of elements.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: bringForward in interface IGraphicsContainer

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

getElementCount

public int getElementCount()
                    throws IOException,
                           AutomationException

The number of elements in the container.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getElementCount in interface IGraphicsContainer3D

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

getElement

public IElement getElement(int index)
                    throws IOException,
                           AutomationException

The element in the container defined by the given index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Specified by:: getElement in interface IGraphicsContainer3D

Parameters:: index - The index (in)
Returns:: A reference to a com.esri.arcgis.carto.IElement
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

beginBatchUpdate

public void beginBatchUpdate()
                      throws IOException,
                             AutomationException

Initiates a batch update of the container.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: beginBatchUpdate in interface IGraphicsContainer3D

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

endBatchUpdate

public void endBatchUpdate()
                    throws IOException,
                           AutomationException

Terminates a batch update of the container.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: endBatchUpdate in interface IGraphicsContainer3D

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

addElement

public void addElement(IElement element)
                throws IOException,
                       AutomationException

Adds a new graphic element to the container.

Remarks

All vertices of Geometries of Elements added to a 3D Graphics Container must be Z-Simple (non-NaN).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: addElement in interface IGraphicsContainer3D

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

addElements

public void addElements(IElementCollection elements)
                 throws IOException,
                        AutomationException

Adds a collection of new graphic elements to the container.

Remarks

All vertices of Geometries of Elements added to a 3D Graphics Container must be Z-Simple (non-NaN).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: addElements in interface IGraphicsContainer3D

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

moveElementFromGroup

public void moveElementFromGroup(IGroupElement pGroup,
                                 IElement pElement)
                          throws IOException,
                                 AutomationException

Move the specified element from the group to the container.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: moveElementFromGroup in interface IGraphicsContainer3D

Parameters:: pGroup - A reference to a com.esri.arcgis.carto.IGroupElement (in); pElement - A reference to a com.esri.arcgis.carto.IElement (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

selectElement

public void selectElement(IElement pElement)
                   throws IOException,
                          AutomationException

Selects the specified element.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: selectElement in interface IGraphicsSelection

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

selectElements

public void selectElements(IEnumElement pElements)
                    throws IOException,
                           AutomationException

Selects the specified elements.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: selectElements in interface IGraphicsSelection

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

selectAllElements

public void selectAllElements()
                       throws IOException,
                              AutomationException

Selects all elements.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: selectAllElements in interface IGraphicsSelection

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

unselectElement

public void unselectElement(IElement pElement)
                     throws IOException,
                            AutomationException

Unselects the specified element.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: unselectElement in interface IGraphicsSelection

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

unselectElements

public void unselectElements(IEnumElement pElements)
                      throws IOException,
                             AutomationException

Unselects the specified elements.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: unselectElements in interface IGraphicsSelection

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

unselectAllElements

public void unselectAllElements()
                         throws IOException,
                                AutomationException

Unselects all elements.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: unselectAllElements in interface IGraphicsSelection

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

deleteAllSelectedElements

public void deleteAllSelectedElements()
                               throws IOException,
                                      AutomationException

Deletes all selected elements.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: deleteAllSelectedElements in interface IGraphicsSelection

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

switchSelection

public void switchSelection()
                     throws IOException,
                            AutomationException

Switches the selection between elements.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: switchSelection in interface IGraphicsSelection

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

getSelectedElements

public IEnumElement getSelectedElements()
                                 throws IOException,
                                        AutomationException

The selected elements.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSelectedElements in interface IGraphicsSelection

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

getSelectedElementCount

public int getSelectedElementCount()
                            throws IOException,
                                   AutomationException

The number of selected elements.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSelectedElementCount in interface IGraphicsSelection

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

getSelectedElementsExtent

public IEnvelope getSelectedElementsExtent()
                                    throws IOException,
                                           AutomationException

The extent of selected elements.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSelectedElementsExtent in interface IGraphicsSelection

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.

elementSelected

public boolean elementSelected(IElement element)
                        throws IOException,
                               AutomationException

Indicates if the element selected.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:: elementSelected in interface IGraphicsSelection

Parameters:: element - A reference to a com.esri.arcgis.carto.IElement (in)
Returns:: The pbIsSelected
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getExtensionCount

public int getExtensionCount()
                      throws IOException,
                             AutomationException

Number of extensions.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getExtensionCount in interface ILayerExtensions

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

getExtension

public Object getExtension(int index)
                    throws IOException,
                           AutomationException

The extension at the specified index.

Product Availability

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

Specified by:: getExtension in interface ILayerExtensions

Parameters:: index - The index (in)
Returns:: A reference to another Object (IUnknown)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addExtension

public void addExtension(Object ext)
                  throws IOException,
                         AutomationException

Adds a new extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addExtension in interface ILayerExtensions

Parameters:: ext - A reference to another Object (IUnknown) (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

removeExtension

public void removeExtension(int index)
                     throws IOException,
                            AutomationException

Removes the specified extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeExtension in interface ILayerExtensions

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

visibilityChanged

public void visibilityChanged(ILayerEventsVisibilityChangedEvent theEvent)
                       throws IOException,
                              AutomationException

Occurs when layer visibility changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: visibilityChanged in interface ILayerEvents

Parameters:: theEvent - The event
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSupportsTransparency

public boolean isSupportsTransparency()
                               throws IOException,
                                      AutomationException

Indicates if the layer supports transparency.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSupportsTransparency in interface ILayerEffects

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

isSupportsContrastChange

public boolean isSupportsContrastChange()
                                 throws IOException,
                                        AutomationException

Indicates if the layer supports contrast changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSupportsContrastChange in interface ILayerEffects

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

isSupportsBrightnessChange

public boolean isSupportsBrightnessChange()
                                   throws IOException,
                                          AutomationException

Indicates if the layer supports brightness changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSupportsBrightnessChange in interface ILayerEffects

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

setSupportsInteractive

public void setSupportsInteractive(boolean supported)
                            throws IOException,
                                   AutomationException

Indicates if the layer supports interactive effects changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSupportsInteractive in interface ILayerEffects

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

isSupportsInteractive

public boolean isSupportsInteractive()
                              throws IOException,
                                     AutomationException

Indicates if the layer supports interactive effects changes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSupportsInteractive in interface ILayerEffects

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

getTransparency

public short getTransparency()
                      throws IOException,
                             AutomationException

Layer transparency in percent (0-100).

Remarks

When you set Transparency for a FeatureLayer, a TransparencyDisplayFilter is created and applied to the layer. You can accomplish the same effect by manually creating a new TransparencyDisplayFilter using IDisplayFilter, and then assigning it to a layer using IDisplayFilterManager.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getTransparency in interface ILayerEffects

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

setTransparency

public void setTransparency(short alpha)
                     throws IOException,
                            AutomationException

Layer transparency in percent (0-100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setTransparency in interface ILayerEffects

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

getContrast

public short getContrast()
                  throws IOException,
                         AutomationException

Layer contrast in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getContrast in interface ILayerEffects

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

setContrast

public void setContrast(short contrastValue)
                 throws IOException,
                        AutomationException

Layer contrast in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setContrast in interface ILayerEffects

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

getBrightness

public short getBrightness()
                    throws IOException,
                           AutomationException

Layer brightness in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getBrightness in interface ILayerEffects

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

setBrightness

public void setBrightness(short brightnessValue)
                   throws IOException,
                          AutomationException

Layer brightness in percent (-100 - 100).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setBrightness in interface ILayerEffects

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

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

The spatial reference of the GeoDataset.

Remarks

This property is read only. For layers, when the first layer is added to ArcMap, its spatial reference is read by this property, and the map is set to this spatial reference.

Instances of the esriCarto.GroupLayer class will return null for this property, as a group layer can contain multiple datasets with different spatial references.

Modifications to a spatial reference returned by this property will not be persisted. To modify the spatial reference of a dataset, the IGeoDatasetSchemaEdit and IGeoDatasetSchemaEdit2 interfaces should be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSpatialReference in interface IGeoDataset

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

getExtent

public IEnvelope getExtent()
                    throws IOException,
                           AutomationException

The extent of the GeoDataset.

Remarks

The IGeoDataset::Extent property returns an envelope representing the maximum extent of data which has been stored in the dataset.

Consider the following scenario. A new feature class has features added to it. The IGeoDataset::Extent is then requested and an envelope is returned. The extents of the envelope returned are represented by the red box in the image below.

The red box represents the IGeoDataset extent

If a portion of the features were then deleted and the extent is again requested an envelope with the exact same extents as during the first request would be returned (see image below). This is because the deletion of features does not shrink the extent. However all additions of features outside the red box would increase the envelope returned to encompass the newly added features.

The red box represents the IGeoDataset extent after some of the features have been deleted

If you would like to update the IGeoDataset::Extent property to reflect the current features in your dataset please see IFeatureClassManage::UpdateExtent (also see IFeatureClassLoad). In the image below the extent has been updated and a new envelope is being returned.

The red box represents the IGeoDataset extent after it has been updated

ESRI's GroupLayer implements this property differently from most other layer coclasses. When you instantiate a new GroupLayer, this property will return a valid envelope with zero height and width. With most other newly instantiated layers (for example FeatureLayer, RasterLayer, TinLayer), this property initally returns Nothing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getExtent in interface IGeoDataset

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.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws IOException,
                                 AutomationException

enumConnectionPoints

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: enumConnectionPoints in interface IConnectionPointContainer

Parameters:: ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws IOException,
                                AutomationException

findConnectionPoint

Description

IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: findConnectionPoint in interface IConnectionPointContainer

Parameters:: riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in); ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isDirty in interface IPersistStream

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

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: load in interface IPersistStream

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

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: save in interface IPersistStream

Parameters:: pstm - A reference to a com.esri.arcgis.system.IStream (in); fClearDirty - The fClearDirty (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSizeMax in interface IPersistStream

Parameters:: pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getClassID in interface IPersist

Parameters:: pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isSupportsPublishing

public boolean isSupportsPublishing()
                             throws IOException,
                                    AutomationException

Indicates if the layer supports the publishing process.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSupportsPublishing in interface IPublishLayer

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

getPublishingDescription

public String getPublishingDescription()
                                throws IOException,
                                       AutomationException

The layer description reported to the publisher.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getPublishingDescription in interface IPublishLayer

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

isDataValid

public boolean isDataValid()
                    throws IOException,
                           AutomationException

Indicates if the data for the layer is currently valid.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isDataValid in interface IPublishLayer

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

getDataDetails

public String getDataDetails(String bsPadding)
                      throws IOException,
                             AutomationException

Details of the layer's data.

Product Availability

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

Specified by:: getDataDetails in interface IPublishLayer

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

prepareForPublishing

public void prepareForPublishing()
                          throws IOException,
                                 AutomationException

Prepare the layer for the publishing process.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: prepareForPublishing in interface IPublishLayer

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

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: serialize in interface IXMLSerialize

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

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: deserialize in interface IXMLSerialize

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

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Product Availability

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

Specified by:: getMinNamespaceSupported in interface IXMLVersionSupport

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

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:: writeExternal in interface Externalizable

Throws:: IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:: readExternal in interface Externalizable

Throws:: IOException; ClassNotFoundException

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.globecore Class GlobeGraphicsLayer

Remarks

Product Availability

GlobeGraphicsLayer

GlobeGraphicsLayer

getClsid

equals

hashCode

addIActiveViewEventsListener

removeIActiveViewEventsListener

getName

Description

Remarks

Product Availability

Supported Platforms

setName

Description

Product Availability

Supported Platforms

isValid

Remarks

Product Availability

Supported Platforms

getAreaOfInterest

Remarks

Product Availability

Supported Platforms

getMinimumScale

Remarks

Product Availability

Supported Platforms

setMinimumScale

Description

Product Availability

Supported Platforms

getMaximumScale

Remarks

Product Availability

Supported Platforms

setMaximumScale

Description

Product Availability

Supported Platforms

isVisible

Product Availability

Supported Platforms

setVisible

Description

Product Availability

Supported Platforms

isShowTips

Remarks

Product Availability

Supported Platforms

setShowTips

Description

Product Availability

Supported Platforms

getTipText

Product Availability

isCached

Remarks

Product Availability

Supported Platforms

setCached

Description

Remarks

Product Availability

Supported Platforms

getSupportedDrawPhases

Remarks

Product Availability

Supported Platforms

setSpatialReferenceByRef

Remarks

Product Availability

Supported Platforms

draw

Remarks

Product Availability

com.esri.arcgis.globecore
Class GlobeGraphicsLayer