com.esri.arcgis.animation
Interface IAGAnimationTracks

All Superinterfaces:

Serializable

All Known Implementing Classes:

AGAnimationTrackContainer, Globe, Scene

public interface IAGAnimationTracks
extends Serializable

Provides access to members that control the animation tracks.

Remarks

An animation track container accomodates all the animation tracks in an application. This interface provides methods and properties to access and manage animation tracks.

Product Availability

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

Method Summary

void	addTrack(IAGAnimationTrack pTrack) Adds a track to the collection.
void	applyTracks(boolean bApplyToAllViewers, double time) Uses the enabled animation tracks for the given time.
void	changePriority(IAGAnimationTrack pTrack, boolean bAbsolute, boolean bInSameType, int changeInIndex) Changes the priority (index) of the track.
IAGAnimationTrack	createTrack(IAGAnimationType pType) Creates a new track and adds it to the collection.
void	detachObject(Object pObject) Detach an object from all tracks it is attached to.
void	findTrack(String name, IAGAnimationTrack[] ppTrack) Finds a track by name.
IArray	getAGTracks() The animation tracks.
IAGAnimationContainer	getAnimationObjectContainer() The container of the animation objects attached to the tracks.
int	getTrackCount() The number of tracks.
IArray	getTracksOfType(IAGAnimationType 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(IAGAnimationTrack pTrack) Removes a track from the collection.
void	saveTracks(IStream pStm) Save the animation tracks to a stream.
void	setAnimationObjectContainerByRef(IAGAnimationContainer ppContainer) The container of the animation objects attached to the tracks.

Method Detail

getAnimationObjectContainer

IAGAnimationContainer getAnimationObjectContainer()
                                                  throws IOException,
                                                         AutomationException

The container of the animation objects attached to the tracks.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.animation.IAGAnimationContainer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAnimationObjectContainerByRef

void setAnimationObjectContainerByRef(IAGAnimationContainer ppContainer)
                                      throws IOException,
                                             AutomationException

The container of the animation objects attached to the tracks.

Product Availability

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

Parameters:

ppContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (in)

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.

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAGTracks

IArray getAGTracks()
                   throws IOException,
                          AutomationException

The animation tracks.

Remarks

This property returns the animation tracks in the animation track container, which is an IArray object.

Product Availability

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

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(IAGAnimationType pType)
                       throws IOException,
                              AutomationException

The animation tracks of a given type.

Product Availability

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

Parameters:

pType - A reference to a com.esri.arcgis.animation.IAGAnimationType (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.

createTrack

IAGAnimationTrack createTrack(IAGAnimationType pType)
                              throws IOException,
                                     AutomationException

Creates a new track and adds it to the collection.

Product Availability

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

Parameters:

pType - A reference to a com.esri.arcgis.animation.IAGAnimationType (in)

Returns:

A reference to a com.esri.arcgis.animation.IAGAnimationTrack

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addTrack

void addTrack(IAGAnimationTrack pTrack)
              throws IOException,
                     AutomationException

Adds a track to the collection.

Product Availability

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

Parameters:

pTrack - A reference to a com.esri.arcgis.animation.IAGAnimationTrack (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findTrack

void findTrack(String name,
               IAGAnimationTrack[] ppTrack)
               throws IOException,
                      AutomationException

Finds a track by name.

Product Availability

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

Parameters:

name - The name (in)

ppTrack - A reference to a com.esri.arcgis.animation.IAGAnimationTrack (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeTrack

void removeTrack(IAGAnimationTrack pTrack)
                 throws IOException,
                        AutomationException

Removes a track from the collection.

Product Availability

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

Parameters:

pTrack - A reference to a com.esri.arcgis.animation.IAGAnimationTrack (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.

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.

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.

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.

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.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applyTracks

void applyTracks(boolean bApplyToAllViewers,
                 double time)
                 throws IOException,
                        AutomationException

Uses the enabled animation tracks for the given time.

Product Availability

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

Parameters:

bApplyToAllViewers - The bApplyToAllViewers (in)

time - The time (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

changePriority

void changePriority(IAGAnimationTrack 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.

Parameters:

pTrack - A reference to a com.esri.arcgis.animation.IAGAnimationTrack (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.