com.esri.arcgis.editor
Interface ISnapEnvironment2

All Superinterfaces:

ISnapEnvironment, Serializable

All Known Subinterfaces:

ISnapEnvironment3

All Known Implementing Classes:

Editor, ISnapEnvironment2Proxy, ISnapEnvironment3Proxy

public interface ISnapEnvironment2
extends ISnapEnvironment, Serializable

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

Superseded By

ISnapEnvironment3

Remarks

For more information about snapping in z, refer to Working with Zs in the editor.

When To Use

The ISnapEnvironment2 interface extends the ISnapEnvironment interface to support snapping behavior for z-aware features.

Product Availability

Available with ArcGIS Desktop.

Method Summary

double	getSnapZTolerance() The snap tolerance used for z-values, measured in map units.
boolean	isUseSnapZTolerance() Indicates whether the SnapZTolerance property is used when Z snapping.
void	setSnapZTolerance(double tolerance) The snap tolerance used for z-values, measured in map units.
void	setUseSnapZTolerance(boolean useSnapZTolerance) Indicates whether the SnapZTolerance property is used when Z snapping.

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

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

Method Detail

isUseSnapZTolerance

boolean isUseSnapZTolerance()
                            throws IOException,
                                   AutomationException

Indicates whether the SnapZTolerance property is used when Z snapping.

Remarks

Boolean value that determines whether z-aware snap agents use a defined tolerance when evaluating if a point meets the snap agent's criteria. The tolerance is defined using ISnapEnvironment2::SnapZTolerance. Default value is FALSE.

Product Availability

Available with ArcGIS Desktop.

Returns:

The useSnapZTolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseSnapZTolerance

void setUseSnapZTolerance(boolean useSnapZTolerance)
                          throws IOException,
                                 AutomationException

Indicates whether the SnapZTolerance property is used when Z snapping.

Product Availability

Available with ArcGIS Desktop.

Parameters:

useSnapZTolerance - The useSnapZTolerance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnapZTolerance

double getSnapZTolerance()
                         throws IOException,
                                AutomationException

The snap tolerance used for z-values, measured in map units.

Remarks

Double value that defines the cylinder (defined as distance positively and negatively from snap point's Z-value) used to determine whether the point snaps to another feature. The z-snap tolerance is evaluated only after a snap agent in XY is satisfied. Default value is 0. SnapZTolerance is only applied when IEditorZ::UseSnapZTolerance is TRUE.

Product Availability

Available with ArcGIS Desktop.

Returns:

The tolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapZTolerance

void setSnapZTolerance(double tolerance)
                       throws IOException,
                              AutomationException

The snap tolerance used for z-values, measured in map units.

Description

The SnapZTolerance property defines the height region bounding the input point location and will be used in conjunction with the XY tolerance. It is always expressed in z-units, and the search for a potential snap point candidate is made within the cylinder region it defines.

Note: The z-unit is determined based on the first editable layer added to the map

Product Availability

Available with ArcGIS Desktop.

Parameters:

tolerance - The tolerance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.