AGAnimationEnvironment (ArcObjects Java API)

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
Class AGAnimationEnvironment

java.lang.Object
  com.esri.arcgis.animation.AGAnimationEnvironment

All Implemented Interfaces:: IAGAnimationEnvironment, IPersist, IPersistStream, java.io.Serializable

public class AGAnimationEnvironment
extends java.lang.Object
implements IAGAnimationEnvironment, IPersistStream

Animation Environment for animation state and global options.

Product Availability

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

See Also:: Serialized Form

Constructor Summary
`AGAnimationEnvironment()` Constructs a AGAnimationEnvironment using ArcGIS Engine.
`AGAnimationEnvironment(java.lang.Object obj)` Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary
`boolean`	`equals(java.lang.Object o)` Compare this object with another
`int`	`getAnimationControlsHWnd()` The window handle of the animation controls dialog.
`double`	`getAnimationDuration()` The duration of the animation in seconds.
`IAGAnimationEnvironment`	`getAsIAGAnimationEnvironment()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IPersistStream`	`getAsIPersistStream()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`void`	`getClassID(GUID[] pClassID)` Supported Platforms
`static java.lang.String`	`getClsid()`
`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.
`void`	`getSizeMax(_ULARGE_INTEGER[] pcbSize)` Supported Platforms
`int`	`getState()` The play or recording state.
`int`	`hashCode()` the hashcode for this object
`void`	`isDirty()` Supported Platforms
`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()` Restore state of display after animation stops.
`void`	`load(IStream pstm)` Supported Platforms
`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`	`save(IStream pstm, int fClearDirty)` Supported Platforms
`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)` Restore 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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AGAnimationEnvironment

public AGAnimationEnvironment()
                       throws java.io.IOException,
                              java.net.UnknownHostException

Constructs a AGAnimationEnvironment using ArcGIS Engine.
Throws:: java.io.IOException - if there are interop problems; java.net.UnknownHostException - if there are interop problems

AGAnimationEnvironment

public AGAnimationEnvironment(java.lang.Object obj)
                       throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.; Construct a AGAnimationEnvironment using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AGAnimationEnvironment.
AGAnimationEnvironment theAGAnimationEnvironment = (AGAnimationEnvironment) obj;
Parameters:: obj - an object returned from ArcGIS Engine or Server
Throws:: java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIAGAnimationEnvironment

public IAGAnimationEnvironment getAsIAGAnimationEnvironment()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object