com.esri.arcgis.analyst3d
Interface IGraphicsContainer3D

All Superinterfaces:

Serializable

All Known Implementing Classes:

GlobeGraphicsLayer, GraphicsLayer3D

public interface IGraphicsContainer3D
extends Serializable

Provides access to members that manipulate the graphics container.

Product Availability

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

Method Summary

void	addElement(IElement element) Adds a new graphic element to the container.
void	addElements(IElementCollection elements) Adds a collection of new graphic elements to the container.
void	beginBatchUpdate() Initiates a batch update of the container.
void	deleteAllElements() Deletes all the elements.
void	deleteElement(IElement element) Deletes the given element.
void	endBatchUpdate() Terminates a batch update of the container.
IElement	getElement(int index) The element in the container defined by the given index.
int	getElementCount() The number of elements in the container.
IEnumElement	locateElements(IPoint pPoint, double tolerance) Returns the elements that intersect with the given ray.
IEnumElement	locateElementsByEnvelope(IEnvelope pEnvelope) Returns the elements that intersect with the given envelope.
void	moveElementFromGroup(IGroupElement pGroup, IElement pElement) Move the specified element from the group to the container.
void	moveElementToGroup(IElement pElement, IGroupElement pGroup) Move the specified element from the container to the group.
IElement	next() The next graphic in the container.
void	reset() Resets the internal cursor so that 'Next' returns the first element.

Method Detail

next

IElement next()
              throws IOException,
                     AutomationException

The next graphic in the container.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

void reset()
           throws IOException,
                  AutomationException

Resets the internal cursor so that 'Next' returns the first element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElementCount

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

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElement

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.

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

endBatchUpdate

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addElement

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

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

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

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.

deleteElement

void deleteElement(IElement element)
                   throws IOException,
                          AutomationException

Deletes the given element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

void deleteAllElements()
                       throws IOException,
                              AutomationException

Deletes all the elements.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

moveElementToGroup

void moveElementToGroup(IElement pElement,
                        IGroupElement pGroup)
                        throws IOException,
                               AutomationException

Move the specified element from the container to the group.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pElement - A reference to a com.esri.arcgis.carto.IElement (in)

pGroup - 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

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

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.

locateElements

IEnumElement locateElements(IPoint pPoint,
                            double tolerance)
                            throws IOException,
                                   AutomationException

Returns the elements that intersect with the given ray.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pPoint - 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

IEnumElement locateElementsByEnvelope(IEnvelope pEnvelope)
                                      throws IOException,
                                             AutomationException

Returns the elements that intersect with the given envelope.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pEnvelope - 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.