com.esri.arcgis.animation
Class AGAnimationTrackContainer

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

All Implemented Interfaces:

IAGAnimationTracks, IPersist, IPersistStream, java.io.Serializable

public class AGAnimationTrackContainer

extends java.lang.Object

implements IAGAnimationTracks, IPersistStream

The Animation Track Container coclass.

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(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

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(java.lang.Object pObject) Detach an object from all tracks it is attached to.
boolean	equals(java.lang.Object o) Compare this object with another
void	findTrack(java.lang.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.
IAGAnimationTracks	getAsIAGAnimationTracks() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStream	getAsIPersistStream() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	getClsid()
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) Supported Platforms
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() Supported Platforms
void	load(IStream pstm) Supported Platforms
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	save(IStream pstm, int fClearDirty) Supported Platforms
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AGAnimationTrackContainer

public AGAnimationTrackContainer()
                          throws java.io.IOException,
                                 java.net.UnknownHostException

Constructs a AGAnimationTrackContainer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

AGAnimationTrackContainer

public AGAnimationTrackContainer(java.lang.Object obj)
                          throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

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.
AGAnimationTrackContainer theAGAnimationTrackContainer = (AGAnimationTrackContainer) obj;

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIAGAnimationTracks

public IAGAnimationTracks getAsIAGAnimationTracks()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getAnimationObjectContainer

public IAGAnimationContainer getAnimationObjectContainer()
                                                  throws java.io.IOException,
                                                         AutomationException

Description copied from interface: IAGAnimationTracks

The container of the animation objects attached to the tracks.

Specified by:

getAnimationObjectContainer in interface IAGAnimationTracks

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAnimationObjectContainerByRef

public void setAnimationObjectContainerByRef(IAGAnimationContainer ppContainer)
                                      throws java.io.IOException,
                                             AutomationException

Description copied from interface: IAGAnimationTracks

The container of the animation objects attached to the tracks.

Specified by:

setAnimationObjectContainerByRef in interface IAGAnimationTracks

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTrackCount

public int getTrackCount()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IAGAnimationTracks

The number of tracks.

Specified by:

getTrackCount in interface IAGAnimationTracks

Returns:

The pCount

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getAGTracks

public IArray getAGTracks()
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IAGAnimationTracks

The animation tracks.

Remarks

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

Specified by:

getAGTracks in interface IAGAnimationTracks

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTracksOfType

public IArray getTracksOfType(IAGAnimationType pType)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IAGAnimationTracks

The animation tracks of a given type.

Remarks

This property returns all the tracks of a given type in the animation track container, which is an IArray object.

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:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

createTrack

public IAGAnimationTrack createTrack(IAGAnimationType pType)
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: IAGAnimationTracks

Creates a new track and adds it to the collection.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addTrack

public void addTrack(IAGAnimationTrack pTrack)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IAGAnimationTracks

Adds a track to the collection.

Specified by:

addTrack in interface IAGAnimationTracks

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findTrack

public void findTrack(java.lang.String name,
                      IAGAnimationTrack[] ppTrack)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IAGAnimationTracks

Finds a track by name.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeTrack

public void removeTrack(IAGAnimationTrack pTrack)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IAGAnimationTracks

Removes a track from the collection.

Specified by:

removeTrack in interface IAGAnimationTracks

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAllTracks

public void removeAllTracks()
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IAGAnimationTracks

Removes all tracks.

Specified by:

removeAllTracks in interface IAGAnimationTracks

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveTracks

public void saveTracks(IStream pStm)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IAGAnimationTracks

Save the animation tracks to a stream.

Specified by:

saveTracks in interface IAGAnimationTracks

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

loadTracks

public void loadTracks(IStream pStm)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IAGAnimationTracks

Load the animation tracks from a stream.

Specified by:

loadTracks in interface IAGAnimationTracks

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

detachObject

public void detachObject(java.lang.Object pObject)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IAGAnimationTracks

Detach an object from all tracks it is attached to.

Specified by:

detachObject in interface IAGAnimationTracks

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

refreshAttachedObjects

public void refreshAttachedObjects()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IAGAnimationTracks

Detaches from the tracks those objects that no longer exist.

Specified by:

refreshAttachedObjects in interface IAGAnimationTracks

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

applyTracks

public void applyTracks(boolean bApplyToAllViewers,
                        double time)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IAGAnimationTracks

Uses the enabled animation tracks for the given time.

Specified by:

applyTracks in interface IAGAnimationTracks

Parameters:

bApplyToAllViewers - The bApplyToAllViewers (in)

time - The time (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

changePriority

public void changePriority(IAGAnimationTrack pTrack,
                           boolean bAbsolute,
                           boolean bInSameType,
                           int changeInIndex)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IAGAnimationTracks

Changes the priority (index) of the track.

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:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

save

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getClassID

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

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.