com.esri.arcgis.geodatabaseextensions
Class ITerrainEditProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.geodatabaseextensions.ITerrainEditProxy
All Implemented Interfaces:
ITerrainEdit, Externalizable, Serializable
Direct Known Subclasses:
ITerrainEdit2Proxy

public class ITerrainEditProxy
extends com.esri.arcgis.interop.Dispatch
implements ITerrainEdit, Serializable

Provides access to members used to modify and build a terrain.

Superseded By

ITerrainEdit2

Description

The ITerrainEdit interface is used to add or remove references to participating feature classes, control pyramid level definitions, and to (re)construct the terrain when necessary.

Product Availability

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

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  ITerrainEditProxy()
           
  ITerrainEditProxy(Object obj)
           
protected ITerrainEditProxy(Object obj, String iid)
           
 
Method Summary
 void addDataSource(ITerrainDataSource pDataSource)
          Adds a reference to a feature class.
 void addDataSourceData(int index, IEnvelope pAOI, IFeatureClass pInFC, ITrackCancel pTrackCancel)
          Appends measurements to a feature class which is embedded in the terrain.
 void addListener(String iidStr, Object theListener, Object theSource)
           
 void addPyramidLevel(ITerrainPyramidLevel pPyramidLevel)
          Adds a pyramid level.
 void build(ITrackCancel pTrackCancel)
          Constructs the terrain.
 void changeMaxScale(int index, int newScale)
          Modifies the largest display scale used for a particular level of a terrain pyramid.
 void changeResolutionBounds(int index, double lowerBound, double upperBound)
          Change the resolution bounds of a data source.
 void deleteDataSourceData(int index, IEnvelope pAOI, ITrackCancel pTrackCancel)
          Removes measurements from a feature class that is embedded in the terrain.
 void readExternal(ObjectInput in)
           
 void removeDataSource(int index)
          Removes reference to a participating feature class.
 void removeListener(String iidStr, Object theListener)
           
 void removePyramidLevel(int index)
          Removes a pyramid level.
 void replaceDataSourceData(int index, IEnvelope pAOI, IFeatureClass pInFC, ITrackCancel pTrackCancel)
          Replaces measurements from a feature class embedded in the terrain with measurements in another feature class.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ITerrainEditProxy

public ITerrainEditProxy()

ITerrainEditProxy

public ITerrainEditProxy(Object obj)
                  throws IOException
Throws:
IOException

ITerrainEditProxy

protected ITerrainEditProxy(Object obj,
                            String iid)
                     throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

addDataSource

public void addDataSource(ITerrainDataSource pDataSource)
                   throws IOException,
                          AutomationException
Adds a reference to a feature class.

Description

Adding a TerrainDataSource will invalidate the terrain and require a build. See ITerrainEdit.Build.

Product Availability

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

