com.esri.arcgis.controls
Interface IEngineSnapEnvironment

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

EngineEditor, IEngineSnapEnvironmentProxy

public interface IEngineSnapEnvironment
extends java.io.Serializable

COM Interface 'IEngineSnapEnvironment'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description: 'Provides access to members that manage the snap agents used by the editor.' 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	IIDfad24a05_b217_4058_b3e2_6b306df64f68
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addSnapAgent(IEngineSnapAgent snapAgent) Adds a new snap agent to the snap environment.
void	clearSnapAgents() Removes all snap agents.
IEngineSnapAgent	getSnapAgent(int index) A snap agent at the given index.
int	getSnapAgentCount() The number of active snap agents.
double	getSnapTolerance() The snap tolerance, measured in pixels or map units.
int	getSnapToleranceUnits() The units used for the snap tolerance.
void	removeSnapAgent(int index) Removes the snap agent at the given index.
void	setSnapTolerance(double tol) The snap tolerance, measured in pixels or map units.
void	setSnapToleranceUnits(int units) The units used for the snap tolerance.
boolean	snapPoint(IPoint point) Attempts to snap the point using the current snap environment.

Field Detail

IIDfad24a05_b217_4058_b3e2_6b306df64f68

static final int IIDfad24a05_b217_4058_b3e2_6b306df64f68

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

snapPoint

boolean snapPoint(IPoint point)
                  throws java.io.IOException,
                         AutomationException

Attempts to snap the point using the current snap environment.

Parameters:

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

Returns:

The snapped

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSnapToleranceUnits

int getSnapToleranceUnits()
                          throws java.io.IOException,
                                 AutomationException

The units used for the snap tolerance.

Returns:

A com.esri.arcgis.controls.esriEngineSnapToleranceUnits constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSnapToleranceUnits

void setSnapToleranceUnits(int units)
                           throws java.io.IOException,
                                  AutomationException

The units used for the snap tolerance.

Parameters:

units - A com.esri.arcgis.controls.esriEngineSnapToleranceUnits constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSnapTolerance

double getSnapTolerance()
                        throws java.io.IOException,
                               AutomationException

The snap tolerance, measured in pixels or map units.

Returns:

The tol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSnapTolerance

void setSnapTolerance(double tol)
                      throws java.io.IOException,
                             AutomationException

The snap tolerance, measured in pixels or map units.

Parameters:

tol - The tol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSnapAgentCount

int getSnapAgentCount()
                      throws java.io.IOException,
                             AutomationException

The number of active snap agents.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSnapAgent

IEngineSnapAgent getSnapAgent(int index)
                              throws java.io.IOException,
                                     AutomationException

A snap agent at the given index.

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.controls.IEngineSnapAgent

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearSnapAgents

void clearSnapAgents()
                     throws java.io.IOException,
                            AutomationException

Removes all snap agents.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeSnapAgent

void removeSnapAgent(int index)
                     throws java.io.IOException,
                            AutomationException

Removes the snap agent at the given index.

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addSnapAgent

void addSnapAgent(IEngineSnapAgent snapAgent)
                  throws java.io.IOException,
                         AutomationException

Adds a new snap agent to the snap environment.

Parameters:

snapAgent - A reference to a com.esri.arcgis.controls.IEngineSnapAgent (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.