com.esri.arcgis.geodatabase
Interface ITinTriangle

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

public interface ITinTriangle
extends ITinElement, Serializable

Provides access to members that control TIN triangles.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 double getArea()
          The projected area of the specified TIN triangle.
 double getArea3D()
          The area of the specified triangle as measured on the TIN surface.
 double getAspectDegrees()
          The aspect of the specified triangle in degrees.
 double getAspectRadians()
          The aspect of the specified triangle in radians.
 ITinEdge getEdge(int index)
          The triangle edge specified by the index.
 double getIntensity()
          The brightness value of the specified triangle.
 ITinNode getNode(int index)
          The triangle node specified by the index.
 double getPerimeter()
          The projected perimeter of the specified TIN triangle.
 double getPerimeter3D()
          The perimeter of the specified triangle as measured on the TIN surface.
 double getSlopeDegrees()
          The slope of the specified triangle in degrees.
 double getSlopePercent()
          The slope of the specified triangle in percent.
 double getSlopeRadians()
          The slope of the specified triangle in radians.
 void queryAdjacentTriangleIndices(int[] pTi, int[] pTj, int[] pTk)
          A long array of index numbers belonging to triangles adjacent to the specified triangle.
 void queryAdjacentTriangles(ITinTriangle pTi, ITinTriangle pTj, ITinTriangle pTk)
          The array of triangles adjacent to the specified triangle.
 void queryAsRing(IRing pRing)
          Sets the specified triangle as a ring.
 void queryCentroid(IPoint pCentroid)
          The centroid of the specified triangle as determined by averaging the coordinates of its vertices.
 void queryCircumCircle(IPoint pCenter, double[] pRadius)
          The circle circumscribing the specified triangle about its vertices.
 void queryElevationBand(double zLowerBound, double zUpperBound, int[] pCount, _WKSPointZ[] pRegion)
          Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by GeoDatabaseHelper.queryElevationBand(com.esri.arcgis.geodatabase.ITinTriangle, double, double, int[], com.esri.arcgis.system._WKSPointZ[][]).
 void queryNormal(IVector3D pNormal)
          The vector normal to the specified triangle.
 void queryVertices(_WKSPointZ[] pPi, _WKSPointZ[] pPj, _WKSPointZ[] pPk)
          The vertices of the specified triangle as point features.
 
Methods inherited from interface com.esri.arcgis.geodatabase.ITinElement
getIndex, getTagValue, getTheTin, init, isEmpty, isInsideDataArea, setEmpty
 

Method Detail

getNode

ITinNode getNode(int index)
                 throws IOException,
                        AutomationException
The triangle node specified by the index.

Product Availability

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

Parameters:
index - The index (in)
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.

getEdge

ITinEdge getEdge(int index)
                 throws IOException,
                        AutomationException
The triangle edge specified by the index.

Product Availability

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

Parameters:
index - The index (in)
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.

getArea

double getArea()
               throws IOException,
                      AutomationException
The projected area of the specified TIN triangle.

Description

The returned value is the 2-D area of the triangle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getPerimeter

double getPerimeter()
                    throws IOException,
                           AutomationException
The projected perimeter of the specified TIN triangle.

Description

The returned value represents the 2-D distance around the triangle boundary.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getArea3D

double getArea3D()
                 throws IOException,
                        AutomationException
The area of the specified triangle as measured on the TIN surface.

Description

The returned value is the surface area of the triangle. It takes into consideration the 3-D nature of the triangle. The surface area will always equal to or larger than the 2-D, or projected, area. The larger the difference between 2-D and 3-D areas, the steeper the triangle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getPerimeter3D

double getPerimeter3D()
                      throws IOException,
                             AutomationException
The perimeter of the specified triangle as measured on the TIN surface.

Description

The returned value represents the 3-D distance around the triangle boundary.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

queryNormal

void queryNormal(IVector3D pNormal)
                 throws IOException,
                        AutomationException
The vector normal to the specified triangle.

Description

You must pass an existing, pre-instantiated, IVector3D object. The X, Y, and Z component values of the vector orthogonal to the plane defined by the triangle will be written to the passed vector.

The magnitude of the vector is set relative to the size of the triangle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getSlopeRadians

double getSlopeRadians()
                       throws IOException,
                              AutomationException
The slope of the specified triangle in radians.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getSlopeDegrees

double getSlopeDegrees()
                       throws IOException,
                              AutomationException
The slope of the specified triangle in degrees.

Description

Slope is the steepness of the triangle. The value of SlopeDegrees will be >= 0 and < 90. A slope of 100% is equivalent to 45 degrees (1 unit change in Z for 1 unit change in XY).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getSlopePercent

double getSlopePercent()
                       throws IOException,
                              AutomationException
The slope of the specified triangle in percent.

Description

Slope is the steepness of the triangle. The value of SlopePercent will be >= 0 and < infinity. A slope of 100% is equivalent to 45 degrees (1 unit change in Z for 1 unit change in XY).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getAspectRadians

double getAspectRadians()
                        throws IOException,
                               AutomationException
The aspect of the specified triangle in radians.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getAspectDegrees

double getAspectDegrees()
                        throws IOException,
                               AutomationException
The aspect of the specified triangle in degrees.

Description

The aspect is the compass direction of the steepest downhill slope of the triangle. A value of 0 degrees is due north, 90 degrees due east, 180 degrees due south, 270 degrees due west, etc.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getIntensity

double getIntensity()
                    throws IOException,
                           AutomationException
The brightness value of the specified triangle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

queryVertices

void queryVertices(_WKSPointZ[] pPi,
                   _WKSPointZ[] pPj,
                   _WKSPointZ[] pPk)
                   throws IOException,
                          AutomationException
The vertices of the specified triangle as point features.

Description

Writes the X, Y, and Z coordinates of a triangle's nodes to WKSPointZ variables.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pPi - A Structure: com.esri.arcgis.system._WKSPointZ (A com.esri.arcgis.system._WKSPointZ COM typedef) (out: use single element array)
pPj - A Structure: com.esri.arcgis.system._WKSPointZ (A com.esri.arcgis.system._WKSPointZ COM typedef) (out: use single element array)
pPk - 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.

queryAsRing

void queryAsRing(IRing pRing)
                 throws IOException,
                        AutomationException
Sets the specified triangle as a ring.

Description

Writes the triangle's X, Y, and Z node coordinates as points to an existing, pre-instantiated, Ring object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

queryCentroid

void queryCentroid(IPoint pCentroid)
                   throws IOException,
                          AutomationException
The centroid of the specified triangle as determined by averaging the coordinates of its vertices.

Description

Writes the triangle centroid, as defined by averaging its node coordinates, to an existing Point object. You must instantiate the Point before calling QueryCentroid. For example,

Dim pPoint as IPoint

Set pPoint = New Point

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

queryCircumCircle

void queryCircumCircle(IPoint pCenter,
                       double[] pRadius)
                       throws IOException,
                              AutomationException
The circle circumscribing the specified triangle about its vertices.

Description

A triangle's circumcircle is the circle whose boundary passes through all three of the triangle's nodes.

The center of the circle is written to an existing, pre-instantiated, Point object. The radius is written to a double variable.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pCenter - A reference to a com.esri.arcgis.geometry.IPoint (in)
pRadius - The pRadius (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryElevationBand

void queryElevationBand(double zLowerBound,
                        double zUpperBound,
                        int[] pCount,
                        _WKSPointZ[] pRegion)
                        throws IOException,
                               AutomationException
Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by GeoDatabaseHelper.queryElevationBand(com.esri.arcgis.geodatabase.ITinTriangle, double, double, int[], com.esri.arcgis.system._WKSPointZ[][]).

The polygon based on the specified triangle and input bounds.

Description

Returns a 3-D polygonal definition for the area of the triangle that falls within the specified ZMin and ZMax. The returned count indicates how many vertices define the area. The vertices are written to the passed WKSPointZ array.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
zLowerBound - The zLowerBound (in)
zUpperBound - The zUpperBound (in)
pCount - The pCount (out: use single element array)
pRegion - 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.

queryAdjacentTriangles

void queryAdjacentTriangles(ITinTriangle pTi,
                            ITinTriangle pTj,
                            ITinTriangle pTk)
                            throws IOException,
                                   AutomationException
The array of triangles adjacent to the specified triangle.

Description

Provides the three triangles on the opposite sides of the edges of this triangle. The three passed triangle objects must have already been instantiated. They will be written to.

Triangles that border the TIN's extreme perimeter will not have adjacent triangles on all sides. IsEmpty will return True for the passed triangles that are undefined because of this condition.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pTi - A reference to a com.esri.arcgis.geodatabase.ITinTriangle (in)
pTj - A reference to a com.esri.arcgis.geodatabase.ITinTriangle (in)
pTk - A reference to a com.esri.arcgis.geodatabase.ITinTriangle (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryAdjacentTriangleIndices

void queryAdjacentTriangleIndices(int[] pTi,
                                  int[] pTj,
                                  int[] pTk)
                                  throws IOException,
                                         AutomationException
A long array of index numbers belonging to triangles adjacent to the specified triangle.

Description

Provides the index values of the three triangles on the opposite sides of the edges of this triangle. Triangles that border the TIN's extreme perimeter will not have adjacent triangles on all sides. The indices returned for these will be 0.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pTi - The pTi (out: use single element array)
pTj - The pTj (out: use single element array)
pTk - The pTk (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.