com.esri.arcgis.analyst3dUI
Class DddEnvironment

java.lang.Object
  com.esri.arcgis.analyst3dUI.DddEnvironment

All Implemented Interfaces:

IDddEnvironment, com.esri.arcgis.interop.RemoteObjRef, IExtension, IExtensionConfig, IExtensionManager, IPersist, IPersistStream, ISupportErrorInfo, java.io.Externalizable, java.io.Serializable

public class DddEnvironment
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDddEnvironment, IExtension, IExtensionConfig, IExtensionManager, IPersistStream, ISupportErrorInfo, java.io.Externalizable

COM Class 'DddEnvironment'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esri3DAnalystUI.olb'

Description '3D Environment singleton object.' 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 =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.analyst3dUI.IDddEnvironment

IID, IID94305473_592e_11d4_80ee_00c04fa0adf8, xxDummy

Fields inherited from interface com.esri.arcgis.system.IExtension

IID, IID7f657ec9_dbf1_11d2_9f2f_00c04f6bc69e, xxDummy

Fields inherited from interface com.esri.arcgis.system.IExtensionConfig

IID, IID12a4c258_cc9d_4ca7_9f29_79ded88dd45f, xxDummy

Fields inherited from interface com.esri.arcgis.system.IExtensionManager

IID, IID05c71634_d9d5_4d6f_b68e_d7661142fa06, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

DddEnvironment(java.lang.Object obj)
Construct a DddEnvironment using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
IExtension	findExtension(java.lang.Object nameOrID) Finds the extension by CLSID (IUID) or name (String).
void	getClassID(GUID[] pClassID) getClassID
java.lang.String	getDescription() Detailed description of the extension.
IDisplay3D	getDisplay3D() Reference to the 3D display, if available.
IExtension	getExtension(int index) The extension at the specified index.
IUID	getExtensionCLSID(int index) The CLSID of the extension at the specified index.
int	getExtensionCount() The number of extensions loaded in the application.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getName() The name of the extension.
IApplication	getParent() Reference to the parent application.
java.lang.String	getProductName() Name of the extension.
java.lang.Object	getRasterSettings() Returns global raster settings.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getState() The state of the extension.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a DddEnvironment.
void	save(IStream pstm, int fClearDirty) save
void	setDisplay3DByRef(IDisplay3D display) Reference to the 3D display, if available.
void	setState(int state) The state of the extension.
void	shutdown() Shuts down the extension.
void	startup(java.lang.Object initializationData) Starts up the extension with the given initialization data.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

DddEnvironment

public DddEnvironment(java.lang.Object obj)
               throws java.io.IOException

Construct a DddEnvironment using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to DddEnvironment.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
DddEnvironment o = (DddEnvironment)obj; // will not work

DddEnvironment o = new DddEnvironment(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems DddEnvironment theDddEnvironment = (DddEnvironment) obj;

Method Detail

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a DddEnvironment.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getParent

public IApplication getParent()
                       throws java.io.IOException,
                              AutomationException

Reference to the parent application.

Specified by:

getParent in interface IDddEnvironment

Returns:

A reference to a com.esri.arcgis.framework.IApplication

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplay3DByRef

public void setDisplay3DByRef(IDisplay3D display)
                       throws java.io.IOException,
                              AutomationException

Reference to the 3D display, if available.

Specified by:

setDisplay3DByRef in interface IDddEnvironment

Parameters:

display - A reference to a com.esri.arcgis.display.IDisplay3D (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplay3D

public IDisplay3D getDisplay3D()
                        throws java.io.IOException,
                               AutomationException

Reference to the 3D display, if available.

Specified by:

getDisplay3D in interface IDddEnvironment

Returns:

A reference to a com.esri.arcgis.display.IDisplay3D

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterSettings

public java.lang.Object getRasterSettings()
                                   throws java.io.IOException,
                                          AutomationException

Returns global raster settings.

Specified by:

getRasterSettings in interface IDddEnvironment

Returns:

A reference to another Object (IUnknown)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the extension.

Specified by:

getName in interface IExtension

Returns:

The extensionName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startup

public void startup(java.lang.Object initializationData)
             throws java.io.IOException,
                    AutomationException

Starts up the extension with the given initialization data.

Specified by:

startup in interface IExtension

Parameters:

initializationData - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

shutdown

public void shutdown()
              throws java.io.IOException,
                     AutomationException

Shuts down the extension.

Specified by:

shutdown in interface IExtension

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProductName

public java.lang.String getProductName()
                                throws java.io.IOException,
                                       AutomationException

Name of the extension.

Specified by:

getProductName in interface IExtensionConfig

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException

Detailed description of the extension.

Specified by:

getDescription in interface IExtensionConfig

Returns:

The description

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getState

public int getState()
             throws java.io.IOException,
                    AutomationException

The state of the extension.

Specified by:

getState in interface IExtensionConfig

Returns:

A com.esri.arcgis.system.esriExtensionState constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setState

public void setState(int state)
              throws java.io.IOException,
                     AutomationException

The state of the extension.

Specified by:

setState in interface IExtensionConfig

Parameters:

state - A com.esri.arcgis.system.esriExtensionState constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtensionCount

public int getExtensionCount()
                      throws java.io.IOException,
                             AutomationException

The number of extensions loaded in the application.

Specified by:

getExtensionCount in interface IExtensionManager

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtension

public IExtension getExtension(int index)
                        throws java.io.IOException,
                               AutomationException

The extension at the specified index.

Specified by:

getExtension in interface IExtensionManager

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.system.IExtension

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtensionCLSID

public IUID getExtensionCLSID(int index)
                       throws java.io.IOException,
                              AutomationException

The CLSID of the extension at the specified index.

Specified by:

getExtensionCLSID in interface IExtensionManager

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findExtension

public IExtension findExtension(java.lang.Object nameOrID)
                         throws java.io.IOException,
                                AutomationException

Finds the extension by CLSID (IUID) or name (String).

Specified by:

findExtension in interface IExtensionManager

Parameters:

nameOrID - A Variant (in)

Returns:

A reference to a com.esri.arcgis.system.IExtension

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException