com.esri.arcgis.editor
Interface ISnapAgent

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IFeatureSnapAgent, IFeatureSnapAgent2

All Known Implementing Classes:

FeatureSnap, IFeatureSnapAgent2Proxy, IFeatureSnapAgentProxy, ISnapAgentProxy

public interface ISnapAgent
extends java.io.Serializable

COM Interface 'ISnapAgent'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriEditor.olb'

Description: 'Provides access to members that snap point locations using a tolerance.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID2866e6b3_c00b_11d0_802b_0000f8037368
static int	xxDummy Deprecated. Internal use only

Method Summary

java.lang.String	getName() The name of the snap agent shown in the UI.
boolean	snap(IGeometry geom, IPoint point, double tolerance) Called by the editor to perform the actual snapping logic.

Field Detail

IID2866e6b3_c00b_11d0_802b_0000f8037368

static final int IID2866e6b3_c00b_11d0_802b_0000f8037368

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the snap agent shown in the UI.

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

snap

boolean snap(IGeometry geom,
             IPoint point,
             double tolerance)
             throws java.io.IOException,
                    AutomationException

Called by the editor to perform the actual snapping logic.

Parameters:

geom - A reference to a com.esri.arcgis.geometry.IGeometry (in)

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

tolerance - The tolerance (in)

Returns:

The snapped

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.