com.esri.arcgis.animation
Class AGAnimationTrackContainer

java.lang.Object
  com.esri.arcgis.animation.AGAnimationTrackContainer

All Implemented Interfaces:

IAGAnimationTracks, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable

public class AGAnimationTrackContainer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAGAnimationTracks, IPersistStream, Externalizable

The Animation Track Container Object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

AGAnimationTrackContainer()
Constructs a AGAnimationTrackContainer using ArcGIS Engine.

AGAnimationTrackContainer(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AGAnimationTrackContainer theAGAnimationTrackContainer = (AGAnimationTrackContainer) obj;

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.
boolean	equals(Object o) Compare this object with another
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.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getTrackCount() The number of tracks.
IArray	getTracksOfType(IAGAnimationType pType) The animation tracks of a given type.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	loadTracks(IStream pStm) Load the animation tracks from a stream.
void	readExternal(ObjectInput in)
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	save(IStream pstm, int fClearDirty) save
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.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

AGAnimationTrackContainer

public AGAnimationTrackContainer()
                          throws IOException,
                                 UnknownHostException

Constructs a AGAnimationTrackContainer using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

AGAnimationTrackContainer

public AGAnimationTrackContainer(Object obj)
                          throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AGAnimationTrackContainer theAGAnimationTrackContainer = (AGAnimationTrackContainer) obj;

Construct a AGAnimationTrackContainer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AGAnimationTrackContainer.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getAnimationObjectContainer

public 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.

Specified by:

getAnimationObjectContainer in interface IAGAnimationTracks

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

public 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.

Specified by:

setAnimationObjectContainerByRef in interface IAGAnimationTracks

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

public int getTrackCount()
                  throws IOException,
                         AutomationException

The number of tracks.

Product Availability

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

Specified by:

getTrackCount in interface IAGAnimationTracks

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAGTracks

public 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.

Specified by:

getAGTracks in interface IAGAnimationTracks

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

public 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.

Specified by:

getTracksOfType in interface IAGAnimationTracks

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

public 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.

Specified by:

createTrack in interface IAGAnimationTracks

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

public void addTrack(IAGAnimationTrack pTrack)
              throws IOException,
                     AutomationException

Adds a track to the collection.

Product Availability

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

Specified by:

addTrack in interface IAGAnimationTracks

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

public 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.

Specified by:

findTrack in interface IAGAnimationTracks

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

public void removeTrack(IAGAnimationTrack pTrack)
                 throws IOException,
                        AutomationException

Removes a track from the collection.

Product Availability

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

Specified by:

removeTrack in interface IAGAnimationTracks

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

public void removeAllTracks()
                     throws IOException,
                            AutomationException

Removes all tracks.

Product Availability

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

Specified by:

removeAllTracks in interface IAGAnimationTracks

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveTracks

public 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.

Specified by:

saveTracks in interface IAGAnimationTracks

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

public 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.

Specified by:

loadTracks in interface IAGAnimationTracks

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

public 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.

Specified by:

detachObject in interface IAGAnimationTracks

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

public 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.

Specified by:

refreshAttachedObjects in interface IAGAnimationTracks

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applyTracks

public 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.

Specified by:

applyTracks in interface IAGAnimationTracks

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

public 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.

Specified by:

changePriority in interface IAGAnimationTracks

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.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

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.

save

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

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException