com.esri.arcgis.analyst3d
Interface ISceneBookmarks

All Superinterfaces:
Serializable
All Known Subinterfaces:
ISceneBookmarks2
All Known Implementing Classes:
Globe, Scene

public interface ISceneBookmarks
extends Serializable

Provides access to members that control the scene bookmarks.

Superseded By

ISceneBookmarks2

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void addBookmark(IBookmark3D pBookmark)
          Adds a bookmark to the collection.
 void findBookmark(String name, IBookmark3D[] ppBookmark)
          Finds a bookmark by name.
 int getBookmarkCount()
          The number of bookmarks.
 IArray getBookmarks()
          The bookmarks.
 void loadBookmarks(IStream pStm)
          Load the bookmarks from a stream.
 void removeAllBookmarks()
          Removes all bookmarks.
 void removeBookmark(IBookmark3D bookmark)
          Removes a bookmark from the collection.
 void saveBookmarks(IStream pStm)
          Save the bookmarks to a stream.
 

Method Detail

getBookmarks

IArray getBookmarks()
                    throws IOException,
                           AutomationException
The bookmarks.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addBookmark

void addBookmark(IBookmark3D pBookmark)
                 throws IOException,
                        AutomationException
Adds a bookmark to the collection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pBookmark - A reference to a com.esri.arcgis.analyst3d.IBookmark3D (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findBookmark

void findBookmark(String name,
                  IBookmark3D[] ppBookmark)
                  throws IOException,
                         AutomationException
Finds a bookmark by name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Parameters:
name - The name (in)
ppBookmark - A reference to a com.esri.arcgis.analyst3d.IBookmark3D (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeBookmark

void removeBookmark(IBookmark3D bookmark)
                    throws IOException,
                           AutomationException
Removes a bookmark from the collection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Parameters:
bookmark - A reference to a com.esri.arcgis.analyst3d.IBookmark3D (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAllBookmarks

void removeAllBookmarks()
                        throws IOException,
                               AutomationException
Removes all bookmarks.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBookmarkCount

int getBookmarkCount()
                     throws IOException,
                            AutomationException
The number of bookmarks.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

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

saveBookmarks

void saveBookmarks(IStream pStm)
                   throws IOException,
                          AutomationException
Save the bookmarks to a stream.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pStm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

loadBookmarks

void loadBookmarks(IStream pStm)
                   throws IOException,
                          AutomationException
Load the bookmarks from a stream.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pStm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.