com.esri.arcgis.editor
Interface IFeatureSnapAgent2

All Superinterfaces:

IFeatureSnapAgent, ISnapAgent, Serializable

All Known Implementing Classes:

FeatureSnap

public interface IFeatureSnapAgent2
extends IFeatureSnapAgent, Serializable

Provides access to properties controlling Snapping in Z.

Description

This interface is new at ArcGIS 9.3. It supersedes IFeatureSnapAgent.

Product Availability

Available with ArcGIS Desktop.

Method Summary

boolean	isZSnappingEnabled() Indicates whether this Agent will snap in Z.
void	setZSnappingEnabled(boolean zSnapEnabled) Indicates whether this Agent will snap in Z.

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

getFeatureCache, getFeatureClass, getHitType, setFeatureClassByRef, setHitType

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

getName, snap

Method Detail

setZSnappingEnabled

void setZSnappingEnabled(boolean zSnapEnabled)
                         throws IOException,
                                AutomationException

Indicates whether this Agent will snap in Z.

Product Availability

Available with ArcGIS Desktop.

Parameters:

zSnapEnabled - The zSnapEnabled (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isZSnappingEnabled

boolean isZSnappingEnabled()
                           throws IOException,
                                  AutomationException

Indicates whether this Agent will snap in Z.

Remarks

Determines whether the snap agent referencing z-aware data should test the snap point against the Z-snap tolerance defined by ISnapEnvironment2::SnapZTolerance. The z-snap agent is evaluated using this tolerance only if the feature snap agent's HitType is active for one or more XY constraints.

Product Availability

Available with ArcGIS Desktop.

Returns:

The zSnapEnabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.