com.esri.arcgis.geodatabase
Interface ITinEdge

All Superinterfaces:
ITinElement, Serializable
All Known Implementing Classes:
TinEdge

public interface ITinEdge
extends ITinElement, Serializable

Provides access to members that control TIN edges.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 double getAzimuthDegrees()
          The azimuthal direction of the specified edge beginning at the FromNode in degrees.
 double getAzimuthRadians()
          The azimuthal direction of the specified edge beginning at the FromNode in radians.
 ITinNode getFromNode()
          The originating node of the specified edge.
 ITinTriangle getLeftTriangle()
          The triangle on the left (opposite) side of the specified edge.
 double getLength()
          The projected length of the specified edge.
 double getLength3D()
          The length of the specified edge measured on the TIN surface.
 ITinEdge getNeighbor()
          Returns the corresponding edge of the triangle opposite to the specified edge.
 ITinEdge getNextCCW()
          Returns the edge terminating at the FromNode of the specified edge.
 ITinEdge getNextCW()
          Returns the edge beginning at the ToNode of the specified edge.
 ITinEdge getNextInTriangle()
          Returns the next triangle sharing the FromNode of the specified edge in a clockwise direction.
 ITinEdge getPreviousInTriangle()
          Returns the next triangle sharing the FromNode of the specified edge in a counter-clockwise direction.
 ITinTriangle getRightTriangle()
          The triangle on the right side of the specified edge.
 ITinNode getToNode()
          The terminating node of the specified edge.
 int getType()
          The type of the specified edge.
 void queryAsLine(ILine pLine)
          Sets the specified edge equal to a line.
 void queryAsWKSPointZs(_WKSPointZ[] pFrom, _WKSPointZ[] pTo)
          Sets the specified edge equal to its nodes as points with z values.
 
Methods inherited from interface com.esri.arcgis.geodatabase.ITinElement
getIndex, getTagValue, getTheTin, init, isEmpty, isInsideDataArea, setEmpty
 

Method Detail

getType

int getType()
            throws IOException,
                   AutomationException
The type of the specified edge.

Description

The type of an edge indicates whether or not it's an enforced breakline edge. If it's enforced the type will be equal to either esriTinHardEdge or esriTinSoftEdge. If it's not a breakline edge the type will equal esriTinRegularEdge.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.geodatabase.esriTinEdgeType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFromNode

ITinNode getFromNode()
                     throws IOException,
                            AutomationException
The originating node of the specified edge.

Description

The FromNode of an edge is the first node of an edge. It is equivalent to the ToNode of the previous edge.

Each triangle in a TIN is comprised of three edges. The edges are oriented clockwise.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geodatabase.ITinNode
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getToNode

ITinNode getToNode()
                   throws IOException,
                          AutomationException
The terminating node of the specified edge.

Description

The ToNode of an edge is the second node of an edge. It is equivalent to the FromNode of the next edge.

Each triangle in a TIN is comprised of three edges. The edges are oriented clockwise.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geodatabase.ITinNode
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLeftTriangle

ITinTriangle getLeftTriangle()
                             throws IOException,
                                    AutomationException
The triangle on the left (opposite) side of the specified edge.

Description

Edges are always ordered clockwise, one after the other, in the triangle to which they belong. Because of this, edges on the absolute boundary of a triangulation have no LeftTriangle. A null pointer, or 'Nothing', will be returned as the LeftTriangle for these edges.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geodatabase.ITinTriangle
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRightTriangle

ITinTriangle getRightTriangle()
                              throws IOException,
                                     AutomationException
The triangle on the right side of the specified edge.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geodatabase.ITinTriangle
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLength

double getLength()
                 throws IOException,
                        AutomationException
The projected length of the specified edge.

Description

Length represents the 2-D distance between the from and to nodes of the edge. It takes into consideration only the X and Y coordinates.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pLength
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLength3D

double getLength3D()
                   throws IOException,
                          AutomationException
The length of the specified edge measured on the TIN surface.

Description

Length3D represents the 3-D distance between the from and to nodes of the edge. It takes into consideration X, Y, and Z coordinates.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pLength
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAzimuthRadians

double getAzimuthRadians()
                         throws IOException,
                                AutomationException
The azimuthal direction of the specified edge beginning at the FromNode in radians.

Description

The azimuth represents the compass direction of the edge starting at the from node and heading toward the to node.

The returned value is in radians.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pAzimuth
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAzimuthDegrees

double getAzimuthDegrees()
                         throws IOException,
                                AutomationException
The azimuthal direction of the specified edge beginning at the FromNode in degrees.

Description

The azimuth represents the compass direction of the edge starting at the from node and heading toward the to node.

The returned value is in degrees.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pAzimuth
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryAsLine

void queryAsLine(ILine pLine)
                 throws IOException,
                        AutomationException
Sets the specified edge equal to a line.

Description

Writes the from and to nodes of the edge as points to an existing, pre-instantiated, Line object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pLine - A reference to a com.esri.arcgis.geometry.ILine (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryAsWKSPointZs

void queryAsWKSPointZs(_WKSPointZ[] pFrom,
                       _WKSPointZ[] pTo)
                       throws IOException,
                              AutomationException
Sets the specified edge equal to its nodes as points with z values.

Description

Writes the from and to nodes of the edge as points to existing WKSPointZ variables.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pFrom - A Structure: com.esri.arcgis.system._WKSPointZ (A com.esri.arcgis.system._WKSPointZ COM typedef) (out: use single element array)
pTo - A Structure: com.esri.arcgis.system._WKSPointZ (A com.esri.arcgis.system._WKSPointZ COM typedef) (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNextInTriangle

ITinEdge getNextInTriangle()
                           throws IOException,
                                  AutomationException
Returns the next triangle sharing the FromNode of the specified edge in a clockwise direction.

Description

Returns the next edge ahead in the triangle. The next edge ahead is in the clockwise direction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geodatabase.ITinEdge
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPreviousInTriangle

ITinEdge getPreviousInTriangle()
                               throws IOException,
                                      AutomationException
Returns the next triangle sharing the FromNode of the specified edge in a counter-clockwise direction.

Description

Returns the previous edge in the triangle. The previous edge is counter-clockwise to this edge.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geodatabase.ITinEdge
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNeighbor

ITinEdge getNeighbor()
                     throws IOException,
                            AutomationException
Returns the corresponding edge of the triangle opposite to the specified edge.

Description

A triangle is comprised of three edges. They are ordered clockwise one after another. So, the RightTriangle of an edge is the triangle the edge belongs to. An edge's neighboring edge is the edge of the LeftTriangle that shares the same nodes (although from and to are reversed).

GetNeighbor will return Nothing (a null pointer) when the edge is on the absolute boundary of the triangulation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geodatabase.ITinEdge
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNextCW

ITinEdge getNextCW()
                   throws IOException,
                          AutomationException
Returns the edge beginning at the ToNode of the specified edge.

Description

Returns the next edge, in a neighboring triangle, that is clockwise to this edge relative to its from node. Consider the from node the center hub of a bicycle wheel and edges incident to it spokes. GetNextCW returns the next spoke (edge) clockwise.

This member is useful when you need to circle around nodes.

If the from node of an edge is one of the TIN's super nodes, GetNextCW will return 'Nothing' (a null pointer) when there is no next edge due to the fact the absolute boundary has been reached.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geodatabase.ITinEdge
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNextCCW

ITinEdge getNextCCW()
                    throws IOException,
                           AutomationException
Returns the edge terminating at the FromNode of the specified edge.

Description

Returns the next edge, in a neighboring triangle, that is counter-clockwise to this edge relative to its from node. Consider the from node the center hub of a bicycle wheel and edges incident to it spokes. GetNextCCW returns the next spoke (edge) counter-clockwise.

This member is useful when you need to circle around nodes.

If the from node of an edge is one of the TIN's super nodes, GetNextCCW will return 'Nothing' (a null pointer) when there is no next edge due to the fact the absolute boundary has been reached.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geodatabase.ITinEdge
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.