com.esri.arcgis.animation
Interface IAGAnimationUtils

All Superinterfaces:

Serializable

All Known Implementing Classes:

AGAnimationUtils

public interface IAGAnimationUtils
extends Serializable

Provides access to animation utility methods.

Remarks

This interface provides utility functions for creating group animation, creating flyby-from-path animation, converting bookmark to a map view keyframe, capturing current view into a map view keyframe, calculating minimum number of frames for an animation, and save/load animation.

Product Availability

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

Method Summary

void	calculateDisplayFrames(IAGAnimationTracks pTracks, int[] pFrames) Calculate the number of frames to display based on the minimum animation interval.
void	captureCurrentView(IAGAnimationTracks pTracks, IAGAnimationEnvironment pEnvironment) Creates a keyframe to capture the current view and adds it to the current animation.
void	createFlybyFromPath(IAGAnimationContainer pContainer, IAGImportPathOptions pOptions) Create a flyby animation from a path.
void	createLayerGroupAnimation(IAGAnimationContainer pContainer, IAGGroupAnimationOptions pOptions) Create a layer group animation.
void	keyframeFromBookmark(IAGAnimationContainer pContainer, ISpatialBookmark pBookmark, IAGKeyframe[] ppKeyframe) Create a view keyframe from a spatial bookmark.
void	loadAnimationFile(IAGAnimationContainer pContainer, String pFilename) Load the animation from a file.
void	saveAnimationFile(IAGAnimationContainer pContainer, String pFilename, int version) Save the animation to a file.

Method Detail

createLayerGroupAnimation

void createLayerGroupAnimation(IAGAnimationContainer pContainer,
                               IAGGroupAnimationOptions pOptions)
                               throws IOException,
                                      AutomationException

Create a layer group animation.

Remarks

This utility function creates a group animation for the animation container specified by pContainer. Other options, such as the input layers, are specified by pOptions.

Product Availability

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

Parameters:

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

pOptions - A reference to a com.esri.arcgis.animation.IAGGroupAnimationOptions (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createFlybyFromPath

void createFlybyFromPath(IAGAnimationContainer pContainer,
                         IAGImportPathOptions pOptions)
                         throws IOException,
                                AutomationException

Create a flyby animation from a path.

Remarks

This utility function creates a flyby-from-path animation track for the animation container specified by pContainer. Other options, such as the flyby path, are specified in pOptions.

Product Availability

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

Parameters:

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

pOptions - A reference to a com.esri.arcgis.animation.IAGImportPathOptions (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

keyframeFromBookmark

void keyframeFromBookmark(IAGAnimationContainer pContainer,
                          ISpatialBookmark pBookmark,
                          IAGKeyframe[] ppKeyframe)
                          throws IOException,
                                 AutomationException

Create a view keyframe from a spatial bookmark.

Remarks

This utility function converts spatial bookmarks to keyframes. The input bookmark is specified by pBookmark. The output keyframe is specified by ppKeyframe.

Product Availability

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

Parameters:

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

pBookmark - A reference to a com.esri.arcgis.carto.ISpatialBookmark (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

captureCurrentView

void captureCurrentView(IAGAnimationTracks pTracks,
                        IAGAnimationEnvironment pEnvironment)
                        throws IOException,
                               AutomationException

Creates a keyframe to capture the current view and adds it to the current animation.

Remarks

This utility function captures a current view extent into a map view keyframe and add it to the animation track container (pTracks).

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)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

calculateDisplayFrames

void calculateDisplayFrames(IAGAnimationTracks pTracks,
                            int[] pFrames)
                            throws IOException,
                                   AutomationException

Calculate the number of frames to display based on the minimum animation interval.

Remarks

This utility function calculates the minimum number of frames required by a time animation to show every detail in the data. The calculation is based on the minimum time interval and the span of the time tracks. The input animation tracks are specified by pTracks, and the output number is stored in pFrames.

Product Availability

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

Parameters:

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

pFrames - The pFrames (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveAnimationFile

void saveAnimationFile(IAGAnimationContainer pContainer,
                       String pFilename,
                       int version)
                       throws IOException,
                              AutomationException

Save the animation to a file.

Remarks

This is the utility function to save an animation as a file. When an animation is saved as a file, all the animation environment settings, keyframe and track properties from the animation container (specified by pContainer) are persisted.

Product Availability

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

Parameters:

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

pFilename - The pFilename (in)

version - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadAnimationFile

void loadAnimationFile(IAGAnimationContainer pContainer,
                       String pFilename)
                       throws IOException,
                              AutomationException

Load the animation from a file.

Remarks

Load an animation file into an animation container as specified by pContainer.

Product Availability

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

Parameters:

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

pFilename - The pFilename (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.