com.esri.arcgis.animation
Class AGAnimationEnvironment

java.lang.Object
  extended by com.esri.arcgis.animation.AGAnimationEnvironment
All Implemented Interfaces:
IAGAnimationEnvironment, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

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

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

Description 'Animation Environment for animation state and global options.' 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
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.animation.IAGAnimationEnvironment
IID, IID6e6babc1_3f0a_47f1_bbaa_53ad04e6311d, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Constructor Summary
AGAnimationEnvironment()
          Constructs a AGAnimationEnvironment using ArcGIS Engine.
AGAnimationEnvironment(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AGAnimationEnvironment theAGAnimationEnvironment = (AGAnimationEnvironment) obj;
 
Method Summary
 boolean equals(java.lang.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 java.lang.String getClsid()
          getClsid.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 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(java.io.ObjectInput in)
           
 void release()
          Release a AGAnimationEnvironment.
 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(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

AGAnimationEnvironment

public AGAnimationEnvironment()
                       throws java.io.IOException,
                              java.net.UnknownHostException
Constructs a AGAnimationEnvironment using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

AGAnimationEnvironment

public AGAnimationEnvironment(java.lang.Object obj)
                       throws java.io.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:
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

release

public void release()
Release a AGAnimationEnvironment.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getSelectedAGAnimationType

public IAGAnimationType getSelectedAGAnimationType()
                                            throws java.io.IOException,
                                                   AutomationException
The selected animation type.

Specified by:
getSelectedAGAnimationType in interface IAGAnimationEnvironment
Returns:
A reference to a com.esri.arcgis.animation.IAGAnimationType
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSelectedAGAnimationTypeByRef

public void setSelectedAGAnimationTypeByRef(IAGAnimationType ppAnimType)
                                     throws java.io.IOException,
                                            AutomationException
The selected animation type.

Specified by:
setSelectedAGAnimationTypeByRef in interface IAGAnimationEnvironment
Parameters:
ppAnimType - A reference to a com.esri.arcgis.animation.IAGAnimationType (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectedTracks

public IArray getSelectedTracks()
                         throws java.io.IOException,
                                AutomationException
The selected animation tracks.

Specified by:
getSelectedTracks in interface IAGAnimationEnvironment
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.

setSelectedTracksByRef

public void setSelectedTracksByRef(IArray ppTracks)
                            throws java.io.IOException,
                                   AutomationException
The selected animation tracks.

Specified by:
setSelectedTracksByRef in interface IAGAnimationEnvironment
Parameters:
ppTracks - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectedKeyframes

public ILongArray getSelectedKeyframes()
                                throws java.io.IOException,
                                       AutomationException
The indices of the selected animation keyframes.

Specified by:
getSelectedKeyframes in interface IAGAnimationEnvironment
Returns:
A reference to a com.esri.arcgis.system.ILongArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSelectedKeyframesByRef

public void setSelectedKeyframesByRef(ILongArray ppIndices)
                               throws java.io.IOException,
                                      AutomationException
The indices of the selected animation keyframes.

Specified by:
setSelectedKeyframesByRef in interface IAGAnimationEnvironment
Parameters:
ppIndices - A reference to a com.esri.arcgis.system.ILongArray (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getState

public int getState()
             throws java.io.IOException,
                    AutomationException
The play or recording state.

Specified by:
getState in interface IAGAnimationEnvironment
Returns:
A com.esri.arcgis.animation.esriAnimationState constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setState

public void setState(int pState)
              throws java.io.IOException,
                     AutomationException
The play or recording state.

Specified by:
setState in interface IAGAnimationEnvironment
Parameters:
pState - A com.esri.arcgis.animation.esriAnimationState constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnimationDuration

public double getAnimationDuration()
                            throws java.io.IOException,
                                   AutomationException
The duration of the animation in seconds.

Specified by:
getAnimationDuration in interface IAGAnimationEnvironment
Returns:
The pSeconds
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnimationDuration

public void setAnimationDuration(double pSeconds)
                          throws java.io.IOException,
                                 AutomationException
The duration of the animation in seconds.

Specified by:
setAnimationDuration in interface IAGAnimationEnvironment
Parameters:
pSeconds - The pSeconds (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNumberofFrames

public int getNumberofFrames()
                      throws java.io.IOException,
                             AutomationException
The number of frames that will be displayed in the animation.

Specified by:
getNumberofFrames in interface IAGAnimationEnvironment
Returns:
The pFrames
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNumberofFrames

public void setNumberofFrames(int pFrames)
                       throws java.io.IOException,
                              AutomationException
The number of frames that will be displayed in the animation.

Specified by:
setNumberofFrames in interface IAGAnimationEnvironment
Parameters:
pFrames - The pFrames (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIntervalPlay

public boolean isIntervalPlay()
                       throws java.io.IOException,
                              AutomationException
Indicates whether to play only part of the animation.

Specified by:
isIntervalPlay in interface IAGAnimationEnvironment
Returns:
The pbIsInterval
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsIntervalPlay

public void setIsIntervalPlay(boolean pbIsInterval)
                       throws java.io.IOException,
                              AutomationException
Indicates whether to play only part of the animation.

Specified by:
setIsIntervalPlay in interface IAGAnimationEnvironment
Parameters:
pbIsInterval - The pbIsInterval (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPlayInterval

public void getPlayInterval(double[] pBeginTime,
                            double[] pEndTime)
                     throws java.io.IOException,
                            AutomationException
Gets the begin and end times of play interval.

Specified by:
getPlayInterval in interface IAGAnimationEnvironment
Parameters:
pBeginTime - The pBeginTime (out: use single element array)
pEndTime - The pEndTime (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putPlayInterval

public void putPlayInterval(double beginTime,
                            double endTime)
                     throws java.io.IOException,
                            AutomationException
Sets the begin and end times of play interval.

Specified by:
putPlayInterval in interface IAGAnimationEnvironment
Parameters:
beginTime - The beginTime (in)
endTime - The endTime (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPlayIntervalFrames

public void getPlayIntervalFrames(int[] pBeginFrame,
                                  int[] pEndFrame)
                           throws java.io.IOException,
                                  AutomationException
Gets the begin and end frame number when playing by frames.

Specified by:
getPlayIntervalFrames in interface IAGAnimationEnvironment
Parameters:
pBeginFrame - The pBeginFrame (out: use single element array)
pEndFrame - The pEndFrame (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putPlayIntervalFrames

public void putPlayIntervalFrames(int beginFrame,
                                  int endFrame)
                           throws java.io.IOException,
                                  AutomationException
Sets the begin and end frame number when playing by frames.

Specified by:
putPlayIntervalFrames in interface IAGAnimationEnvironment
Parameters:
beginFrame - The beginFrame (in)
endFrame - The endFrame (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnimationControlsHWnd

public int getAnimationControlsHWnd()
                             throws java.io.IOException,
                                    AutomationException
The window handle of the animation controls dialog.

Specified by:
getAnimationControlsHWnd in interface IAGAnimationEnvironment
Returns:
The phWnd (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnimationControlsHWnd

public void setAnimationControlsHWnd(int phWnd)
                              throws java.io.IOException,
                                     AutomationException
The window handle of the animation controls dialog.

Specified by:
setAnimationControlsHWnd in interface IAGAnimationEnvironment
Parameters:
phWnd - The phWnd (A COM typedef) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPlayTime

public double getPlayTime()
                   throws java.io.IOException,
                          AutomationException
The current animation time during playing.

Specified by:
getPlayTime in interface IAGAnimationEnvironment
Returns:
The pTime
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPlayTime

public void setPlayTime(double pTime)
                 throws java.io.IOException,
                        AutomationException
The current animation time during playing.

Specified by:
setPlayTime in interface IAGAnimationEnvironment
Parameters:
pTime - The pTime (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPlayInAllViewers

public boolean isPlayInAllViewers()
                           throws java.io.IOException,
                                  AutomationException
Indicates if the option to play camera animations in for all viewers.

Specified by:
isPlayInAllViewers in interface IAGAnimationEnvironment
Returns:
The pbPlayInAll
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPlayInAllViewers

public void setPlayInAllViewers(boolean pbPlayInAll)
                         throws java.io.IOException,
                                AutomationException
Indicates if the option to play camera animations in for all viewers.

Specified by:
setPlayInAllViewers in interface IAGAnimationEnvironment
Parameters:
pbPlayInAll - The pbPlayInAll (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPlayMode

public int getPlayMode()
                throws java.io.IOException,
                       AutomationException
The play mode (once/loop, forward/reverse).

Specified by:
getPlayMode in interface IAGAnimationEnvironment
Returns:
A com.esri.arcgis.animation.esriAnimationPlayMode constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPlayMode

public void setPlayMode(int pPlayMode)
                 throws java.io.IOException,
                        AutomationException
The play mode (once/loop, forward/reverse).

Specified by:
setPlayMode in interface IAGAnimationEnvironment
Parameters:
pPlayMode - A com.esri.arcgis.animation.esriAnimationPlayMode constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPlayType

public int getPlayType()
                throws java.io.IOException,
                       AutomationException
The play type, play based on duration or number of frames).

Specified by:
getPlayType in interface IAGAnimationEnvironment
Returns:
A com.esri.arcgis.animation.esriAnimationPlayType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPlayType

public void setPlayType(int pPlayType)
                 throws java.io.IOException,
                        AutomationException
The play type, play based on duration or number of frames).

Specified by:
setPlayType in interface IAGAnimationEnvironment
Parameters:
pPlayType - A com.esri.arcgis.animation.esriAnimationPlayType constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRestoreState

public void setRestoreState(boolean pRestoreState)
                     throws java.io.IOException,
                            AutomationException
Indicates the state of display after animation stops.

Specified by:
setRestoreState in interface IAGAnimationEnvironment
Parameters:
pRestoreState - The pRestoreState (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRestoreState

public boolean isRestoreState()
                       throws java.io.IOException,
                              AutomationException
Indicates the state of display after animation stops.

Specified by:
isRestoreState in interface IAGAnimationEnvironment
Returns:
The pRestoreState
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

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

Specified by:
isDirty in interface IPersistStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
load

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

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

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

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

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException