com.esri.arcgis.animation
Interface IAGAnimationTracks

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AGAnimationTrackContainer, Globe, IAGAnimationTracksProxy, Scene

public interface IAGAnimationTracks
extends java.io.Serializable

COM Interface 'IAGAnimationTracks'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esriAnimation.olb'

Description: 'Provides access to members that control the animation tracks.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDb71421ea_e25e_49dd_a07e_40dc9d6bd575
static int	xxDummy Deprecated. Internal use only

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

Field Detail

IIDb71421ea_e25e_49dd_a07e_40dc9d6bd575

static final int IIDb71421ea_e25e_49dd_a07e_40dc9d6bd575

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getAnimationObjectContainer

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

The container of the animation objects attached to the tracks.

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

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

The container of the animation objects attached to the tracks.

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

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

The number of tracks.

Returns:

The pCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAGTracks

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

The animation tracks.

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

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

The animation tracks of a given type.

Parameters:

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

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.

createTrack

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

Creates a new track and adds it to the collection.

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

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

Adds a track to the collection.

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

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

Finds a track by name.

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

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

Removes a track from the collection.

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

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

Removes all tracks.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

saveTracks

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

Save the animation tracks to a stream.

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.

loadTracks

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

Load the animation tracks from a stream.

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

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

Detach an object from all tracks it is attached to.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refreshAttachedObjects

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

Detaches from the tracks those objects that no longer exist.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

applyTracks

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

Uses the enabled animation tracks for the given time.

Parameters:

bApplyToAllViewers - The bApplyToAllViewers (in)

time - The time (in)

Throws:

java.io.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 java.io.IOException,
                           AutomationException

Changes the priority (index) of the track.

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:

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

AutomationException - If the ArcObject component throws an exception.