com.esri.arcgis.controls
Interface IEngineSnapAgent

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IEngineFeatureSnapAgent

All Known Implementing Classes:

EngineFeatureSnap, IEngineFeatureSnapAgentProxy, IEngineSnapAgentProxy

public interface IEngineSnapAgent
extends java.io.Serializable

COM Interface 'IEngineSnapAgent'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriControls.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	IIDe7ecdd8e_a513_47a1_9695_172823c329c9
static int	xxDummy Deprecated. Internal use only

Method Summary

java.lang.String	getName() The name of the engine snap agent.
boolean	snap(IGeometry geom, IPoint point, double tolerance) Fired by the Engine Editor to perform the actual snapping logic.

Field Detail

IIDe7ecdd8e_a513_47a1_9695_172823c329c9

static final int IIDe7ecdd8e_a513_47a1_9695_172823c329c9

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 engine snap agent.

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

Fired by the Engine 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.