com.esri.arcgis.analyst3d
Interface IAnimationTracks

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

public interface IAnimationTracks
extends Serializable

Provides access to members that control the scene animation tracks.

Remarks

AnimationTracks can be considered as a container/collection of all animation tracks in a Scene object. IAnimationTracks encapsulates the properties and methods related to managing all animation tracks associated with the scene.


Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void addTrack(IAnimationTrack pTrack)
          Adds a track to the collection.
 void applyTracks(ISceneViewer pViewer, double time, double duration)
          Plays the enabled animation tracks in the given viewer (in all if null).
 void changePriority(IAnimationTrack pTrack, boolean bAbsolute, boolean bInSameType, int changeInIndex)
          Changes the priority (index) of the track.
 void detachObject(Object pObject)
          Detach an object from all tracks it is attached to.
 void findTrack(String name, IAnimationTrack[] ppTrack)
          Finds a track by name.
 IArray getAnimationTypes()
          The objects that describe the registered types of animation.
 int getTrackCount()
          The number of tracks.
 IArray getTracks()
          The animation tracks.
 IArray getTracksOfType(IAnimationType pType)
          The animation tracks of a given type.
 void loadTracks(IStream pStm)
          Load the animation tracks from a stream.
 void refreshAttachedObjects()
          Detaches from the tracks those objects that no longer exist.
 void removeAllTracks()
          Removes all tracks.
 void removeTrack(IAnimationTrack pTrack)
          Removes a track from the collection.
 void saveTracks(IStream pStm)
          Save the animation tracks to a stream.
 

Method Detail

getAnimationTypes

IArray getAnimationTypes()
                         throws IOException,
                                AutomationException
The objects that describe the registered types of animation.

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.

getTrackCount

int getTrackCount()
                  throws IOException,
                         AutomationException
The number of tracks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getTracks

IArray getTracks()
                 throws IOException,
                        AutomationException
The animation tracks.

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.

getTracksOfType

IArray getTracksOfType(IAnimationType pType)
                       throws IOException,
                              AutomationException
The animation tracks of a given type.

Product Availability

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

Parameters:
pType - A reference to a com.esri.arcgis.analyst3d.IAnimationType (in)
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.

addTrack

void addTrack(IAnimationTrack pTrack)
              throws IOException,
                     AutomationException
Adds a track to the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

findTrack

void findTrack(String name,
               IAnimationTrack[] ppTrack)
               throws IOException,
                      AutomationException
Finds a track 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)
ppTrack - A reference to a com.esri.arcgis.analyst3d.IAnimationTrack (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeTrack

void removeTrack(IAnimationTrack pTrack)
                 throws IOException,
                        AutomationException
Removes a track from the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

removeAllTracks

void removeAllTracks()
                     throws IOException,
                            AutomationException
Removes all tracks.

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.

saveTracks

void saveTracks(IStream pStm)
                throws IOException,
                       AutomationException
Save the animation tracks 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.

loadTracks

void loadTracks(IStream pStm)
                throws IOException,
                       AutomationException
Load the animation tracks 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.

detachObject

void detachObject(Object pObject)
                  throws IOException,
                         AutomationException
Detach an object from all tracks it is attached to.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pObject - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refreshAttachedObjects

void refreshAttachedObjects()
                            throws IOException,
                                   AutomationException
Detaches from the tracks those objects that no longer exist.

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.

applyTracks

void applyTracks(ISceneViewer pViewer,
                 double time,
                 double duration)
                 throws IOException,
                        AutomationException
Plays the enabled animation tracks in the given viewer (in all if null).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

changePriority

void changePriority(IAnimationTrack pTrack,
                    boolean bAbsolute,
                    boolean bInSameType,
                    int changeInIndex)
                    throws IOException,
                           AutomationException
Changes the priority (index) of the track.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pTrack - A reference to a com.esri.arcgis.analyst3d.IAnimationTrack (in)
bAbsolute - The bAbsolute (in)
bInSameType - The bInSameType (in)
changeInIndex - The changeInIndex (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.