com.esri.arcgis.geometry
Interface IZ

All Superinterfaces:

IZCollection, Serializable

All Known Subinterfaces:

IZ2

All Known Implementing Classes:

Polygon, Polyline

public interface IZ
extends IZCollection, Serializable

Provides access to members that identify geometric objects that can have 3D coordinates and defines operations on such objects.

Superseded By

IZ2

Description

IZ contains methods for setting Zs through interpolation based on existing Z values, Z values set at the From and To Points, and Z values from a FunctionalSurface. Z values may also be set to a single constant value. IZ also contains a method for determining if consecutive vertices exhibit a vertical relation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

IPoint.getZ(), IZAware, IZCollection, IZ

Method Summary

void	calculateNonSimpleZs() Calculates the non-simple Z values by extrapolation/interpolation for polylines and interpolation for polygons.
void	interpolateFromSurface(IFunctionalSurface interpolationSurface) Use the specified functional surface to generate Z values for the vertices of this object.
void	interpolateZsBetween(int startPart, int startPoint, int endPart, int endPoint) Generate Z values by linear interpolation for all vertices in the range [start+1, end-1].
boolean	isZVertical() Indicates if at least two consecutive vertices of this polyline or polygon have the same x and y values, but distinct z values.
void	setConstantZ(double zLevel) Sets Z coordinates at all vertices to zLevel.

Methods inherited from interface com.esri.arcgis.geometry.IZCollection

getZMax, getZMin, multiplyZs, offsetZs

Method Detail

isZVertical

boolean isZVertical()
                    throws IOException,
                           AutomationException

Indicates if at least two consecutive vertices of this polyline or polygon have the same x and y values, but distinct z values.

Description

Returns TRUE when at least two consecutive vertices have the same X and Y coordinates, but different Z attributes. Returns FALSE if all consecutive vertices have different X and Y coordinates, or if they have the same Z attribute.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The zVertical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interpolateFromSurface

void interpolateFromSurface(IFunctionalSurface interpolationSurface)
                            throws IOException,
                                   AutomationException

Use the specified functional surface to generate Z values for the vertices of this object.

Description

Sets Z attributes for all Points on the interfaced Geometry within the Domain of the FunctionalSurface equal to the Z value on the FunctionalSurface at each (X, Y) Point.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interpolateZsBetween

void interpolateZsBetween(int startPart,
                          int startPoint,
                          int endPart,
                          int endPoint)
                          throws IOException,
                                 AutomationException

Generate Z values by linear interpolation for all vertices in the range [start+1, end-1].

Description

Sets the Z attributes from the vertices between the StartPoint of the startPart and the EndPoint of the endPart. The values of the StartPoint and EndPoint remain unchanged, but all vertices inbetween are assigned Z values proportional to the distance along the curve between the StartPoint and EndPoint and the difference between the Z values of the StartPoint and EndPoint.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

startPart - The startPart (in)

startPoint - The startPoint (in)

endPart - The endPart (in)

endPoint - The endPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

calculateNonSimpleZs

void calculateNonSimpleZs()
                          throws IOException,
                                 AutomationException

Calculates the non-simple Z values by extrapolation/interpolation for polylines and interpolation for polygons.

Description

Calculates Z attribute values for each non-simple (NaN) Z value from existing simple (non-NaN) Z attributes on the interfaced Geometry.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConstantZ

void setConstantZ(double zLevel)
                  throws IOException,
                         AutomationException

Sets Z coordinates at all vertices to zLevel.

Description

Sets all Z attributes in the object equal to the constant input Z value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

zLevel - The zLevel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.