com.esri.arcgis.editor
Class IEditorZProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.editor.IEditorZProxy

All Implemented Interfaces:

IEditorZ, java.io.Externalizable, java.io.Serializable

public class IEditorZProxy
extends com.esri.arcgis.interop.Dispatch
implements IEditorZ, java.io.Serializable

Internal use class Proxy for COM Interface 'IEditorZ'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriEditor.olb'

Description: 'Provides access to members that access and manipulate the z-environment of the editor.' 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 =

See Also:

Serialized Form

Field Summary

boolean	noncastable
static java.lang.Class	targetClass

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Fields inherited from interface com.esri.arcgis.editor.IEditorZ

IID, IIDf697a79e_e55f_4a63_83a8_7676725d56a4

Constructor Summary

	IEditorZProxy() For internal use only
	IEditorZProxy(java.lang.Object obj)
protected	IEditorZProxy(java.lang.Object obj, java.lang.String iid)
	IEditorZProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
protected	IEditorZProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)

Method Summary

void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
void	applyZ(IPoint point) Applies editor's Z-capture logic to point if it isn't already z-aware.
void	drapeGeometry(IGeometry geometry, boolean addVertices, IGeometry[] outputGeometry) Drapes a geometry to the current surface..
void	finalizeZs(IGeometry geometry) Resolves NaN Zs to definite values.
INotifyZFinalize	getNotifyZFinalize() Callback used to notify if ZCapture mode fails.
IFunctionalSurface	getSurface() Surface used for Z capture.
int	getZCaptureType() Determines method used for z-capture.
double	getZDrapingTolerance() Determines the allowable error from the surface when draping.
double	getZOffset() Determines offset applied to z-value when new vertex is added to edit sketch.
IMarkerSymbol	getZSnapSymbol() Symbol used to indicate when vertex is snapped in Z.
IFeatureConstruction	initializeFeatureConstruction() Initialize a FeatureConstruction object that will use the Editor's ZEnvironment settings.
boolean	isDraping() Indicates whether sketches are draped onto the surface.
boolean	isUseZDrapingTolerance() Indicates whether the ZDrapingTolerance property is used when adding segments to the edit sketch.
boolean	isUseZOffset() Indicates whether new z-values are modified by the ZOffset property.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener)
void	setDraping(boolean useDraping) Indicates whether sketches are draped onto the surface.
void	setNotifyZFinalizeByRef(INotifyZFinalize callback) Callback used to notify if ZCapture mode fails.
void	setSurfaceByRef(IFunctionalSurface surface) Surface used for Z capture.
void	setUseZDrapingTolerance(boolean useZDrapingTolerance) Indicates whether the ZDrapingTolerance property is used when adding segments to the edit sketch.
void	setUseZOffset(boolean useZOffset) Indicates whether new z-values are modified by the ZOffset property.
void	setZCaptureType(int zCaptureType) Determines method used for z-capture.
void	setZDrapingTolerance(double zDrapingTolerance) Determines the allowable error from the surface when draping.
void	setZOffset(double zOffset) Determines offset applied to z-value when new vertex is added to edit sketch.
void	setZSnapSymbolByRef(IMarkerSymbol symbol) Symbol used to indicate when vertex is snapped in Z.

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

Field Detail

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable

Constructor Detail

IEditorZProxy

public IEditorZProxy(java.lang.String CLSID,
                     java.lang.String host,
                     com.esri.arcgis.interop.AuthInfo authInfo)
              throws java.net.UnknownHostException,
                     java.io.IOException

Throws:

java.net.UnknownHostException

java.io.IOException

IEditorZProxy

public IEditorZProxy()

For internal use only

IEditorZProxy

public IEditorZProxy(java.lang.Object obj)
              throws java.io.IOException

Throws:

java.io.IOException

IEditorZProxy

protected IEditorZProxy(java.lang.Object obj,
                        java.lang.String iid)
                 throws java.io.IOException

Throws:

java.io.IOException

IEditorZProxy

protected IEditorZProxy(java.lang.String CLSID,
                        java.lang.String iid,
                        java.lang.String host,
                        com.esri.arcgis.interop.AuthInfo authInfo)
                 throws java.io.IOException

Throws:

java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

drapeGeometry

public void drapeGeometry(IGeometry geometry,
                          boolean addVertices,
                          IGeometry[] outputGeometry)
                   throws java.io.IOException,
                          AutomationException

Drapes a geometry to the current surface.. If addVertices is false, existing vertex Z's will be modified but no new vertices added.

Specified by:

drapeGeometry in interface IEditorZ

Parameters:

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

addVertices - The addVertices (in)

outputGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

applyZ

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

Applies editor's Z-capture logic to point if it isn't already z-aware.

Specified by:

applyZ in interface IEditorZ

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.

finalizeZs

public void finalizeZs(IGeometry geometry)
                throws java.io.IOException,
                       AutomationException

Resolves NaN Zs to definite values.

Specified by:

finalizeZs in interface IEditorZ

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getZCaptureType

public int getZCaptureType()
                    throws java.io.IOException,
                           AutomationException

Determines method used for z-capture.

Specified by:

getZCaptureType in interface IEditorZ

Returns:

A com.esri.arcgis.editor.esriZCaptureType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setZCaptureType

public void setZCaptureType(int zCaptureType)
                     throws java.io.IOException,
                            AutomationException

Determines method used for z-capture.

Specified by:

setZCaptureType in interface IEditorZ

Parameters:

zCaptureType - A com.esri.arcgis.editor.esriZCaptureType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseZOffset

public boolean isUseZOffset()
                     throws java.io.IOException,
                            AutomationException

Indicates whether new z-values are modified by the ZOffset property.

Specified by:

isUseZOffset in interface IEditorZ

Returns:

The useZOffset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseZOffset

public void setUseZOffset(boolean useZOffset)
                   throws java.io.IOException,
                          AutomationException

Indicates whether new z-values are modified by the ZOffset property.

Specified by:

setUseZOffset in interface IEditorZ

Parameters:

useZOffset - The useZOffset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getZOffset

public double getZOffset()
                  throws java.io.IOException,
                         AutomationException

Determines offset applied to z-value when new vertex is added to edit sketch.

Specified by:

getZOffset in interface IEditorZ

Returns:

The zOffset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setZOffset

public void setZOffset(double zOffset)
                throws java.io.IOException,
                       AutomationException

Determines offset applied to z-value when new vertex is added to edit sketch.

Specified by:

setZOffset in interface IEditorZ

Parameters:

zOffset - The zOffset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseZDrapingTolerance

public boolean isUseZDrapingTolerance()
                               throws java.io.IOException,
                                      AutomationException

Indicates whether the ZDrapingTolerance property is used when adding segments to the edit sketch.

Specified by:

isUseZDrapingTolerance in interface IEditorZ

Returns:

The useZDrapingTolerance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseZDrapingTolerance

public void setUseZDrapingTolerance(boolean useZDrapingTolerance)
                             throws java.io.IOException,
                                    AutomationException

Indicates whether the ZDrapingTolerance property is used when adding segments to the edit sketch.

Specified by:

setUseZDrapingTolerance in interface IEditorZ

Parameters:

useZDrapingTolerance - The useZDrapingTolerance (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getZDrapingTolerance

public double getZDrapingTolerance()
                            throws java.io.IOException,
                                   AutomationException

Determines the allowable error from the surface when draping.

Specified by:

getZDrapingTolerance in interface IEditorZ

Returns:

The zDrapingTolerance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setZDrapingTolerance

public void setZDrapingTolerance(double zDrapingTolerance)
                          throws java.io.IOException,
                                 AutomationException

Determines the allowable error from the surface when draping.

Specified by:

setZDrapingTolerance in interface IEditorZ

Parameters:

zDrapingTolerance - The zDrapingTolerance (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDraping

public boolean isDraping()
                  throws java.io.IOException,
                         AutomationException

Indicates whether sketches are draped onto the surface.

Specified by:

isDraping in interface IEditorZ

Returns:

The useDraping

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDraping

public void setDraping(boolean useDraping)
                throws java.io.IOException,
                       AutomationException

Indicates whether sketches are draped onto the surface.

Specified by:

setDraping in interface IEditorZ

Parameters:

useDraping - The useDraping (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSurface

public IFunctionalSurface getSurface()
                              throws java.io.IOException,
                                     AutomationException

Surface used for Z capture.

Specified by:

getSurface in interface IEditorZ

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSurfaceByRef

public void setSurfaceByRef(IFunctionalSurface surface)
                     throws java.io.IOException,
                            AutomationException

Surface used for Z capture.

Specified by:

setSurfaceByRef in interface IEditorZ

Parameters:

surface - A reference to a com.esri.arcgis.geometry.IFunctionalSurface (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getZSnapSymbol

public IMarkerSymbol getZSnapSymbol()
                             throws java.io.IOException,
                                    AutomationException

Symbol used to indicate when vertex is snapped in Z.

Specified by:

getZSnapSymbol in interface IEditorZ

Returns:

A reference to a com.esri.arcgis.display.IMarkerSymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setZSnapSymbolByRef

public void setZSnapSymbolByRef(IMarkerSymbol symbol)
                         throws java.io.IOException,
                                AutomationException

Symbol used to indicate when vertex is snapped in Z.

Specified by:

setZSnapSymbolByRef in interface IEditorZ

Parameters:

symbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNotifyZFinalize

public INotifyZFinalize getNotifyZFinalize()
                                    throws java.io.IOException,
                                           AutomationException

Callback used to notify if ZCapture mode fails.

Specified by:

getNotifyZFinalize in interface IEditorZ

Returns:

A reference to a com.esri.arcgis.editor.INotifyZFinalize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNotifyZFinalizeByRef

public void setNotifyZFinalizeByRef(INotifyZFinalize callback)
                             throws java.io.IOException,
                                    AutomationException

Callback used to notify if ZCapture mode fails.

Specified by:

setNotifyZFinalizeByRef in interface IEditorZ

Parameters:

callback - A reference to a com.esri.arcgis.editor.INotifyZFinalize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

initializeFeatureConstruction

public IFeatureConstruction initializeFeatureConstruction()
                                                   throws java.io.IOException,
                                                          AutomationException

Initialize a FeatureConstruction object that will use the Editor's ZEnvironment settings.

Specified by:

initializeFeatureConstruction in interface IEditorZ

Returns:

A reference to a com.esri.arcgis.geodatabase.IFeatureConstruction

Throws:

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

AutomationException - If the ArcObject component throws an exception.