com.esri.arcgis.animation
Class AGAnimationUtils

java.lang.Object
  com.esri.arcgis.animation.AGAnimationUtils

All Implemented Interfaces:

IAGAnimationPlayer, IAGAnimationUtils, IVideoExportUtils, IVideoExportUtils2, IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class AGAnimationUtils
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IAGAnimationPlayer, IAGAnimationUtils, IVideoExportUtils2, IConnectionPointContainer

COM Class 'AGAnimationUtils'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriAnimation.olb'

Description 'Class containing common implementation of utility methods.' 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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.animation.IAGAnimationPlayer

IID, IID22a2663f_5edb_4ce3_9f97_53db2d3d4caa, xxDummy

Fields inherited from interface com.esri.arcgis.animation.IAGAnimationUtils

IID, IIDd0f357c6_b826_4f9a_9c62_cb919fcb84a8, xxDummy

Fields inherited from interface com.esri.arcgis.animation.IVideoExportUtils2

IID, IIDb082ac71_d735_48f5_b918_8def9129bb2c, xxDummy

Fields inherited from interface com.esri.arcgis.animation.IVideoExportUtils

IID3bd31712_38e4_4b6f_9ef5_bd46f90276a9

Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer

IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy

Constructor Summary

AGAnimationUtils()
Constructs a AGAnimationUtils using ArcGIS Engine.

