com.esri.arcgis.editor
Interface IEditorZ

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

Editor, IEditorZProxy

public interface IEditorZ
extends java.io.Serializable

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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDf697a79e_e55f_4a63_83a8_7676725d56a4
static int	xxDummy Deprecated. Internal use only

Method Summary

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

Field Detail

IIDf697a79e_e55f_4a63_83a8_7676725d56a4

static final int IIDf697a79e_e55f_4a63_83a8_7676725d56a4

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

drapeGeometry

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.

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

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

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

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

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

Resolves NaN Zs to definite values.

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

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

Determines method used for z-capture.

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

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

Determines method used for z-capture.

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

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

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

Returns:

The useZOffset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseZOffset

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

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

Parameters:

useZOffset - The useZOffset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getZOffset

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

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

Returns:

The zOffset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setZOffset

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

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

Parameters:

zOffset - The zOffset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseZDrapingTolerance

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

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

Returns:

The useZDrapingTolerance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseZDrapingTolerance

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

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

Parameters:

useZDrapingTolerance - The useZDrapingTolerance (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getZDrapingTolerance

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

Determines the allowable error from the surface when draping.

Returns:

The zDrapingTolerance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setZDrapingTolerance

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

Determines the allowable error from the surface when draping.

Parameters:

zDrapingTolerance - The zDrapingTolerance (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDraping

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

Indicates whether sketches are draped onto the surface.

Returns:

The useDraping

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDraping

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

Indicates whether sketches are draped onto the surface.

Parameters:

useDraping - The useDraping (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSurface

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

Surface used for Z capture.

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

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

Surface used for Z capture.

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

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

Symbol used to indicate when vertex is snapped in Z.

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

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

Symbol used to indicate when vertex is snapped in Z.

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

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

Callback used to notify if ZCapture mode fails.

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

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

Callback used to notify if ZCapture mode fails.

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

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

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

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.