com.esri.arcgis.carto
Interface IGlobeDocument

All Superinterfaces:

Serializable

All Known Implementing Classes:

GlobeDocument

public interface IGlobeDocument
extends Serializable

Description

IGlobeDocument - The IGlobeDocument interface provides properties and methods for reading globe document files (*.3dd) and writing and saving changes to globe document files (*.3dd). However, since it is not tied to the ArcGlobe application, application-specific functionality in the GlobeDocument will not be persisted.

Product Availability

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

Method Summary

void	close() Close the globe document.
void	esri_new(String bsDocument) Creates and opens a new globe document in preparation for the contents to be retrieve or updated.
String	getDocumentFilename() The globe document filename that the GlobeDocument coclass is linked to.
int	getDocumentType() The type of globe document currently loaded in the object.
int	getDocumentVersion() Indicates if the version of the globe document is compatible with the current version of software.
Object	getGlobeObject() The Globe object.
ILayer	getLayer(int lLayerIndex) The Layer object at the specified index.
int	getLayerCount() The number of Layer objects contained within the globe document.
IPicture	getThumbnail() The thumbnail stored in the globe document.
void	getVersionInfo(boolean[] pbVersionInfoMissing, int[] plMajor, int[] plMinor, int[] plRevision, int[] plBuild) Retrieve the detailed version information of the globe document.
boolean	isGlobeDocument(String bsDocument) Indicates if the globe document is a valid globe document.
boolean	isPasswordProtected(String bsDocument) Indicates if the globe document is protected by a passsword.
boolean	isPresent(String bsDocument) Indicates if the globe document is present.
boolean	isReadOnly(String bsDocument) Indicates if the globe document is read only.
boolean	isRestricted(String bsDocument) Indicates if the use of the globe document is restricted to certain applications.
boolean	isUsesRelativePaths() Indicates if the data in the globe document is referenced using relative paths.
void	open(String bsDocument, String bsPassword) Open the globe document in preparation for the contents to be retrieved or updated.
void	save(boolean bUseRelativePaths, boolean bCreateThumnbail) Save the contents of the globe document to the bound file.
void	saveAs(String bsDocument, boolean bUseRelativePaths, boolean bCreateThumnbail) Save the contents of the globe document to the specified file name.
void	setGlobeObject(Object ppUnk) The Globe object.

Method Detail

isGlobeDocument

boolean isGlobeDocument(String bsDocument)
                        throws IOException,
                               AutomationException

Indicates if the globe document is a valid globe document.

Product Availability

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

Parameters:

bsDocument - The bsDocument (in)

Returns:

The pbIsGlobeDocument

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPresent

boolean isPresent(String bsDocument)
                  throws IOException,
                         AutomationException

Indicates if the globe document is present.

Product Availability

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

Parameters:

bsDocument - The bsDocument (in)

Returns:

The pbIsPresent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReadOnly

boolean isReadOnly(String bsDocument)
                   throws IOException,
                          AutomationException

Indicates if the globe document is read only.

Product Availability

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

Parameters:

bsDocument - The bsDocument (in)

Returns:

The pbIsReadOnly

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRestricted

boolean isRestricted(String bsDocument)
                     throws IOException,
                            AutomationException

Indicates if the use of the globe document is restricted to certain applications.

Product Availability

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

Parameters:

bsDocument - The bsDocument (in)

Returns:

The pbIsRestricted

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPasswordProtected

boolean isPasswordProtected(String bsDocument)
                            throws IOException,
                                   AutomationException

Indicates if the globe document is protected by a passsword.

Product Availability

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

Parameters:

bsDocument - The bsDocument (in)

Returns:

The pbIsPasswordProtected

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_new

void esri_new(String bsDocument)
              throws IOException,
                     AutomationException

Creates and opens a new globe document in preparation for the contents to be retrieve or updated.

Product Availability

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

Parameters:

bsDocument - The bsDocument (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

open

void open(String bsDocument,
          String bsPassword)
          throws IOException,
                 AutomationException

Open the globe document in preparation for the contents to be retrieved or updated.

Product Availability

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

Parameters:

bsDocument - The bsDocument (in)

bsPassword - The bsPassword (in, optional, pass if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocumentFilename

String getDocumentFilename()
                           throws IOException,
                                  AutomationException

The globe document filename that the GlobeDocument coclass is linked to.

Product Availability

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

Returns:

The pbsDocument

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocumentType

int getDocumentType()
                    throws IOException,
                           AutomationException

The type of globe document currently loaded in the object.

Product Availability

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

Returns:

A com.esri.arcgis.carto.esriGlobeDocumentType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUsesRelativePaths

boolean isUsesRelativePaths()
                            throws IOException,
                                   AutomationException

Indicates if the data in the globe document is referenced using relative paths.

Product Availability

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

Returns:

The pbUsesRelativePaths

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocumentVersion

int getDocumentVersion()
                       throws IOException,
                              AutomationException

Indicates if the version of the globe document is compatible with the current version of software.

Product Availability

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

Returns:

A com.esri.arcgis.carto.esriGlobeDocumentVersionInfo constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGlobeObject

void setGlobeObject(Object ppUnk)
                    throws IOException,
                           AutomationException

The Globe object.

Product Availability

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

Parameters:

ppUnk - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGlobeObject

Object getGlobeObject()
                      throws IOException,
                             AutomationException

The Globe object.

Product Availability

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

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerCount

int getLayerCount()
                  throws IOException,
                         AutomationException

The number of Layer objects contained within the globe document.

Product Availability

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

Returns:

The plLayerCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayer

ILayer getLayer(int lLayerIndex)
                throws IOException,
                       AutomationException

The Layer object at the specified index.

Product Availability

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

Parameters:

lLayerIndex - The lLayerIndex (in)

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.

getThumbnail

IPicture getThumbnail()
                      throws IOException,
                             AutomationException

The thumbnail stored in the globe document. If this is empty E_FAIL is returned.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.IPicture

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

close

void close()
           throws IOException,
                  AutomationException

Close the globe document.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVersionInfo

void getVersionInfo(boolean[] pbVersionInfoMissing,
                    int[] plMajor,
                    int[] plMinor,
                    int[] plRevision,
                    int[] plBuild)
                    throws IOException,
                           AutomationException

Retrieve the detailed version information of the globe document.

Product Availability

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

Parameters:

pbVersionInfoMissing - The pbVersionInfoMissing (in/out: use single element array)

plMajor - The plMajor (in/out: use single element array)

plMinor - The plMinor (in/out: use single element array)

plRevision - The plRevision (in/out: use single element array)

plBuild - The plBuild (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

void save(boolean bUseRelativePaths,
          boolean bCreateThumnbail)
          throws IOException,
                 AutomationException

Save the contents of the globe document to the bound file.

Product Availability

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

Parameters:

bUseRelativePaths - The bUseRelativePaths (in, optional, pass true if not required)

bCreateThumnbail - The bCreateThumnbail (in, optional, pass true if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveAs

void saveAs(String bsDocument,
            boolean bUseRelativePaths,
            boolean bCreateThumnbail)
            throws IOException,
                   AutomationException

Save the contents of the globe document to the specified file name.

Description

Saves the GlobeDocument that is Open and any changes that have been made to it to a new GlobeDocument with the specified filename. The filename that is supplied must be valid and include the *.3dd extension.

Product Availability

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

Parameters:

bsDocument - The bsDocument (in)

bUseRelativePaths - The bUseRelativePaths (in, optional, pass true if not required)

bCreateThumnbail - The bCreateThumnbail (in, optional, pass true if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.