Specified by:
addDataSource in interface ITerrainEdit
Parameters:
pDataSource - A reference to a com.esri.arcgis.geodatabaseextensions.ITerrainDataSource (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeDataSource

public void removeDataSource(int index)
                      throws IOException,
                             AutomationException
Removes reference to a participating feature class.

Description

Removing a data source will invalidate the terrain and require a build. See ITerrainEdit.Build.

Product Availability

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

Specified by:
removeDataSource in interface ITerrainEdit
Parameters:
index - The index (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addPyramidLevel

public void addPyramidLevel(ITerrainPyramidLevel pPyramidLevel)
                     throws IOException,
                            AutomationException
Adds a pyramid level.

Description

A terrain has a pyramid. The pyramid is comprised of one or more pyramid levels. The definition for each level is added by this function. You must have at least one pyramid level defined for a terrain before it can be built. Instantiate a pyramid level definition using the TerrainPyramidLevelZTolerance coclass.

Product Availability

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

Specified by:
addPyramidLevel in interface ITerrainEdit
Parameters:
pPyramidLevel - A reference to a com.esri.arcgis.geodatabaseextensions.ITerrainPyramidLevel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removePyramidLevel

public void removePyramidLevel(int index)
                        throws IOException,
                               AutomationException
Removes a pyramid level.

Product Availability

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

Specified by:
removePyramidLevel in interface ITerrainEdit
Parameters:
index - The index (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

changeMaxScale

public void changeMaxScale(int index,
                           int newScale)
                    throws IOException,
                           AutomationException
Modifies the largest display scale used for a particular level of a terrain pyramid.

Description

A reference scale is associated with each terrain pyramid level. This is the maximum display scale at which a pyramid level is used when displaying a terrain in a map. At a larger display scale (i.e. more zoomed in) a more accurate pyramid is used.

The input index represents the pyramid level desired, from finer to coarser resolution, excluding the full resolution level. So, index 0 refers to the pyramid level with the smallest ZTolerance that is greater than 0.0. The valid index range is 0 to ITerrain.ZToleranceCount-1.

The value passed for newScale is the denominator of the scale. For example, to define a pyramid used for displays at scales up to 1:24000 pass a value of 24000.

Modifying the maximum scale for a pyramid does not necessitate a rebuild of the terrain.

Product Availability

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

Specified by:
changeMaxScale in interface ITerrainEdit
Parameters:
index - The index (in)
newScale - The newScale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

changeResolutionBounds

public void changeResolutionBounds(int index,
                                   double lowerBound,
                                   double upperBound)
                            throws IOException,
                                   AutomationException
Change the resolution bounds of a data source.

Product Availability

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

Specified by:
changeResolutionBounds in interface ITerrainEdit
Parameters:
index - The index (in)
lowerBound - The lowerBound (in)
upperBound - The upperBound (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteDataSourceData

public void deleteDataSourceData(int index,
                                 IEnvelope pAOI,
                                 ITrackCancel pTrackCancel)
                          throws IOException,
                                 AutomationException
Removes measurements from a feature class that is embedded in the terrain.

Description

The input index is the terrain data source index of the embedded feature class. Valid values range from 0 to ITerrain.DataSourceCount-1.

The pAOI argument is the area of interest envelope that's used to indicate where to remove measurements.

pTrackCancel is a pointer to a CancelTracker object.

Notes

Product Availability

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

Specified by:
deleteDataSourceData in interface ITerrainEdit
Parameters:
index - The index (in)
pAOI - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addDataSourceData

public void addDataSourceData(int index,
                              IEnvelope pAOI,
                              IFeatureClass pInFC,
                              ITrackCancel pTrackCancel)
                       throws IOException,
                              AutomationException
Appends measurements to a feature class which is embedded in the terrain.

Description

The input index is the terrain data source index of the target embedded feature class. Valid values range from 0 to ITerrain.DataSourceCount-1.

The pAOI argument is the area of interest envelope that's used as a filter when pulling measurements from the input feature class. It can be set to a NULL pointer (i.e. 'Nothing' in VB) in which case the extent of the input feature class is used.

pInFC is a pointer to the input feature class from which measurements will be added. The feature class shape type must be point or multipoint.

pTrackCancel is a pointer to a CancelTracker object.

Notes

Product Availability

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

Specified by:
addDataSourceData in interface ITerrainEdit
Parameters:
index - The index (in)
pAOI - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
pInFC - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

replaceDataSourceData

public void replaceDataSourceData(int index,
                                  IEnvelope pAOI,
                                  IFeatureClass pInFC,
                                  ITrackCancel pTrackCancel)
                           throws IOException,
                                  AutomationException
Replaces measurements from a feature class embedded in the terrain with measurements in another feature class.

Description

The input index is the terrain data source index of the embedded feature class. Valid values range from 0 to ITerrain.DataSourceCount-1.

The pAOI argument is the area of interest envelope that's used to indicate where measurements are to be replaced.

pInFC is a pointer to the input feature class from which measurements will be taken. The feature class shape type must be point or multipoint.

pTrackCancel is a pointer to a CancelTracker object.

Notes

Product Availability

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

Specified by:
replaceDataSourceData in interface ITerrainEdit
Parameters:
index - The index (in)
pAOI - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
pInFC - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

build

public void build(ITrackCancel pTrackCancel)
           throws IOException,
                  AutomationException
Constructs the terrain.

Description

Build (re)constructs the terrain as necessary. Depending on what types of edits have taken place different levels of build may be required. Some forms require a full rebuild and others just partial.

Add/Remove ZTolerance - full
Add/Remove TerrainDataSource - partial for area covered by data source measurements
ChangeMaxZScale - none
Edit of data source feature class geometry - partial for area covered by feature edits

Product Availability

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

Specified by:
build in interface ITerrainEdit
Parameters:
pTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException