com.esri.arcgis.animation
Class AGAnimationEnvironment

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

All Implemented Interfaces:

IAGAnimationEnvironment, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable

public class AGAnimationEnvironment
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAGAnimationEnvironment, IPersistStream, Externalizable

Animation Environment for animation state and global options.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

AGAnimationEnvironment()
Constructs a AGAnimationEnvironment using ArcGIS Engine.

AGAnimationEnvironment(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AGAnimationEnvironment theAGAnimationEnvironment = (AGAnimationEnvironment) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
int	getAnimationControlsHWnd() The window handle of the animation controls dialog.
double	getAnimationDuration() The duration of the animation in seconds.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
int	getNumberofFrames() The number of frames that will be displayed in the animation.
void	getPlayInterval(double[] pBeginTime, double[] pEndTime) Gets the begin and end times of play interval.
void	getPlayIntervalFrames(int[] pBeginFrame, int[] pEndFrame) Gets the begin and end frame number when playing by frames.
int	getPlayMode() The play mode (once/loop, forward/reverse).
double	getPlayTime() The current animation time during playing.
int	getPlayType() The play type, play based on duration or number of frames).
IAGAnimationType	getSelectedAGAnimationType() The selected animation type.
ILongArray	getSelectedKeyframes() The indices of the selected animation keyframes.
IArray	getSelectedTracks() The selected animation tracks.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getState() The play or recording state.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isIntervalPlay() Indicates whether to play only part of the animation.
boolean	isPlayInAllViewers() Indicates if the option to play camera animations in for all viewers.
boolean	isRestoreState() Indicates the state of display after animation stops.
void	load(IStream pstm) load
void	putPlayInterval(double beginTime, double endTime) Sets the begin and end times of play interval.
void	putPlayIntervalFrames(int beginFrame, int endFrame) Sets the begin and end frame number when playing by frames.
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	setAnimationControlsHWnd(int phWnd) The window handle of the animation controls dialog.
void	setAnimationDuration(double pSeconds) The duration of the animation in seconds.
void	setIsIntervalPlay(boolean pbIsInterval) Indicates whether to play only part of the animation.
void	setNumberofFrames(int pFrames) The number of frames that will be displayed in the animation.
void	setPlayInAllViewers(boolean pbPlayInAll) Indicates if the option to play camera animations in for all viewers.
void	setPlayMode(int pPlayMode) The play mode (once/loop, forward/reverse).
void	setPlayTime(double pTime) The current animation time during playing.
void	setPlayType(int pPlayType) The play type, play based on duration or number of frames).
void	setRestoreState(boolean pRestoreState) Indicates the state of display after animation stops.
void	setSelectedAGAnimationTypeByRef(IAGAnimationType ppAnimType) The selected animation type.
void	setSelectedKeyframesByRef(ILongArray ppIndices) The indices of the selected animation keyframes.
void	setSelectedTracksByRef(IArray ppTracks) The selected animation tracks.
void	setState(int pState) The play or recording state.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

AGAnimationEnvironment

public AGAnimationEnvironment()
                       throws IOException,
                              UnknownHostException

Constructs a AGAnimationEnvironment using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

AGAnimationEnvironment

public AGAnimationEnvironment(Object obj)
                       throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getSelectedAGAnimationType

public IAGAnimationType getSelectedAGAnimationType()
                                            throws IOException,
                                                   AutomationException

The selected animation type.

Product Availability

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

Specified by:

getSelectedAGAnimationType in interface IAGAnimationEnvironment

Returns:

A reference to a com.esri.arcgis.animation.IAGAnimationType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectedAGAnimationTypeByRef

public void setSelectedAGAnimationTypeByRef(IAGAnimationType ppAnimType)
                                     throws IOException,
                                            AutomationException

The selected animation type.

Product Availability

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

Specified by:

setSelectedAGAnimationTypeByRef in interface IAGAnimationEnvironment

Parameters:

