com.esri.arcgis.analyst3d
Interface ISxAnimationEnvironment

All Superinterfaces:

Serializable

All Known Subinterfaces:

ISxAnimationEnvironment2

All Known Implementing Classes:

SxAnimationEnvironment

public interface ISxAnimationEnvironment
extends Serializable

Provides access to members that control the Animation Environment.

Superseded By

ISxAnimationEnvironment2

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

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.

Method Detail

getSelectedAnimationType

IAnimationType getSelectedAnimationType()
                                        throws IOException,
                                               AutomationException

The selected animation type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Returns:

A reference to a com.esri.arcgis.analyst3d.IAnimationType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectedAnimationTypeByRef

void setSelectedAnimationTypeByRef(IAnimationType ppAnimType)
                                   throws IOException,
                                          AutomationException

The selected animation type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Parameters:

ppAnimType - A reference to a com.esri.arcgis.analyst3d.IAnimationType (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. Requires 3D Analyst Extension.

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. Requires 3D Analyst Extension.

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. Requires 3D Analyst Extension.

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. Requires 3D Analyst Extension.

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. Requires 3D Analyst Extension.

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. Requires 3D Analyst Extension.

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. Requires 3D Analyst Extension.

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. Requires 3D Analyst Extension.

Parameters:

pSeconds - The pSeconds (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. Requires 3D Analyst Extension.

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. Requires 3D Analyst Extension.

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. Requires 3D Analyst Extension.

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. Requires 3D Analyst Extension.

Parameters:

beginTime - The beginTime (in)

endTime - The endTime (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. Requires 3D Analyst Extension.

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. Requires 3D Analyst Extension.

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.