com.esri.arcgis.editor
Interface ISnapEnvironment3

All Superinterfaces:

ISnapEnvironment, ISnapEnvironment2, Serializable

All Known Implementing Classes:

Editor, ISnapEnvironment3Proxy

public interface ISnapEnvironment3
extends ISnapEnvironment2, Serializable

Provides access to members used to manipulate the snap environment for contraints.

Product Availability

Available with ArcGIS Desktop.

Method Summary

boolean	fullPointSnap(IPoint point) Always attempts to snap the point using the current snap environment.
boolean	snapToIntersection(IPoint point, IGeometry pIntersection) Attempts to snap the specified point to the given intersection.

Methods inherited from interface com.esri.arcgis.editor.ISnapEnvironment2

getSnapZTolerance, isUseSnapZTolerance, setSnapZTolerance, setUseSnapZTolerance

Methods inherited from interface com.esri.arcgis.editor.ISnapEnvironment

addSnapAgent, clearSnapAgents, getSnapAgent, getSnapAgentCount, getSnapTolerance, getSnapToleranceUnits, removeSnapAgent, setSnapTolerance, setSnapToleranceUnits, snapPoint

Method Detail

snapToIntersection

boolean snapToIntersection(IPoint point,
                           IGeometry pIntersection)
                           throws IOException,
                                  AutomationException

Attempts to snap the specified point to the given intersection.

Product Availability

Available with ArcGIS Desktop.

Parameters:

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

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

Returns:

The snapped

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

fullPointSnap

boolean fullPointSnap(IPoint point)
                      throws IOException,
                             AutomationException

Always attempts to snap the point using the current snap environment. This should not be used to snap mouse position in a tool.

Product Availability

Available with ArcGIS Desktop.

Parameters:

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

Returns:

The snapped

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.