com.esri.arcgis.analyst3d
Interface ISxAnimationEnvironment2

All Superinterfaces:

ISxAnimationEnvironment, Serializable

All Known Implementing Classes:

SxAnimationEnvironment

public interface ISxAnimationEnvironment2
extends ISxAnimationEnvironment, Serializable

Provides access to members that control the Animation Environment.

Product Availability

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

Method Summary

int	getPlayMode() The play mode (once/loop, forward/reverse).
double	getPlayTime() The current animation time during playing.
boolean	isPlayInAllViewers() Indicates if the option to play camera animations in for all viewers.
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.

Methods inherited from interface com.esri.arcgis.analyst3d.ISxAnimationEnvironment

getAnimationControlsHWnd, getAnimationDuration, getPlayInterval, getSelectedAnimationType, getSelectedKeyframes, getSelectedTracks, getState, isIntervalPlay, putPlayInterval, setAnimationControlsHWnd, setAnimationDuration, setIsIntervalPlay, setSelectedAnimationTypeByRef, setSelectedKeyframesByRef, setSelectedTracksByRef, setState

Method Detail

getPlayTime

double getPlayTime()
                   throws IOException,
                          AutomationException

The current animation time during playing.

Product Availability

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

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

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

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

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

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

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.