Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.animation
Interface IAGAnimationEnvironment

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
AGAnimationEnvironment, IAGAnimationEnvironmentProxy, SxAnimationEnvironment
public interface IAGAnimationEnvironment
extends java.io.Serializable

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

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

Field Detail

IID6e6babc1_3f0a_47f1_bbaa_53ad04e6311d

static final int IID6e6babc1_3f0a_47f1_bbaa_53ad04e6311d
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

getSelectedAGAnimationType

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

setAnimationDuration

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

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

getNumberofFrames

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

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

setNumberofFrames

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

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

isIntervalPlay

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

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

setIsIntervalPlay

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

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

getPlayInterval

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

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

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

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

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

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

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

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

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

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

setAnimationControlsHWnd

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

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

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

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

setPlayTime

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

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

isPlayInAllViewers

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

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

setPlayInAllViewers

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

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

getPlayMode

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

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

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

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

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

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

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

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

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

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

isRestoreState

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

Returns:
The pRestoreState
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD