com.esri.arcgis.animation
Interface IAGAnimationContainer

All Superinterfaces:

Serializable

All Known Implementing Classes:

Globe

public interface IAGAnimationContainer
extends Serializable

Provides access to members that control the animation container.

Remarks

An animation container represents the application or control which supports the animation extension. The IAGAnimationContainer interface mainly contains properties and methods in getting and refreshing the view(s) of the application or control.

Product Availability

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

Method Summary

void	drawGraphsToDC(int hDC) Draw datagraphs to specified device context.
void	drawPageLayoutToDC(int hDC) Draw the page layout to specified device context.
IArray	getAllViews() All the viewers.
String	getAnimationFileExtension() The extension for the animation files.
String	getAnimationFileFilter(boolean bAllVersions) The filter for browing animation files.
IArray	getAnimationTypes() The registered types of animation.
Object	getCurrentView() The current active viewer.
IArray	getSpatialBookmarks() The spatial bookmarks that can be used to define animations.
Object	getViewController(Object pViewer) The controller object (Camera) of a viewer.
int	getWindowHandle(Object pView) The window handle associated with the given view.
boolean	isGestureEnabled() Indicates if interactive gestures are enabled.
void	putIsAnimating(boolean bAnimating, boolean bFullQuality) Indicates if the animation is active, and if full quality rendering is used (for video).
void	refreshObject(Object pObject) Container-specific actions to refresh object.
void	refreshViews(boolean bRefreshAllViewers) Refresh the active viewer or all viewers.
void	removeAllAnimationTimeStrings(IAGAnimationTracks pTracks) Remove all animation time string from the display.
void	removeTrackTimeDisplay(IAGAnimationTrack pTrack) Remove a single animation track time string from the display.
void	restoreViewerStates(boolean bApplyRestored) Restore the current state of the viewers.
void	saveViewerStates() Save the current state of the viewers.
void	setAnimationTime(IStringArray rhs1) Provides access to the animation time string.
void	setIsGestureEnabled(boolean pbGestureEnabled) Indicates if interactive gestures are enabled.

Method Detail

getAnimationTypes

IArray getAnimationTypes()
                         throws IOException,
                                AutomationException

The registered types of animation.

Product Availability

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

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.

getCurrentView

Object getCurrentView()
                      throws IOException,
                             AutomationException

The current active viewer.

Product Availability

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

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllViews

IArray getAllViews()
                   throws IOException,
                          AutomationException

All the viewers.

Product Availability

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

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.

getViewController

Object getViewController(Object pViewer)
                         throws IOException,
                                AutomationException

The controller object (Camera) of a viewer.

Product Availability

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

Parameters:

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

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refreshViews

void refreshViews(boolean bRefreshAllViewers)
                  throws IOException,
                         AutomationException

Refresh the active viewer or all viewers.

Product Availability

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

Parameters:

bRefreshAllViewers - The bRefreshAllViewers (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refreshObject

void refreshObject(Object pObject)
                   throws IOException,
                          AutomationException

Container-specific actions to refresh object.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveViewerStates

void saveViewerStates()
                      throws IOException,
                             AutomationException

Save the current state of the viewers.

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.

restoreViewerStates

void restoreViewerStates(boolean bApplyRestored)
                         throws IOException,
                                AutomationException

Restore the current state of the viewers.

Product Availability

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

Parameters:

bApplyRestored - The bApplyRestored (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putIsAnimating

void putIsAnimating(boolean bAnimating,
                    boolean bFullQuality)
                    throws IOException,
                           AutomationException

Indicates if the animation is active, and if full quality rendering is used (for video).

Product Availability

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

Parameters:

bAnimating - The bAnimating (in)

bFullQuality - The bFullQuality (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isGestureEnabled

boolean isGestureEnabled()
                         throws IOException,
                                AutomationException

Indicates if interactive gestures are enabled.

Product Availability

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

Returns:

The pbGestureEnabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsGestureEnabled

void setIsGestureEnabled(boolean pbGestureEnabled)
                         throws IOException,
                                AutomationException

Indicates if interactive gestures are enabled.

Product Availability

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

Parameters:

pbGestureEnabled - The pbGestureEnabled (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWindowHandle

int getWindowHandle(Object pView)
                    throws IOException,
                           AutomationException

The window handle associated with the given view.

Product Availability

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

Parameters:

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

Returns:

The phWnd (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAnimationFileExtension

String getAnimationFileExtension()
                                 throws IOException,
                                        AutomationException

The extension for the animation files.

Product Availability

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

Returns:

The pExt

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAnimationFileFilter

String getAnimationFileFilter(boolean bAllVersions)
                              throws IOException,
                                     AutomationException

The filter for browing animation files.

Product Availability

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

Parameters:

bAllVersions - The bAllVersions (in)

Returns:

The pFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialBookmarks

IArray getSpatialBookmarks()
                           throws IOException,
                                  AutomationException

The spatial bookmarks that can be used to define animations.

Product Availability

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

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.

removeAllAnimationTimeStrings

void removeAllAnimationTimeStrings(IAGAnimationTracks pTracks)
                                   throws IOException,
                                          AutomationException

Remove all animation time string from the display.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeTrackTimeDisplay

void removeTrackTimeDisplay(IAGAnimationTrack pTrack)
                            throws IOException,
                                   AutomationException

Remove a single animation track time string from the display.

Product Availability

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

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.

setAnimationTime

void setAnimationTime(IStringArray rhs1)
                      throws IOException,
                             AutomationException

Provides access to the animation time string.

Product Availability

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

Parameters:

rhs1 - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawGraphsToDC

void drawGraphsToDC(int hDC)
                    throws IOException,
                           AutomationException

Draw datagraphs to specified device context.

Product Availability

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

Parameters:

hDC - The hDC (A COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

drawPageLayoutToDC

void drawPageLayoutToDC(int hDC)
                        throws IOException,
                               AutomationException

Draw the page layout to specified device context.

Product Availability

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

Parameters:

hDC - The hDC (A COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.