com.esri.arcgis.analyst3dUI
Class DDDToolbarEnvironment

java.lang.Object
  extended by com.esri.arcgis.analyst3dUI.DDDToolbarEnvironment
All Implemented Interfaces:
IDDDToolbarEnvironment3, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class DDDToolbarEnvironment
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDDDToolbarEnvironment3

3D Analyst Toolbar Environment.

Remarks

This coclass is a singleton. The only property of its only interface CurrentSelectedLayer refers to the layer selected in the 3D Analyst toolbar. See the VBA example for it use.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Singleton:

This type is a singleton.

See Also:
Serialized Form

Constructor Summary
DDDToolbarEnvironment()
          Constructs a DDDToolbarEnvironment using ArcGIS Engine.
DDDToolbarEnvironment(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DDDToolbarEnvironment theDDDToolbarEnvironment = (DDDToolbarEnvironment) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 ILayer getCurrentSelectedLayer()
          The ILayer interface of the current selected layer.
 String getGraphDataSaveLocation()
          The location to save graph data.
 String getGraphDataTemplate()
          The template to render graph data.
 int getInterpolateMethod()
          The interpolation method for interactive tools.
 double getInterpolateSampleDistance()
          Sampling distance for interpolation of interactive tools.
 int hashCode()
          the hashcode for this object
 boolean isInterpolateVerticesOnly()
          Interpolate only vertices for interactive tools.
 void setCurrentSelectedLayerByRef(ILayer ppLayer)
          The ILayer interface of the current selected layer.
 void setGraphDataSaveLocation(String pLocation)
          The location to save graph data.
 void setGraphDataTemplate(String pGraphTemplate)
          The template to render graph data.
 void setInterpolateMethod(int pMethod)
          The interpolation method for interactive tools.
 void setInterpolateSampleDistance(double pDistance)
          Sampling distance for interpolation of interactive tools.
 void setInterpolateVerticesOnly(boolean pVerticesOnly)
          Interpolate only vertices for interactive tools.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

DDDToolbarEnvironment

public DDDToolbarEnvironment()
                      throws IOException,
                             UnknownHostException
Constructs a DDDToolbarEnvironment using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

DDDToolbarEnvironment

public DDDToolbarEnvironment(Object obj)
                      throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DDDToolbarEnvironment theDDDToolbarEnvironment = (DDDToolbarEnvironment) obj;

Construct a DDDToolbarEnvironment using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to DDDToolbarEnvironment.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getCurrentSelectedLayer

public ILayer getCurrentSelectedLayer()
                               throws IOException,
                                      AutomationException
The ILayer interface of the current selected layer.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:
getCurrentSelectedLayer in interface IDDDToolbarEnvironment3
Returns:
A reference to a com.esri.arcgis.carto.ILayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrentSelectedLayerByRef

public void setCurrentSelectedLayerByRef(ILayer ppLayer)
                                  throws IOException,
                                         AutomationException
The ILayer interface of the current selected layer.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:
setCurrentSelectedLayerByRef in interface IDDDToolbarEnvironment3
Parameters:
ppLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGraphDataSaveLocation

public String getGraphDataSaveLocation()
                                throws IOException,
                                       AutomationException
The location to save graph data.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:
getGraphDataSaveLocation in interface IDDDToolbarEnvironment3
Returns:
The pLocation
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGraphDataSaveLocation

public void setGraphDataSaveLocation(String pLocation)
                              throws IOException,
                                     AutomationException
The location to save graph data.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

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

getInterpolateMethod

public int getInterpolateMethod()
                         throws IOException,
                                AutomationException
The interpolation method for interactive tools.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:
getInterpolateMethod in interface IDDDToolbarEnvironment3
Returns:
A com.esri.arcgis.geodatabase.esriSurfaceInterpolationType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInterpolateMethod

public void setInterpolateMethod(int pMethod)
                          throws IOException,
                                 AutomationException
The interpolation method for interactive tools.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:
setInterpolateMethod in interface IDDDToolbarEnvironment3
Parameters:
pMethod - A com.esri.arcgis.geodatabase.esriSurfaceInterpolationType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isInterpolateVerticesOnly

public boolean isInterpolateVerticesOnly()
                                  throws IOException,
                                         AutomationException
Interpolate only vertices for interactive tools.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:
isInterpolateVerticesOnly in interface IDDDToolbarEnvironment3
Returns:
The pVerticesOnly
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInterpolateVerticesOnly

public void setInterpolateVerticesOnly(boolean pVerticesOnly)
                                throws IOException,
                                       AutomationException
Interpolate only vertices for interactive tools.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

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

getInterpolateSampleDistance

public double getInterpolateSampleDistance()
                                    throws IOException,
                                           AutomationException
Sampling distance for interpolation of interactive tools.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:
getInterpolateSampleDistance in interface IDDDToolbarEnvironment3
Returns:
The pDistance
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInterpolateSampleDistance

public void setInterpolateSampleDistance(double pDistance)
                                  throws IOException,
                                         AutomationException
Sampling distance for interpolation of interactive tools.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

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

getGraphDataTemplate

public String getGraphDataTemplate()
                            throws IOException,
                                   AutomationException
The template to render graph data.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Specified by:
getGraphDataTemplate in interface IDDDToolbarEnvironment3
Returns:
The pGraphTemplate
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGraphDataTemplate

public void setGraphDataTemplate(String pGraphTemplate)
                          throws IOException,
                                 AutomationException
The template to render graph data.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

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