com.esri.arcgis.analyst3d
Interface ISxAnimationEnvironment

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
ISxAnimationEnvironment2
All Known Implementing Classes:
ISxAnimationEnvironment2Proxy, ISxAnimationEnvironmentProxy, SxAnimationEnvironment

public interface ISxAnimationEnvironment
extends java.io.Serializable

COM Interface 'ISxAnimationEnvironment'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esri3DAnalyst.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 IIDa4c0b647_82ad_11d5_b29b_00508bcdde28
           
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.
 void getPlayInterval(double[] pBeginTime, double[] pEndTime)
          Gets the begin and end times of play interval.
 IAnimationType getSelectedAnimationType()
          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.
 void putPlayInterval(double beginTime, double endTime)
          Sets the begin and end times of play interval.
 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 setSelectedAnimationTypeByRef(IAnimationType 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

IIDa4c0b647_82ad_11d5_b29b_00508bcdde28

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

getSelectedAnimationType

IAnimationType getSelectedAnimationType()
                                        throws java.io.IOException,
                                               AutomationException
The selected animation type.

Returns:
A reference to a com.esri.arcgis.analyst3d.IAnimationType
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSelectedAnimationTypeByRef

void setSelectedAnimationTypeByRef(IAnimationType ppAnimType)
                                   throws java.io.IOException,
                                          AutomationException
The selected animation type.

Parameters:
ppAnimType - A reference to a com.esri.arcgis.analyst3d.IAnimationType (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.

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.

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.