com.esri.arcgis.controls
Interface IPointSnapper

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IPointSnapperProxy

public interface IPointSnapper
extends java.io.Serializable

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

Description: 'IPointSnapper Interface' 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	IID2314d18e_2bd1_4298_aa30_d6759cd6c127
static int	xxDummy Deprecated. Internal use only

Method Summary

int	cacheShapes(IGeometryBag pShapes, java.lang.String name) Adds a shape to the snapping cache.
void	clearCache() Clears the underlying snapping cache.
ISnappingResult	fullSnap(IPoint point) Fully attempts to snap the specified point without regard to time.
void	getExcludedLayers(ISet ppSet) Returns a reference to the set of layers that will be excluded in snapping.
IPoint	getTangentInputPoint() Sets the input point used for calculating tangent points along curves.
void	removeCachedShapes(int token) Remove the shape from the cache.
void	setTangentInputPointByRef(IPoint point) Sets the input point used for calculating tangent points along curves.
ISnappingResult	snap(IPoint point) Attempts to snap the specified point.
void	updateCachedShapes(int token, IGeometryBag pShapes) Updates the shapes in the cache for the given token.

Field Detail

IID2314d18e_2bd1_4298_aa30_d6759cd6c127

static final int IID2314d18e_2bd1_4298_aa30_d6759cd6c127

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

snap

ISnappingResult snap(IPoint point)
                     throws java.io.IOException,
                            AutomationException

Attempts to snap the specified point. This is used for tool snapping.

Parameters:

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearCache

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

Clears the underlying snapping cache.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

cacheShapes

int cacheShapes(IGeometryBag pShapes,
                java.lang.String name)
                throws java.io.IOException,
                       AutomationException

Adds a shape to the snapping cache. Use the returned token to remove the shape from the cache.

Parameters:

pShapes - A reference to a com.esri.arcgis.geometry.IGeometryBag (in)

name - The name (in)

Returns:

The token

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateCachedShapes

void updateCachedShapes(int token,
                        IGeometryBag pShapes)
                        throws java.io.IOException,
                               AutomationException

Updates the shapes in the cache for the given token. The token is acquired by calling CacheShape.

Parameters:

token - The token (in)

pShapes - A reference to a com.esri.arcgis.geometry.IGeometryBag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeCachedShapes

void removeCachedShapes(int token)
                        throws java.io.IOException,
                               AutomationException

Remove the shape from the cache. The token is acquired by calling CacheShape.

Parameters:

token - The token (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTangentInputPointByRef

void setTangentInputPointByRef(IPoint point)
                               throws java.io.IOException,
                                      AutomationException

Sets the input point used for calculating tangent points along curves.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTangentInputPoint

IPoint getTangentInputPoint()
                            throws java.io.IOException,
                                   AutomationException

Sets the input point used for calculating tangent points along curves.

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExcludedLayers

void getExcludedLayers(ISet ppSet)
                       throws java.io.IOException,
                              AutomationException

Returns a reference to the set of layers that will be excluded in snapping.

Parameters:

ppSet - A reference to a com.esri.arcgis.system.ISet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

fullSnap

ISnappingResult fullSnap(IPoint point)
                         throws java.io.IOException,
                                AutomationException

Fully attempts to snap the specified point without regard to time. Use Snap for tool snapping.

Parameters:

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.