com.esri.arcgis.analyst3d
Class AnimationTrack

java.lang.Object
  extended bycom.esri.arcgis.analyst3d.AnimationTrack
All Implemented Interfaces:
IAGAnimationTrack, IAGAnimationTrackKeyframes, IAnimationTrack, IPersist, IPersistStream, java.io.Serializable

public class AnimationTrack
extends java.lang.Object
implements IAnimationTrack, IAGAnimationTrack, IAGAnimationTrackKeyframes, IPersistStream

The Animation Track coclass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Remarks

Animation tracks are conceptually containers of animation keyframes.  A scene object may have zero, one, or more animation tracks.  Each animation track is associated with one certain animation type.

See Also:
Serialized Form

Constructor Summary
AnimationTrack()
          Constructs a AnimationTrack using ArcGIS Engine.
AnimationTrack(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
 
Method Summary
 void attachObject(java.lang.Object pObject)
          Attach object to the track.
 IAGKeyframe createKeyframe(int index)
          Creates a new keyframe of the appropriate type and inserts it.
 void detachAllObjects()
          Detach all objects from the track.
 void detachObject(java.lang.Object pObject)
          Detach object from the track.
 boolean equals(java.lang.Object o)
          Compare this object with another
 void findKeyframe(java.lang.String name, IAGKeyframe[] ppKeyframe)
          Finds a keyframe by name.
 void findKeyframe(java.lang.String name, IKeyframe[] ppKeyframe)
          Finds a keyframe by name.
 ILongArray getActiveProperties()
          The combination of active properties for the track.
 IAGAnimationContainer getAnimationObjectContainer()
          The container of the animation objects attached to the tracks.
 IAnimationType getAnimationType()
          The animation type.
 IAGAnimationTrack getAsIAGAnimationTrack()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IAGAnimationTrackKeyframes getAsIAGAnimationTrackKeyframes()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IAnimationTrack getAsIAnimationTrack()
          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.
 IArray getAttachedObjects()
          The objects to which the track is attached, or null.
 int getAttachedObjectsCount()
          The number of objects to which the track is attached.
 double getBeginTime()
          The initial time of the track.
 void getClassID(GUID[] pClassID)
          Supported Platforms
static java.lang.String getClsid()
           
 double getEndTime()
          The final time of the track.
 IKeyframe getKeyframe(int index)
          The keyframe with the given index in the track.
 int getKeyframeCount()
          The number of keyframes defined in the track.
 IAGKeyframe getLastInterpolatedKeyframe()
          The last keyframe that was interpolated in the track.
 java.lang.String getName()
          The name of the track.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          Supported Platforms
 int hashCode()
          the hashcode for this object
 IAGAnimationType IAGAnimationTrack_getAnimationType()
          The animation type.
 IAGKeyframe IAGAnimationTrackKeyframes_getKeyframe(int index)
          The keyframe with the given index in the track.
 void insertKeyframe(IAGKeyframe pKeyframe, int index)
          Inserts a new keyframe.
 void insertKeyframe(IKeyframe pKeyframe, int index)
          Inserts a new keyframe.
 void interpolateObjectProperties(IAGAnimationContainer pContainer, double time)
          Interpolates the state of the attached object for a time between BeginTime and Endtime.
 void interpolateObjectProperties(IScene pScene, double time)
          Interpolates the state of the attached object for a time between BeginTime and Endtime.
 boolean isActiveProperty(int propIndex)
          Indicates if an animation property is active.
 boolean isApplyToAllViewers()
          Indicates whether to apply a camera track to all scene viewers.
 boolean isAttached(java.lang.Object pObject)
          Indicates if the given objects is attached to the track.
 boolean isCycle()
          Indicates if the track is repeated periodically.
 void isDirty()
          Supported Platforms
 boolean isEnabled()
          Indicates if the track is enabled.
 boolean isEvenTimeStamps()
          Indicates whether to distribute time stamps evenly in the interval 0-1.
 void load(IStream pstm)
          Supported Platforms
 void moveKeyframe(int originIndex, int destinationIndex)
          Moves the keyframe with the given index, inserting it with a different index.
 void removeAllKeyframes()
          Removes all the keyframes.
 void removeKeyframe(int index)
          Removes the keyframe with the given index.
 void resetAttachedObjects(IAGAnimationContainer pContainer)
          Reset the state of the attached objects to be ready for animation.
 void resetAttachedObjects(IScene pScene)
          Reset the state of the attached objects to be ready for animation.
 void resetTimeStamps()
          Redistributes the time stamps in the interval [0,1].
 void restoreObjectProperties(IAGAnimationContainer pContainer, int index)
          Restores the saved properties of the attached object specified.
 void restoreObjectProperties(IScene pScene, int index)
          Restores the saved properties of the attached object specified.
 void save(IStream pstm, int fClearDirty)
          Supported Platforms
 void saveObjectProperties(IAGAnimationContainer pContainer, int index)
          Internally saves the properties of the attached object specified.
 void saveObjectProperties(IScene pScene, int index)
          Internally saves the properties of the attached object specified.
 void setActiveProperties(ILongArray ppActiveProps)
          The combination of active properties for the track.
 void setAnimationObjectContainerByRef(IAGAnimationContainer ppContainer)
          The container of the animation objects attached to the tracks.
 void setAnimationTypeByRef(IAGAnimationType ppAnimationType)
          The animation type.
 void setAnimationTypeByRef(IAnimationType ppAnimationType)
          The animation type.
 void setApplyToAllViewers(boolean pbApplyToAllViewers)
          Indicates whether to apply a camera track to all scene viewers.
 void setAttachedObjects(IArray ppObjectArray)
          The objects to which the track is attached, or null.
 void setBeginTime(double pBeginTime)
          The initial time of the track.
 void setEndTime(double pEndTime)
          The final time of the track.
 void setEvenTimeStamps(boolean pbEvenTimeStamps)
          Indicates whether to distribute time stamps evenly in the interval 0-1.
 void setIsActiveProperty(int propIndex, boolean pbIsActiveProp)
          Indicates if an animation property is active.
 void setIsCycle(boolean pbIsCycle)
          Indicates if the track is repeated periodically.
 void setIsEnabled(boolean pbIsEnabled)
          Indicates if the track is enabled.
 void setName(java.lang.String name)
          The name of the track.
 void sortKeyframes()
          Sorts the keyframes in ascending time order.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AnimationTrack

public AnimationTrack()
               throws java.io.IOException,
                      java.net.UnknownHostException
Constructs a AnimationTrack using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

AnimationTrack

public AnimationTrack(java.lang.Object obj)
               throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a AnimationTrack using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AnimationTrack.
AnimationTrack theAnimationTrack = (AnimationTrack) 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()

getAsIAnimationTrack

public IAnimationTrack getAsIAnimationTrack()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIAGAnimationTrack

public IAGAnimationTrack getAsIAGAnimationTrack()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIAGAnimationTrackKeyframes

public IAGAnimationTrackKeyframes getAsIAGAnimationTrackKeyframes()
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


getActiveProperties

public ILongArray getActiveProperties()
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: IAnimationTrack
The combination of active properties for the track.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getActiveProperties in interface IAnimationTrack
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.

setActiveProperties

public void setActiveProperties(ILongArray ppActiveProps)
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IAnimationTrack
The combination of active properties for the track.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setActiveProperties in interface IAnimationTrack
Parameters:
ppActiveProps - A reference to a com.esri.arcgis.system.ILongArray (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isActiveProperty

public boolean isActiveProperty(int propIndex)
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IAnimationTrack
Indicates if an animation property is active.

Specified by:
isActiveProperty in interface IAnimationTrack
Parameters:
propIndex - The propIndex (in)
Returns:
The pbIsActiveProp
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsActiveProperty

public void setIsActiveProperty(int propIndex,
                                boolean pbIsActiveProp)
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IAnimationTrack
Indicates if an animation property is active.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setIsActiveProperty in interface IAnimationTrack
Parameters:
propIndex - The propIndex (in)
pbIsActiveProp - The pbIsActiveProp (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IAnimationTrack
The name of the track.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getName in interface IAnimationTrack
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException
Description copied from interface: IAnimationTrack
The name of the track.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setName in interface IAnimationTrack
Parameters:
name - The name (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getAnimationType

public IAnimationType getAnimationType()
                                throws java.io.IOException,
                                       AutomationException
Description copied from interface: IAnimationTrack
The animation type.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAnimationType in interface IAnimationTrack
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.

setAnimationTypeByRef

public void setAnimationTypeByRef(IAnimationType ppAnimationType)
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: IAnimationTrack
The animation type.

Specified by:
setAnimationTypeByRef in interface IAnimationTrack
Parameters:
ppAnimationType - 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.

getKeyframeCount

public int getKeyframeCount()
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: IAnimationTrack
The number of keyframes defined in the track.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getKeyframeCount in interface IAnimationTrack
Returns:
The pKeyframeCount
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getKeyframe

public IKeyframe getKeyframe(int index)
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IAnimationTrack
The keyframe with the given index in the track.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getKeyframe in interface IAnimationTrack
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.analyst3d.IKeyframe
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCycle

public boolean isCycle()
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IAnimationTrack
Indicates if the track is repeated periodically.

Specified by:
isCycle in interface IAnimationTrack
Returns:
The pbIsCycle
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsCycle

public void setIsCycle(boolean pbIsCycle)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IAnimationTrack
Indicates if the track is repeated periodically.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setIsCycle in interface IAnimationTrack
Parameters:
pbIsCycle - The pbIsCycle (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBeginTime

public double getBeginTime()
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: IAnimationTrack
The initial time of the track.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBeginTime in interface IAnimationTrack
Returns:
The pBeginTime
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setBeginTime

public void setBeginTime(double pBeginTime)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IAnimationTrack
The initial time of the track.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBeginTime in interface IAnimationTrack
Parameters:
pBeginTime - The pBeginTime (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getEndTime

public double getEndTime()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IAnimationTrack
The final time of the track.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getEndTime in interface IAnimationTrack
Returns:
The pEndTime
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEndTime

public void setEndTime(double pEndTime)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IAnimationTrack
The final time of the track.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setEndTime in interface IAnimationTrack
Parameters:
pEndTime - The pEndTime (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isEnabled

public boolean isEnabled()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IAnimationTrack
Indicates if the track is enabled.

Specified by:
isEnabled in interface IAnimationTrack
Returns:
The pbIsEnabled
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setIsEnabled

public void setIsEnabled(boolean pbIsEnabled)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IAnimationTrack
Indicates if the track is enabled.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setIsEnabled in interface IAnimationTrack
Parameters:
pbIsEnabled - The pbIsEnabled (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEvenTimeStamps

public void setEvenTimeStamps(boolean pbEvenTimeStamps)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IAnimationTrack
Indicates whether to distribute time stamps evenly in the interval 0-1.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setEvenTimeStamps in interface IAnimationTrack
Parameters:
pbEvenTimeStamps - The pbEvenTimeStamps (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isEvenTimeStamps

public boolean isEvenTimeStamps()
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IAnimationTrack
Indicates whether to distribute time stamps evenly in the interval 0-1.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEvenTimeStamps in interface IAnimationTrack
Returns:
The pbEvenTimeStamps
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setApplyToAllViewers

public void setApplyToAllViewers(boolean pbApplyToAllViewers)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IAnimationTrack
Indicates whether to apply a camera track to all scene viewers.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setApplyToAllViewers in interface IAnimationTrack
Parameters:
pbApplyToAllViewers - The pbApplyToAllViewers (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isApplyToAllViewers

public boolean isApplyToAllViewers()
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: IAnimationTrack
Indicates whether to apply a camera track to all scene viewers.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isApplyToAllViewers in interface IAnimationTrack
Returns:
The pbApplyToAllViewers
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAttachedObjectsCount

public int getAttachedObjectsCount()
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: IAnimationTrack
The number of objects to which the track is attached.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAttachedObjectsCount in interface IAnimationTrack
Returns:
The pObjectCount
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAttachedObjects

public IArray getAttachedObjects()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IAnimationTrack
The objects to which the track is attached, or null.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAttachedObjects in interface IAnimationTrack
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.

isAttached

public boolean isAttached(java.lang.Object pObject)
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: IAnimationTrack
Indicates if the given objects is attached to the track.

Specified by:
isAttached in interface IAnimationTrack
Parameters:
pObject - A reference to another Object (IUnknown) (in)
Returns:
The pbIsAttached
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAttachedObjects

public void setAttachedObjects(IArray ppObjectArray)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IAnimationTrack
The objects to which the track is attached, or null.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAttachedObjects in interface IAnimationTrack
Parameters:
ppObjectArray - 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.

attachObject

public void attachObject(java.lang.Object pObject)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IAnimationTrack
Attach object to the track.

Supported Platforms

Windows, Solaris, Linux

Specified by:
attachObject in interface IAnimationTrack
Parameters:
pObject - A reference to another Object (IUnknown) (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

detachObject

public void detachObject(java.lang.Object pObject)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IAnimationTrack
Detach object from the track.

Supported Platforms

Windows, Solaris, Linux

Specified by:
detachObject in interface IAnimationTrack
Parameters:
pObject - A reference to another Object (IUnknown) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

detachAllObjects

public void detachAllObjects()
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IAnimationTrack
Detach all objects from the track.

Supported Platforms

Windows, Solaris, Linux

Specified by:
detachAllObjects in interface IAnimationTrack
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

resetAttachedObjects

public void resetAttachedObjects(IScene pScene)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IAnimationTrack
Reset the state of the attached objects to be ready for animation.

Supported Platforms

Windows, Solaris, Linux

Specified by:
resetAttachedObjects in interface IAnimationTrack
Parameters:
pScene - A reference to a com.esri.arcgis.analyst3d.IScene (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insertKeyframe

public void insertKeyframe(IKeyframe pKeyframe,
                           int index)
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: IAnimationTrack
Inserts a new keyframe. If the index is -1, it is added last.

Supported Platforms

Windows, Solaris, Linux

Specified by:
insertKeyframe in interface IAnimationTrack
Parameters:
pKeyframe - A reference to a com.esri.arcgis.analyst3d.IKeyframe (in)
index - The index (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

removeKeyframe

public void removeKeyframe(int index)
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: IAnimationTrack
Removes the keyframe with the given index.

Supported Platforms

Windows, Solaris, Linux

Specified by:
removeKeyframe in interface IAnimationTrack
Parameters:
index - The index (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

removeAllKeyframes

public void removeAllKeyframes()
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IAnimationTrack
Removes all the keyframes.

Supported Platforms

Windows, Solaris, Linux

Specified by:
removeAllKeyframes in interface IAnimationTrack
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

findKeyframe

public void findKeyframe(java.lang.String name,
                         IKeyframe[] ppKeyframe)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IAnimationTrack
Finds a keyframe by name.

Supported Platforms

Windows, Solaris, Linux

Specified by:
findKeyframe in interface IAnimationTrack
Parameters:
name - The name (in)
ppKeyframe - A reference to a com.esri.arcgis.analyst3d.IKeyframe (out: use single element array)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

moveKeyframe

public void moveKeyframe(int originIndex,
                         int destinationIndex)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IAnimationTrack
Moves the keyframe with the given index, inserting it with a different index.

Supported Platforms

Windows, Solaris, Linux

Specified by:
moveKeyframe in interface IAnimationTrack
Parameters:
originIndex - The originIndex (in)
destinationIndex - The destinationIndex (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

sortKeyframes

public void sortKeyframes()
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: IAnimationTrack
Sorts the keyframes in ascending time order.

Supported Platforms

Windows, Solaris, Linux

Specified by:
sortKeyframes in interface IAnimationTrack
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

resetTimeStamps

public void resetTimeStamps()
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: IAnimationTrack
Redistributes the time stamps in the interval [0,1].

Supported Platforms

Windows, Solaris, Linux

Specified by:
resetTimeStamps in interface IAnimationTrack
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

saveObjectProperties

public void saveObjectProperties(IScene pScene,
                                 int index)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IAnimationTrack
Internally saves the properties of the attached object specified.

Supported Platforms

Windows, Solaris, Linux

Specified by:
saveObjectProperties in interface IAnimationTrack
Parameters:
pScene - A reference to a com.esri.arcgis.analyst3d.IScene (in)
index - The index (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

restoreObjectProperties

public void restoreObjectProperties(IScene pScene,
                                    int index)
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: IAnimationTrack
Restores the saved properties of the attached object specified.

Supported Platforms

Windows, Solaris, Linux

Specified by:
restoreObjectProperties in interface IAnimationTrack
Parameters:
pScene - A reference to a com.esri.arcgis.analyst3d.IScene (in)
index - The index (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interpolateObjectProperties

public void interpolateObjectProperties(IScene pScene,
                                        double time)
                                 throws java.io.IOException,
                                        AutomationException
Description copied from interface: IAnimationTrack
Interpolates the state of the attached object for a time between BeginTime and Endtime.

Supported Platforms

Windows, Solaris, Linux

Specified by:
interpolateObjectProperties in interface IAnimationTrack
Parameters:
pScene - A reference to a com.esri.arcgis.analyst3d.IScene (in)
time - The time (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

IAGAnimationTrack_getAnimationType

public IAGAnimationType IAGAnimationTrack_getAnimationType()
                                                    throws java.io.IOException,
                                                           AutomationException
Description copied from interface: IAGAnimationTrack
The animation type.

Specified by:
IAGAnimationTrack_getAnimationType in interface IAGAnimationTrack
Returns:
A reference to a com.esri.arcgis.animation.IAGAnimationType
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setAnimationTypeByRef

public void setAnimationTypeByRef(IAGAnimationType ppAnimationType)
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: IAGAnimationTrack
The animation type.

Specified by:
setAnimationTypeByRef in interface IAGAnimationTrack
Parameters:
ppAnimationType - 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.

resetAttachedObjects

public void resetAttachedObjects(IAGAnimationContainer pContainer)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IAGAnimationTrack
Reset the state of the attached objects to be ready for animation.

Specified by:
resetAttachedObjects in interface IAGAnimationTrack
Parameters:
pContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interpolateObjectProperties

public void interpolateObjectProperties(IAGAnimationContainer pContainer,
                                        double time)
                                 throws java.io.IOException,
                                        AutomationException
Description copied from interface: IAGAnimationTrack
Interpolates the state of the attached object for a time between BeginTime and Endtime.

Specified by:
interpolateObjectProperties in interface IAGAnimationTrack
Parameters:
pContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (in)
time - The time (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnimationObjectContainer

public IAGAnimationContainer getAnimationObjectContainer()
                                                  throws java.io.IOException,
                                                         AutomationException
Description copied from interface: IAGAnimationTrack
The container of the animation objects attached to the tracks.

Specified by:
getAnimationObjectContainer in interface IAGAnimationTrack
Returns:
A reference to a com.esri.arcgis.animation.IAGAnimationContainer
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setAnimationObjectContainerByRef

public void setAnimationObjectContainerByRef(IAGAnimationContainer ppContainer)
                                      throws java.io.IOException,
                                             AutomationException
Description copied from interface: IAGAnimationTrack
The container of the animation objects attached to the tracks.

Specified by:
setAnimationObjectContainerByRef in interface IAGAnimationTrack
Parameters:
ppContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

IAGAnimationTrackKeyframes_getKeyframe

public IAGKeyframe IAGAnimationTrackKeyframes_getKeyframe(int index)
                                                   throws java.io.IOException,
                                                          AutomationException
Description copied from interface: IAGAnimationTrackKeyframes
The keyframe with the given index in the track.

Specified by:
IAGAnimationTrackKeyframes_getKeyframe in interface IAGAnimationTrackKeyframes
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.animation.IAGKeyframe
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createKeyframe

public IAGKeyframe createKeyframe(int index)
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: IAGAnimationTrackKeyframes
Creates a new keyframe of the appropriate type and inserts it. If the index is -1, it is added last.

Specified by:
createKeyframe in interface IAGAnimationTrackKeyframes
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.animation.IAGKeyframe
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

insertKeyframe

public void insertKeyframe(IAGKeyframe pKeyframe,
                           int index)
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: IAGAnimationTrackKeyframes
Inserts a new keyframe. If the index is -1, it is added last.

Specified by:
insertKeyframe in interface IAGAnimationTrackKeyframes
Parameters:
pKeyframe - A reference to a com.esri.arcgis.animation.IAGKeyframe (in)
index - The index (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findKeyframe

public void findKeyframe(java.lang.String name,
                         IAGKeyframe[] ppKeyframe)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IAGAnimationTrackKeyframes
Finds a keyframe by name.

Specified by:
findKeyframe in interface IAGAnimationTrackKeyframes
Parameters:
name - The name (in)
ppKeyframe - A reference to a com.esri.arcgis.animation.IAGKeyframe (out: use single element array)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

saveObjectProperties

public void saveObjectProperties(IAGAnimationContainer pContainer,
                                 int index)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IAGAnimationTrackKeyframes
Internally saves the properties of the attached object specified.

Specified by:
saveObjectProperties in interface IAGAnimationTrackKeyframes
Parameters:
pContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (in)
index - The index (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

restoreObjectProperties

public void restoreObjectProperties(IAGAnimationContainer pContainer,
                                    int index)
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: IAGAnimationTrackKeyframes
Restores the saved properties of the attached object specified.

Specified by:
restoreObjectProperties in interface IAGAnimationTrackKeyframes
Parameters:
pContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (in)
index - The index (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getLastInterpolatedKeyframe

public IAGKeyframe getLastInterpolatedKeyframe()
                                        throws java.io.IOException,
                                               AutomationException
Description copied from interface: IAGAnimationTrackKeyframes
The last keyframe that was interpolated in the track.

Specified by:
getLastInterpolatedKeyframe in interface IAGAnimationTrackKeyframes
Returns:
A reference to a com.esri.arcgis.animation.IAGKeyframe
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException
Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:
isDirty in interface IPersistStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException
Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.