com.esri.arcgis.editor
Class ISnapEnvironment2Proxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.editor.ISnapEnvironmentProxy
          com.esri.arcgis.editor.ISnapEnvironment2Proxy

All Implemented Interfaces:

ISnapEnvironment, ISnapEnvironment2, Externalizable, Serializable

Direct Known Subclasses:

ISnapEnvironment3Proxy

public class ISnapEnvironment2Proxy
extends ISnapEnvironmentProxy
implements ISnapEnvironment2, 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.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	ISnapEnvironment2Proxy()
	ISnapEnvironment2Proxy(Object obj)
protected	ISnapEnvironment2Proxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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	removeListener(String iidStr, Object theListener)
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 class com.esri.arcgis.editor.ISnapEnvironmentProxy

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

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

ISnapEnvironment2Proxy

public ISnapEnvironment2Proxy()

ISnapEnvironment2Proxy

public ISnapEnvironment2Proxy(Object obj)
                       throws IOException

Throws:

IOException

ISnapEnvironment2Proxy

protected ISnapEnvironment2Proxy(Object obj,
                                 String iid)
                          throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class ISnapEnvironmentProxy

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class ISnapEnvironmentProxy

Throws:

IOException

isUseSnapZTolerance

public 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.

Specified by:

isUseSnapZTolerance in interface ISnapEnvironment2

Returns:

The useSnapZTolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseSnapZTolerance

public void setUseSnapZTolerance(boolean useSnapZTolerance)
                          throws IOException,
                                 AutomationException

Indicates whether the SnapZTolerance property is used when Z snapping.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setUseSnapZTolerance in interface ISnapEnvironment2

Parameters:

useSnapZTolerance - The useSnapZTolerance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnapZTolerance

public 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.

Specified by:

getSnapZTolerance in interface ISnapEnvironment2

Returns:

The tolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapZTolerance

public 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.

Specified by:

setSnapZTolerance in interface ISnapEnvironment2

Parameters:

tolerance - The tolerance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.