com.esri.arcgis.globecore
Interface IGlobeGraphicsLayer

All Superinterfaces:

Serializable

All Known Implementing Classes:

GlobeGraphicsLayer

public interface IGlobeGraphicsLayer
extends Serializable

Provides access to the Globe Graphics Layer.

Product Availability

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

Method Summary

void	addElement(IElement pElement, IGlobeGraphicsElementProperties pProps, int[] pElementIndex) Adds a Graphics Element with specific Globe properties.
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.
void	getElementName(IElement pElement, String[] pName) Gets the name of an element.
void	getElementTransformation(int elementIndex, IVector3D[] ppTrans, IVector3D[] ppScale, IVector3D[] ppRotate) Get the transformation of an element.
void	getGlobeProperties(IElement pElement, IGlobeGraphicsElementProperties[] ppProps) Gets specific Globe properties.
void	getIsElementVisible(int elementIndex, boolean[] pbVisible) Get the visibility of an element.
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.
void	putElementName(IElement pElement, String name) Puts the name of an element.
void	putIsElementVisible(int elementIndex, boolean bVisible) Set the visibility of an element.
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	setRasterizedSymbologyScalingFactor(double rhs1) The symbol scale factor for rasterized graphics elements.
void	updateAllElements() Refresh all elements.
void	updateElementByIndex(int elementIndex) Updates an element given its index.

Method Detail

addElement

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.

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

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

Sets specific Globe properties.

Product Availability

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

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

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

Gets specific Globe properties.

Product Availability

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

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

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.

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

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.

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

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.

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

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.

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

void updateElementByIndex(int elementIndex)
                          throws IOException,
                                 AutomationException

Updates an element given its index.

Product Availability

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

Parameters:

elementIndex - The elementIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putIsElementVisible

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.

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

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.

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

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.

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

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.

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

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.

Parameters:

pbHide - The pbHide (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHidden

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.

Returns:

The pbHide

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateAllElements

void updateAllElements()
                       throws IOException,
                              AutomationException

Refresh all elements.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasVisibleRasterizedElements

boolean isHasVisibleRasterizedElements()
                                       throws IOException,
                                              AutomationException

Indicates if there are visible rasterized elements.

Product Availability

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

Returns:

The pbVisibleRasterized

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterizedSymbologyScalingFactor

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.

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHasPerElementIllumination

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.

Parameters:

bHasPerElementIllumination - The bHasPerElementIllumination (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasPerElementIllumination

boolean isHasPerElementIllumination()
                                    throws IOException,
                                           AutomationException

The option to apply per-element illumination.

Product Availability

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

Returns:

The bHasPerElementIllumination

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsSelectable

void setIsSelectable(boolean bIsSelectable)
                     throws IOException,
                            AutomationException

The option to allow element selection.

Product Availability

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

Parameters:

bIsSelectable - The bIsSelectable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSelectable

boolean isSelectable()
                     throws IOException,
                            AutomationException

The option to allow element selection.

Product Availability

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

Returns:

The bIsSelectable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.