AGAnimationUtils(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AGAnimationUtils theAGAnimationUtils = (AGAnimationUtils) obj;

Method Summary

void	addIAnimationEventsListener(IAnimationEvents theListener) addIAnimationEventsListener.
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	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(java.lang.Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
void	getCameraProperties(IAGAnimationContainer pContainer, IDoubleArray[] ppCameraProps) The camera properties.
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
void	getOffScreenBitmapHandle(IAGAnimationContainer pContainer, int[] phBitmap) The bitmap handle from an offscreen rendering buffer.
void	getOffScreenTiledBitmapHandle(IAGAnimationContainer pContainer, tagRECT pOutputRect, int[] phBitmap) The tiled bitmap handle from an offscreen rendering buffer.
void	getWindowBitmapHandle(IAGAnimationContainer pContainer, int[] phBitmap) The bitmap handle from an OpenGL or GDI rendered window.
int	hashCode() the hashcode for this object
boolean	isBBoxNavigationMode(IAGAnimationContainer pContainer) Indicates bounding box navigation mode.
void	keyframeFromBookmark(IAGAnimationContainer pContainer, ISpatialBookmark pBookmark, IAGKeyframe[] ppKeyframe) Create a view keyframe from a spatial bookmark.
void	loadAnimationFile(IAGAnimationContainer pContainer, java.lang.String pFilename) Load the animation from a file.
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	release() Release a AGAnimationUtils.
void	removeIAnimationEventsListener(IAnimationEvents theListener) removeIAnimationEventsListener.
void	restorePreviousContext(IAGAnimationContainer pContainer) Restores the OpenGL rendering context after offscreen video export.
void	saveAnimationFile(IAGAnimationContainer pContainer, java.lang.String pFilename, int version) Save the animation to a file.
void	setBBoxNavigationMode(IAGAnimationContainer pContainer, boolean pbBBoxMode) Indicates bounding box navigation mode.
void	stopAnimation() Stops playing or recording the animation.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AGAnimationUtils

public AGAnimationUtils()
                 throws java.io.IOException,
                        java.net.UnknownHostException

Constructs a AGAnimationUtils using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

AGAnimationUtils

public AGAnimationUtils(java.lang.Object obj)
                 throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AGAnimationUtils theAGAnimationUtils = (AGAnimationUtils) obj;

Construct a AGAnimationUtils using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AGAnimationUtils.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

addIAnimationEventsListener

public void addIAnimationEventsListener(IAnimationEvents theListener)
                                 throws java.io.IOException

addIAnimationEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.animation.IAnimationEvents interface.

Throws:

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

removeIAnimationEventsListener

public void removeIAnimationEventsListener(IAnimationEvents theListener)
                                    throws java.io.IOException

removeIAnimationEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.animation.IAnimationEvents interface.

Throws:

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

release

public void release()

Release a AGAnimationUtils.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

playAnimation

public void playAnimation(IAGAnimationTracks pTracks,
                          IAGAnimationEnvironment pEnvironment,
                          IStatusBar pStatusBar)
                   throws java.io.IOException,
                          AutomationException

Plays the animation according to the animation environment options.

Specified by:

playAnimation in interface IAGAnimationPlayer

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:

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

AutomationException - If the ArcObject component throws an exception.

recordAnimation

public void recordAnimation(IAGAnimationTracks pTracks,
                            IAGAnimationEnvironment pEnvironment,
                            boolean bOverwrite)
                     throws java.io.IOException,
                            AutomationException

Records a view animation.

Specified by:

recordAnimation in interface IAGAnimationPlayer

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:

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

AutomationException - If the ArcObject component throws an exception.

pauseAnimation

public void pauseAnimation()
                    throws java.io.IOException,
                           AutomationException

Pauses the playing or recording of the animation.

Specified by:

pauseAnimation in interface IAGAnimationPlayer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

stopAnimation

public void stopAnimation()
                   throws java.io.IOException,
                          AutomationException

Stops playing or recording the animation.

Specified by:

stopAnimation in interface IAGAnimationPlayer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createLayerGroupAnimation

public void createLayerGroupAnimation(IAGAnimationContainer pContainer,
                                      IAGGroupAnimationOptions pOptions)
                               throws java.io.IOException,
                                      AutomationException

Create a layer group animation.

Specified by:

createLayerGroupAnimation in interface IAGAnimationUtils

Parameters:

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createFlybyFromPath

public void createFlybyFromPath(IAGAnimationContainer pContainer,
                                IAGImportPathOptions pOptions)
                         throws java.io.IOException,
                                AutomationException

Create a flyby animation from a path.

Specified by:

createFlybyFromPath in interface IAGAnimationUtils

Parameters:

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

keyframeFromBookmark

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

Create a view keyframe from a spatial bookmark.

Specified by:

keyframeFromBookmark in interface IAGAnimationUtils

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:

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

AutomationException - If the ArcObject component throws an exception.

captureCurrentView

public void captureCurrentView(IAGAnimationTracks pTracks,
                               IAGAnimationEnvironment pEnvironment)
                        throws java.io.IOException,
                               AutomationException

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

Specified by:

captureCurrentView in interface IAGAnimationUtils

Parameters:

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

calculateDisplayFrames

public void calculateDisplayFrames(IAGAnimationTracks pTracks,
                                   int[] pFrames)
                            throws java.io.IOException,
                                   AutomationException

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

Specified by:

calculateDisplayFrames in interface IAGAnimationUtils

Parameters:

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

saveAnimationFile

public void saveAnimationFile(IAGAnimationContainer pContainer,
                              java.lang.String pFilename,
                              int version)
                       throws java.io.IOException,
                              AutomationException

Save the animation to a file.

Specified by:

saveAnimationFile in interface IAGAnimationUtils

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:

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

AutomationException - If the ArcObject component throws an exception.

loadAnimationFile

public void loadAnimationFile(IAGAnimationContainer pContainer,
                              java.lang.String pFilename)
                       throws java.io.IOException,
                              AutomationException

Load the animation from a file.

Specified by:

loadAnimationFile in interface IAGAnimationUtils

Parameters:

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

pFilename - The pFilename (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCameraProperties

public void getCameraProperties(IAGAnimationContainer pContainer,
                                IDoubleArray[] ppCameraProps)
                         throws java.io.IOException,
                                AutomationException

The camera properties.

Specified by:

getCameraProperties in interface IVideoExportUtils2

Parameters:

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

ppCameraProps - A reference to a com.esri.arcgis.system.IDoubleArray (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

restorePreviousContext

public void restorePreviousContext(IAGAnimationContainer pContainer)
                            throws java.io.IOException,
                                   AutomationException

Restores the OpenGL rendering context after offscreen video export.

Specified by:

restorePreviousContext in interface IVideoExportUtils

Parameters:

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

getOffScreenBitmapHandle

public void getOffScreenBitmapHandle(IAGAnimationContainer pContainer,
                                     int[] phBitmap)
                              throws java.io.IOException,
                                     AutomationException

The bitmap handle from an offscreen rendering buffer.

Specified by:

getOffScreenBitmapHandle in interface IVideoExportUtils

Parameters:

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

phBitmap - The phBitmap (A COM typedef) (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWindowBitmapHandle

public void getWindowBitmapHandle(IAGAnimationContainer pContainer,
                                  int[] phBitmap)
                           throws java.io.IOException,
                                  AutomationException

The bitmap handle from an OpenGL or GDI rendered window.

Specified by:

getWindowBitmapHandle in interface IVideoExportUtils

Parameters:

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

phBitmap - The phBitmap (A COM typedef) (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOffScreenTiledBitmapHandle

public void getOffScreenTiledBitmapHandle(IAGAnimationContainer pContainer,
                                          tagRECT pOutputRect,
                                          int[] phBitmap)
                                   throws java.io.IOException,
                                          AutomationException

The tiled bitmap handle from an offscreen rendering buffer.

Specified by:

getOffScreenTiledBitmapHandle in interface IVideoExportUtils

Parameters:

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

pOutputRect - A Structure: com.esri.arcgis.system.tagRECT (in)

phBitmap - The phBitmap (A COM typedef) (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isBBoxNavigationMode

public boolean isBBoxNavigationMode(IAGAnimationContainer pContainer)
                             throws java.io.IOException,
                                    AutomationException

Indicates bounding box navigation mode.

Specified by:

isBBoxNavigationMode in interface IVideoExportUtils

Parameters:

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

Returns:

The pbBBoxMode

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBBoxNavigationMode

public void setBBoxNavigationMode(IAGAnimationContainer pContainer,
                                  boolean pbBBoxMode)
                           throws java.io.IOException,
                                  AutomationException

Indicates bounding box navigation mode.

Specified by:

setBBoxNavigationMode in interface IVideoExportUtils

Parameters:

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

pbBBoxMode - The pbBBoxMode (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws java.io.IOException,
                                 AutomationException

enumConnectionPoints

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws java.io.IOException,
                                AutomationException

findConnectionPoint

Specified by:

findConnectionPoint in interface IConnectionPointContainer

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.