ppAnimType - A reference to a com.esri.arcgis.animation.IAGAnimationType (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedTracks

public IArray getSelectedTracks()
                         throws IOException,
                                AutomationException

The selected animation tracks.

Product Availability

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

Specified by:

getSelectedTracks in interface IAGAnimationEnvironment

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.

setSelectedTracksByRef

public void setSelectedTracksByRef(IArray ppTracks)
                            throws IOException,
                                   AutomationException

The selected animation tracks.

Product Availability

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

Specified by:

setSelectedTracksByRef in interface IAGAnimationEnvironment

Parameters:

ppTracks - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedKeyframes

public ILongArray getSelectedKeyframes()
                                throws IOException,
                                       AutomationException

The indices of the selected animation keyframes.

Product Availability

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

Specified by:

getSelectedKeyframes in interface IAGAnimationEnvironment

Returns:

A reference to a com.esri.arcgis.system.ILongArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectedKeyframesByRef

public void setSelectedKeyframesByRef(ILongArray ppIndices)
                               throws IOException,
                                      AutomationException

The indices of the selected animation keyframes.

Product Availability

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

Specified by:

setSelectedKeyframesByRef in interface IAGAnimationEnvironment

Parameters:

ppIndices - A reference to a com.esri.arcgis.system.ILongArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getState

public int getState()
             throws IOException,
                    AutomationException

The play or recording state.

Product Availability

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

Specified by:

getState in interface IAGAnimationEnvironment

Returns:

A com.esri.arcgis.animation.esriAnimationState constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setState

public void setState(int pState)
              throws IOException,
                     AutomationException

The play or recording state.

Product Availability

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

Specified by:

setState in interface IAGAnimationEnvironment

Parameters:

pState - A com.esri.arcgis.animation.esriAnimationState constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAnimationDuration

public double getAnimationDuration()
                            throws IOException,
                                   AutomationException

The duration of the animation in seconds.

Product Availability

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

Specified by:

getAnimationDuration in interface IAGAnimationEnvironment

Returns:

The pSeconds

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAnimationDuration

public void setAnimationDuration(double pSeconds)
                          throws IOException,
                                 AutomationException

The duration of the animation in seconds.

Product Availability

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

Specified by:

setAnimationDuration in interface IAGAnimationEnvironment

Parameters:

pSeconds - The pSeconds (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumberofFrames

public int getNumberofFrames()
                      throws IOException,
                             AutomationException

The number of frames that will be displayed in the animation.

Product Availability

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

Specified by:

getNumberofFrames in interface IAGAnimationEnvironment

Returns:

The pFrames

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumberofFrames

public void setNumberofFrames(int pFrames)
                       throws IOException,
                              AutomationException

The number of frames that will be displayed in the animation.

Product Availability

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

Specified by:

setNumberofFrames in interface IAGAnimationEnvironment

Parameters:

pFrames - The pFrames (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIntervalPlay

public boolean isIntervalPlay()
                       throws IOException,
                              AutomationException

Indicates whether to play only part of the animation.

Product Availability

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

Specified by:

isIntervalPlay in interface IAGAnimationEnvironment

Returns:

The pbIsInterval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsIntervalPlay

public void setIsIntervalPlay(boolean pbIsInterval)
                       throws IOException,
                              AutomationException

Indicates whether to play only part of the animation.

Product Availability

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

Specified by:

setIsIntervalPlay in interface IAGAnimationEnvironment

Parameters:

pbIsInterval - The pbIsInterval (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPlayInterval

public void getPlayInterval(double[] pBeginTime,
                            double[] pEndTime)
                     throws IOException,
                            AutomationException

Gets the begin and end times of play interval.

Product Availability

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

Specified by:

getPlayInterval in interface IAGAnimationEnvironment

Parameters:

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putPlayInterval

public void putPlayInterval(double beginTime,
                            double endTime)
                     throws IOException,
                            AutomationException

Sets the begin and end times of play interval.

Product Availability

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

Specified by:

putPlayInterval in interface IAGAnimationEnvironment

Parameters:

beginTime - The beginTime (in)

endTime - The endTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPlayIntervalFrames

public void getPlayIntervalFrames(int[] pBeginFrame,
                                  int[] pEndFrame)
                           throws IOException,
                                  AutomationException

Gets the begin and end frame number when playing by frames.

Product Availability

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

Specified by:

getPlayIntervalFrames in interface IAGAnimationEnvironment

Parameters:

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putPlayIntervalFrames

public void putPlayIntervalFrames(int beginFrame,
                                  int endFrame)
                           throws IOException,
                                  AutomationException

Sets the begin and end frame number when playing by frames.

Product Availability

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

Specified by:

putPlayIntervalFrames in interface IAGAnimationEnvironment

Parameters:

beginFrame - The beginFrame (in)

endFrame - The endFrame (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAnimationControlsHWnd

public int getAnimationControlsHWnd()
                             throws IOException,
                                    AutomationException

The window handle of the animation controls dialog.

Product Availability

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

Specified by:

getAnimationControlsHWnd in interface IAGAnimationEnvironment

Returns:

The phWnd (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAnimationControlsHWnd

public void setAnimationControlsHWnd(int phWnd)
                              throws IOException,
                                     AutomationException

The window handle of the animation controls dialog.

Product Availability

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

Specified by:

setAnimationControlsHWnd in interface IAGAnimationEnvironment

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPlayTime

public double getPlayTime()
                   throws IOException,
                          AutomationException

The current animation time during playing.

Product Availability

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

Specified by:

getPlayTime in interface IAGAnimationEnvironment

Returns:

The pTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPlayTime

public void setPlayTime(double pTime)
                 throws IOException,
                        AutomationException

The current animation time during playing.

Product Availability

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

Specified by:

setPlayTime in interface IAGAnimationEnvironment

Parameters:

pTime - The pTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPlayInAllViewers

public boolean isPlayInAllViewers()
                           throws IOException,
                                  AutomationException

Indicates if the option to play camera animations in for all viewers.

Product Availability

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

Specified by:

isPlayInAllViewers in interface IAGAnimationEnvironment

Returns:

The pbPlayInAll

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPlayInAllViewers

public void setPlayInAllViewers(boolean pbPlayInAll)
                         throws IOException,
                                AutomationException

Indicates if the option to play camera animations in for all viewers.

Product Availability

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

Specified by:

setPlayInAllViewers in interface IAGAnimationEnvironment

Parameters:

pbPlayInAll - The pbPlayInAll (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPlayMode

public int getPlayMode()
                throws IOException,
                       AutomationException

The play mode (once/loop, forward/reverse).

Product Availability

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

Specified by:

getPlayMode in interface IAGAnimationEnvironment

Returns:

A com.esri.arcgis.animation.esriAnimationPlayMode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPlayMode

public void setPlayMode(int pPlayMode)
                 throws IOException,
                        AutomationException

The play mode (once/loop, forward/reverse).

Product Availability

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

Specified by:

setPlayMode in interface IAGAnimationEnvironment

Parameters:

pPlayMode - A com.esri.arcgis.animation.esriAnimationPlayMode constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPlayType

public int getPlayType()
                throws IOException,
                       AutomationException

The play type, play based on duration or number of frames).

Product Availability

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

Specified by:

getPlayType in interface IAGAnimationEnvironment

Returns:

A com.esri.arcgis.animation.esriAnimationPlayType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPlayType

public void setPlayType(int pPlayType)
                 throws IOException,
                        AutomationException

The play type, play based on duration or number of frames).

Product Availability

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

Specified by:

setPlayType in interface IAGAnimationEnvironment

Parameters:

pPlayType - A com.esri.arcgis.animation.esriAnimationPlayType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRestoreState

public void setRestoreState(boolean pRestoreState)
                     throws IOException,
                            AutomationException

Indicates the state of display after animation stops.

Product Availability

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

Specified by:

setRestoreState in interface IAGAnimationEnvironment

Parameters:

pRestoreState - The pRestoreState (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRestoreState

public boolean isRestoreState()
                       throws IOException,
                              AutomationException

Indicates the state of display after animation stops.

Product Availability

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

Specified by:

isRestoreState in interface IAGAnimationEnvironment

Returns:

The pRestoreState

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException