com.esri.arcgis.animation
Interface IAGAnimationContainer

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

Globe, IAGAnimationContainerProxy

public interface IAGAnimationContainer
extends java.io.Serializable

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

Description: 'Provides access to members that control the animation container.' 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	IIDac5655cd_56cf_4c9f_a1c0_a9f80ba453ea
static int	xxDummy Deprecated. Internal use only

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.
java.lang.String	getAnimationFileExtension() The extension for the animation files.
java.lang.String	getAnimationFileFilter(boolean bAllVersions) The filter for browing animation files.
IArray	getAnimationTypes() The registered types of animation.
java.lang.Object	getCurrentView() The current active viewer.
IArray	getSpatialBookmarks() The spatial bookmarks that can be used to define animations.
java.lang.Object	getViewController(java.lang.Object pViewer) The controller object (Camera) of a viewer.
int	getWindowHandle(java.lang.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(java.lang.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.

Field Detail

IIDac5655cd_56cf_4c9f_a1c0_a9f80ba453ea

static final int IIDac5655cd_56cf_4c9f_a1c0_a9f80ba453ea

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

getAnimationTypes

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

The registered types of animation.

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.

getCurrentView

java.lang.Object getCurrentView()
                                throws java.io.IOException,
                                       AutomationException

The current active viewer.

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAllViews

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

All the viewers.

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.

getViewController

java.lang.Object getViewController(java.lang.Object pViewer)
                                   throws java.io.IOException,
                                          AutomationException

The controller object (Camera) of a viewer.

Parameters:

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

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refreshViews

void refreshViews(boolean bRefreshAllViewers)
                  throws java.io.IOException,
                         AutomationException

Refresh the active viewer or all viewers.

Parameters:

bRefreshAllViewers - The bRefreshAllViewers (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refreshObject

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

Container-specific actions to refresh object.

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.

saveViewerStates

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

Save the current state of the viewers.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

restoreViewerStates

void restoreViewerStates(boolean bApplyRestored)
                         throws java.io.IOException,
                                AutomationException

Restore the current state of the viewers.

Parameters:

bApplyRestored - The bApplyRestored (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

putIsAnimating

void putIsAnimating(boolean bAnimating,
                    boolean bFullQuality)
                    throws java.io.IOException,
                           AutomationException

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

Parameters:

bAnimating - The bAnimating (in)

bFullQuality - The bFullQuality (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isGestureEnabled

boolean isGestureEnabled()
                         throws java.io.IOException,
                                AutomationException

Indicates if interactive gestures are enabled.

Returns:

The pbGestureEnabled

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsGestureEnabled

void setIsGestureEnabled(boolean pbGestureEnabled)
                         throws java.io.IOException,
                                AutomationException

Indicates if interactive gestures are enabled.

Parameters:

pbGestureEnabled - The pbGestureEnabled (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWindowHandle

int getWindowHandle(java.lang.Object pView)
                    throws java.io.IOException,
                           AutomationException

The window handle associated with the given view.

Parameters:

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

Returns:

The phWnd (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAnimationFileExtension

java.lang.String getAnimationFileExtension()
                                           throws java.io.IOException,
                                                  AutomationException

The extension for the animation files.

Returns:

The pExt

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAnimationFileFilter

java.lang.String getAnimationFileFilter(boolean bAllVersions)
                                        throws java.io.IOException,
                                               AutomationException

The filter for browing animation files.

Parameters:

bAllVersions - The bAllVersions (in)

Returns:

The pFilter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpatialBookmarks

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

The spatial bookmarks that can be used to define animations.

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.

removeAllAnimationTimeStrings

void removeAllAnimationTimeStrings(IAGAnimationTracks pTracks)
                                   throws java.io.IOException,
                                          AutomationException

Remove all animation time string from the display.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeTrackTimeDisplay

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

Remove a single animation track time string from the display.

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.

setAnimationTime

void setAnimationTime(IStringArray rhs1)
                      throws java.io.IOException,
                             AutomationException

Provides access to the animation time string.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

drawGraphsToDC

void drawGraphsToDC(int hDC)
                    throws java.io.IOException,
                           AutomationException

Draw datagraphs to specified device context.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

drawPageLayoutToDC

void drawPageLayoutToDC(int hDC)
                        throws java.io.IOException,
                               AutomationException

Draw the page layout to specified device context.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.