com.esri.arcgis.geometry
Interface IArea3D

All Superinterfaces:
Serializable
All Known Implementing Classes:
MultiPatch, Polygon

public interface IArea3D
extends Serializable

Provides access to members that return properties common to MultiPatches.

Description

Implemented for Multipatches and Polygons. Returns the 3D surface area of the geometry. Outputs the 3D centroid and label point, both useful for labeling purposes. In contrast to the centroid and label point returned via IArea, the 3D centroid and label point take into account the ZMax of the geometry queried.

Product Availability

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


Method Summary
 double getArea3D()
          The 3D surface area.
 IPoint getCentroid3D()
          A 3D point whose XY coordinates are set to the center of gravity of the shape’s 2D footprint and Z set to the shape’s ZMax.
 IPoint getLabelPoint3D()
          A point guaranteed to be on this 3D surface area.
 void queryCentroid3D(IPoint center)
          Copies the centroid of this 3D surface area to the specified point.
 void queryLabelPoint3D(IPoint labelPoint)
          Copies to the input point a point guaranteed to be on this 3D surface area.
 

Method Detail

getArea3D

double getArea3D()
                 throws IOException,
                        AutomationException
The 3D surface area.

Remarks

If Patches comprising a MultiPatch geometry have improperly ordered vertices such that positive faces are not pointing outwards, a negative 3D surface area will be returned. To ensure proper orientation, add vertices in a clockwise manner relative to an observer situated outside of the MultiPatch geometry.

Product Availability

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

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

getCentroid3D

IPoint getCentroid3D()
                     throws IOException,
                            AutomationException
A 3D point whose XY coordinates are set to the center of gravity of the shape’s 2D footprint and Z set to the shape’s ZMax.

Product Availability

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

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

getLabelPoint3D

IPoint getLabelPoint3D()
                       throws IOException,
                              AutomationException
A point guaranteed to be on this 3D surface area.

Product Availability

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

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

queryCentroid3D

void queryCentroid3D(IPoint center)
                     throws IOException,
                            AutomationException
Copies the centroid of this 3D surface area to the specified point.

Product Availability

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

Parameters:
center - 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.

queryLabelPoint3D

void queryLabelPoint3D(IPoint labelPoint)
                       throws IOException,
                              AutomationException
Copies to the input point a point guaranteed to be on this 3D surface area.

Product Availability

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

Parameters:
labelPoint - 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.