com.esri.arcgis.animation
Interface IAGAnimationEnvironment

All Superinterfaces:
Serializable
All Known Implementing Classes:
AGAnimationEnvironment, SxAnimationEnvironment

public interface IAGAnimationEnvironment
extends Serializable

Provides access to members that control the Animation Environment.

Remarks

Animation environment contains settings for animation playing and recording, such as the duration and play mode of the animation.

Product Availability

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


Method Summary
 int getAnimationControlsHWnd()
          The window handle of the animation controls dialog.
 double getAnimationDuration()
          The duration of the animation in seconds.
 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.
 int getState()
          The play or recording state.
 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 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 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.
 

Method Detail

getSelectedAGAnimationType

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

Product Availability

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

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

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

Product Availability

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

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

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

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.

setSelectedTracksByRef

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

Product Availability

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

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

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

Product Availability

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

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

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.

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

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

Product Availability

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

Returns:
A com.esri.arcgis.animation.esriAnimationState constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setState

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

Product Availability

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

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

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

Product Availability

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

Returns:
The pSeconds
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnimationDuration

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.

Parameters:
pSeconds - The pSeconds (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNumberofFrames

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.

Returns:
The pFrames
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNumberofFrames

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.

Parameters:
pFrames - The pFrames (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIntervalPlay

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.

Returns:
The pbIsInterval
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsIntervalPlay

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.

Parameters:
pbIsInterval - The pbIsInterval (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPlayInterval

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.

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

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.

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

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.

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

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.

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

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

Product Availability

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

Returns:
The phWnd (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnimationControlsHWnd

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.

Parameters:
phWnd - The phWnd (A COM typedef) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPlayTime

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

Product Availability

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

Returns:
The pTime
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPlayTime

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

Product Availability

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

Parameters:
pTime - The pTime (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPlayInAllViewers

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.

Returns:
The pbPlayInAll
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPlayInAllViewers

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.

Parameters:
pbPlayInAll - The pbPlayInAll (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPlayMode

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

Product Availability

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

Returns:
A com.esri.arcgis.animation.esriAnimationPlayMode constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPlayMode

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.

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

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.

Returns:
A com.esri.arcgis.animation.esriAnimationPlayType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPlayType

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.

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

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.

Parameters:
pRestoreState - The pRestoreState (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRestoreState

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

Product Availability

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

Returns:
The pRestoreState
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.