com.esri.arcgis.geodatabase
Interface ISurface

All Superinterfaces:
IFunctionalSurface, java.io.Serializable
All Known Subinterfaces:
ITinSurface, ITinSurface2
All Known Implementing Classes:
ISurfaceProxy, ITinSurface2Proxy, ITinSurfaceProxy, RasterSurface, Tin

public interface ISurface
extends IFunctionalSurface, java.io.Serializable

COM Interface 'ISurface'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description: 'Provides access to members that control surfaces.' 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 IID73b80fbc_ff33_11d1_a549_0000f8774f0f
           
static int xxDummy
          Deprecated. Internal use only
 
Fields inherited from interface com.esri.arcgis.geometry.IFunctionalSurface
IID98d17b10_951c_11d2_bcfc_0000f875bcce
 
Method Summary
 void asPolygons(IFeatureClass pFeatureClass, int type, IDoubleArray pClassBreaks, ILongArray pClassCodes, java.lang.Object fieldName)
          Converts the surface to a polygon feature class representing slope or aspect.
 void contour(double referenceContourHeight, double interval, IFeatureClass pFeatureClass, java.lang.String fieldName, int digitsAfterDecimalPoint)
          Output contours based on the specified root value and interval.
 void contourList(IDoubleArray pBreaks, IFeatureClass pFeatureClass, java.lang.String fieldName, int digitsAfterDecimalPoint)
          Output a list of contours corresponding to the specified eleveation values.
 double getAspectDegrees(IPoint pPoint)
          Returns the aspect at the specified location in degrees.
 double getAspectRadians(IPoint pPoint)
          Returns the aspect at the specified location in radians.
 void getContour(IPoint pPoint, IPolyline[] ppContour, double[] pElevation)
          Returns a countour passing through the queried point.
 double getElevation(IPoint pPoint)
          Returns the z value of the specified location.
 void getLineOfSight(IPoint pObserver, IPoint pTarget, IPoint[] ppObstruction, IPolyline[] ppVisibleLines, IPolyline[] ppInvisibleLines, boolean[] pbIsVisible, boolean bApplyCurvature, boolean bApplyRefraction, java.lang.Object pRefractionFactor)
          Computes the visibility of a line-of-sight from the observer to the target.
 void getProfile(IGeometry pShape, IGeometry[] ppProfile, java.lang.Object pStepSize)
          Returns a polyline with z values interpolated from the surface.
 double getProjectedArea(double referenceHeight, int type)
          Returns the projected area of the surface above or below an input z value.
 double getSlopeDegrees(IPoint pPoint)
          Returns the slope at the specified location in degrees.
 double getSlopePercent(IPoint pPoint)
          Returns the slope at the specified location in percent.
 double getSlopeRadians(IPoint pPoint)
          Returns the slope at the specified location in radians.
 IPolyline getSteepestPath(IPoint pPoint)
          Returns the steepest path downhill from the specified point.
 double getSurfaceArea(double referenceHeight, int type)
          Returns the area measured on its surface above or below an input z value.
 double getVolume(double reference, int type)
          Returns the volume above or below an input z value.
 double getZFactor()
          Multiplication factor applied to all z values to provide unit-congruency between coordinate components.
 void interpolateShape(IGeometry pShape, IGeometry[] ppOutShape, java.lang.Object pStepSize)
          Interpolates z values for a defined geometric shape.
 void interpolateShapeVertices(IGeometry pShape, IGeometry[] ppOutShape)
          Interpolates z values for a defined geometric shape at its vertices only.
 boolean isVoidZ(double value)
          Returns TRUE if the passed value is equal to the surface's void value.
 IPoint locate(IRay pRay, int hint)
          Returns the intersection of the query ray and the surface.
 IDoubleArray locateAll(IRay pRay, int hint)
          Returns the distances of intersections of the query ray and the surface.
 void queryNormal(IPoint pLocation, IVector3D pNormal)
          Returns the vector normal to the specified triangle.
 void queryPixelBlock(double xOrigin, double yOrigin, double xPixelSize, double yPixelSize, int type, java.lang.Object valueForNoData, java.lang.Object block)
          Derives slope, aspect, hillshade, or elevation from the input surface and writes the result to the provided PixelBlock.
 void querySurfaceLength(IGeometry pShape, double[] pLength, java.lang.Object pStepSize)
          Returns the length of an input polyline measured on the surface.
 void setZFactor(double pFactor)
          Multiplication factor applied to all z values to provide unit-congruency between coordinate components.
 
Methods inherited from interface com.esri.arcgis.geometry.IFunctionalSurface
getDomain, getZ
 

Field Detail

IID73b80fbc_ff33_11d1_a549_0000f8774f0f

static final int IID73b80fbc_ff33_11d1_a549_0000f8774f0f
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

getZFactor

double getZFactor()
                  throws java.io.IOException,
                         AutomationException
Multiplication factor applied to all z values to provide unit-congruency between coordinate components.

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

setZFactor

void setZFactor(double pFactor)
                throws java.io.IOException,
                       AutomationException
Multiplication factor applied to all z values to provide unit-congruency between coordinate components.

Parameters:
pFactor - The pFactor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getProjectedArea

double getProjectedArea(double referenceHeight,
                        int type)
                        throws java.io.IOException,
                               AutomationException
Returns the projected area of the surface above or below an input z value.

Parameters:
referenceHeight - The referenceHeight (in)
type - A com.esri.arcgis.geodatabase.esriPlaneReferenceType constant (in)
Returns:
The pArea
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSurfaceArea

double getSurfaceArea(double referenceHeight,
                      int type)
                      throws java.io.IOException,
                             AutomationException
Returns the area measured on its surface above or below an input z value.

Parameters:
referenceHeight - The referenceHeight (in)
type - A com.esri.arcgis.geodatabase.esriPlaneReferenceType constant (in)
Returns:
The pArea
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVolume

double getVolume(double reference,
                 int type)
                 throws java.io.IOException,
                        AutomationException
Returns the volume above or below an input z value.

Parameters:
reference - The reference (in)
type - A com.esri.arcgis.geodatabase.esriPlaneReferenceType constant (in)
Returns:
The pVolume
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryNormal

void queryNormal(IPoint pLocation,
                 IVector3D pNormal)
                 throws java.io.IOException,
                        AutomationException
Returns the vector normal to the specified triangle.

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

getElevation

double getElevation(IPoint pPoint)
                    throws java.io.IOException,
                           AutomationException
Returns the z value of the specified location.

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

getSlopeDegrees

double getSlopeDegrees(IPoint pPoint)
                       throws java.io.IOException,
                              AutomationException
Returns the slope at the specified location in degrees.

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

getSlopeRadians

double getSlopeRadians(IPoint pPoint)
                       throws java.io.IOException,
                              AutomationException
Returns the slope at the specified location in radians.

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

getSlopePercent

double getSlopePercent(IPoint pPoint)
                       throws java.io.IOException,
                              AutomationException
Returns the slope at the specified location in percent.

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

getAspectDegrees

double getAspectDegrees(IPoint pPoint)
                        throws java.io.IOException,
                               AutomationException
Returns the aspect at the specified location in degrees.

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

getAspectRadians

double getAspectRadians(IPoint pPoint)
                        throws java.io.IOException,
                               AutomationException
Returns the aspect at the specified location in radians.

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

isVoidZ

boolean isVoidZ(double value)
                throws java.io.IOException,
                       AutomationException
Returns TRUE if the passed value is equal to the surface's void value.

Parameters:
value - The value (in)
Returns:
The pbIsVoid
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interpolateShape

void interpolateShape(IGeometry pShape,
                      IGeometry[] ppOutShape,
                      java.lang.Object pStepSize)
                      throws java.io.IOException,
                             AutomationException
Interpolates z values for a defined geometric shape.

Parameters:
pShape - A reference to a com.esri.arcgis.geometry.IGeometry (in)
ppOutShape - A reference to a com.esri.arcgis.geometry.IGeometry (out: use single element array)
pStepSize - A Variant (in, optional, pass null if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interpolateShapeVertices

void interpolateShapeVertices(IGeometry pShape,
                              IGeometry[] ppOutShape)
                              throws java.io.IOException,
                                     AutomationException
Interpolates z values for a defined geometric shape at its vertices only.

Parameters:
pShape - A reference to a com.esri.arcgis.geometry.IGeometry (in)
ppOutShape - 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.

getProfile

void getProfile(IGeometry pShape,
                IGeometry[] ppProfile,
                java.lang.Object pStepSize)
                throws java.io.IOException,
                       AutomationException
Returns a polyline with z values interpolated from the surface.

Parameters:
pShape - A reference to a com.esri.arcgis.geometry.IGeometry (in)
ppProfile - A reference to a com.esri.arcgis.geometry.IGeometry (out: use single element array)
pStepSize - A Variant (in, optional, pass null if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLineOfSight

void getLineOfSight(IPoint pObserver,
                    IPoint pTarget,
                    IPoint[] ppObstruction,
                    IPolyline[] ppVisibleLines,
                    IPolyline[] ppInvisibleLines,
                    boolean[] pbIsVisible,
                    boolean bApplyCurvature,
                    boolean bApplyRefraction,
                    java.lang.Object pRefractionFactor)
                    throws java.io.IOException,
                           AutomationException
Computes the visibility of a line-of-sight from the observer to the target.

Parameters:
pObserver - A reference to a com.esri.arcgis.geometry.IPoint (in)
pTarget - A reference to a com.esri.arcgis.geometry.IPoint (in)
ppObstruction - A reference to a com.esri.arcgis.geometry.IPoint (out: use single element array)
ppVisibleLines - A reference to a com.esri.arcgis.geometry.IPolyline (out: use single element array)
ppInvisibleLines - A reference to a com.esri.arcgis.geometry.IPolyline (out: use single element array)
pbIsVisible - The pbIsVisible (out: use single element array)
bApplyCurvature - The bApplyCurvature (in)
bApplyRefraction - The bApplyRefraction (in)
pRefractionFactor - A Variant (in, optional, pass null if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

querySurfaceLength

void querySurfaceLength(IGeometry pShape,
                        double[] pLength,
                        java.lang.Object pStepSize)
                        throws java.io.IOException,
                               AutomationException
Returns the length of an input polyline measured on the surface.

Parameters:
pShape - A reference to a com.esri.arcgis.geometry.IGeometry (in)
pLength - The pLength (out: use single element array)
pStepSize - A Variant (in, optional, pass null if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

locate

IPoint locate(IRay pRay,
              int hint)
              throws java.io.IOException,
                     AutomationException
Returns the intersection of the query ray and the surface.

Parameters:
pRay - A reference to a com.esri.arcgis.geometry.IRay (in)
hint - The hint (in)
Returns:
A reference to a com.esri.arcgis.geometry.IPoint
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

locateAll

IDoubleArray locateAll(IRay pRay,
                       int hint)
                       throws java.io.IOException,
                              AutomationException
Returns the distances of intersections of the query ray and the surface.

Parameters:
pRay - A reference to a com.esri.arcgis.geometry.IRay (in)
hint - The hint (in)
Returns:
A reference to a com.esri.arcgis.system.IDoubleArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getContour

void getContour(IPoint pPoint,
                IPolyline[] ppContour,
                double[] pElevation)
                throws java.io.IOException,
                       AutomationException
Returns a countour passing through the queried point.

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

contourList

void contourList(IDoubleArray pBreaks,
                 IFeatureClass pFeatureClass,
                 java.lang.String fieldName,
                 int digitsAfterDecimalPoint)
                 throws java.io.IOException,
                        AutomationException
Output a list of contours corresponding to the specified eleveation values.

Parameters:
pBreaks - A reference to a com.esri.arcgis.system.IDoubleArray (in)
pFeatureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
fieldName - The fieldName (in)
digitsAfterDecimalPoint - The digitsAfterDecimalPoint (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

contour

void contour(double referenceContourHeight,
             double interval,
             IFeatureClass pFeatureClass,
             java.lang.String fieldName,
             int digitsAfterDecimalPoint)
             throws java.io.IOException,
                    AutomationException
Output contours based on the specified root value and interval.

Parameters:
referenceContourHeight - The referenceContourHeight (in)
interval - The interval (in)
pFeatureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
fieldName - The fieldName (in)
digitsAfterDecimalPoint - The digitsAfterDecimalPoint (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

asPolygons

void asPolygons(IFeatureClass pFeatureClass,
                int type,
                IDoubleArray pClassBreaks,
                ILongArray pClassCodes,
                java.lang.Object fieldName)
                throws java.io.IOException,
                       AutomationException
Converts the surface to a polygon feature class representing slope or aspect.

Parameters:
pFeatureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
type - A com.esri.arcgis.geodatabase.esriSurfaceConversionType constant (in)
pClassBreaks - A reference to a com.esri.arcgis.system.IDoubleArray (in)
pClassCodes - A reference to a com.esri.arcgis.system.ILongArray (in)
fieldName - A Variant (in, optional, pass null if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSteepestPath

IPolyline getSteepestPath(IPoint pPoint)
                          throws java.io.IOException,
                                 AutomationException
Returns the steepest path downhill from the specified point.

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

queryPixelBlock

void queryPixelBlock(double xOrigin,
                     double yOrigin,
                     double xPixelSize,
                     double yPixelSize,
                     int type,
                     java.lang.Object valueForNoData,
                     java.lang.Object block)
                     throws java.io.IOException,
                            AutomationException
Derives slope, aspect, hillshade, or elevation from the input surface and writes the result to the provided PixelBlock.

Parameters:
xOrigin - The xOrigin (in)
yOrigin - The yOrigin (in)
xPixelSize - The xPixelSize (in)
yPixelSize - The yPixelSize (in)
type - A com.esri.arcgis.geodatabase.esriRasterizationType constant (in)
valueForNoData - A Variant (in)
block - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.