com.esri.arcgis.animation
Interface IAGAnimationPlayer

All Superinterfaces:

Serializable

All Known Implementing Classes:

AGAnimationUtils

public interface IAGAnimationPlayer
extends Serializable

Provides access to play/record utility methods.

Remarks

This interface provides utility functions to play, record, pause and stop animations.

Product Availability

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

Method Summary

void	pauseAnimation() Pauses the playing or recording of the animation.
void	playAnimation(IAGAnimationTracks pTracks, IAGAnimationEnvironment pEnvironment, IStatusBar pStatusBar) Plays the animation according to the animation environment options.
void	recordAnimation(IAGAnimationTracks pTracks, IAGAnimationEnvironment pEnvironment, boolean bOverwrite) Records a view animation.
void	stopAnimation() Stops playing or recording the animation.

Method Detail

playAnimation

void playAnimation(IAGAnimationTracks pTracks,
                   IAGAnimationEnvironment pEnvironment,
                   IStatusBar pStatusBar)
                   throws IOException,
                          AutomationException

Plays the animation according to the animation environment options.

Product Availability

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

Parameters:

pTracks - A reference to a com.esri.arcgis.animation.IAGAnimationTracks (in)

pEnvironment - A reference to a com.esri.arcgis.animation.IAGAnimationEnvironment (in)

pStatusBar - A reference to a com.esri.arcgis.system.IStatusBar (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

recordAnimation

void recordAnimation(IAGAnimationTracks pTracks,
                     IAGAnimationEnvironment pEnvironment,
                     boolean bOverwrite)
                     throws IOException,
                            AutomationException

Records a view animation.

Product Availability

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

Parameters:

pTracks - A reference to a com.esri.arcgis.animation.IAGAnimationTracks (in)

pEnvironment - A reference to a com.esri.arcgis.animation.IAGAnimationEnvironment (in)

bOverwrite - The bOverwrite (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

pauseAnimation

void pauseAnimation()
                    throws IOException,
                           AutomationException

Pauses the playing or recording of the animation.

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.

stopAnimation

void stopAnimation()
                   throws IOException,
                          AutomationException

Stops playing or recording the animation.

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.