com.esri.arcgis.analyst3d
Class AnimationTrack

java.lang.Object
  com.esri.arcgis.analyst3d.AnimationTrack

All Implemented Interfaces:

IAnimationTrack, IAGAnimationTrack, IAGAnimationTrackKeyframes, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable

public class AnimationTrack
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAnimationTrack, IAGAnimationTrack, IAGAnimationTrackKeyframes, IPersistStream, Externalizable

The Animation Track coclass.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

AnimationTrack()
Constructs a AnimationTrack using ArcGIS Engine.

AnimationTrack(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AnimationTrack theAnimationTrack = (AnimationTrack) obj;

Method Summary

void	attachObject(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(Object pObject) Detach object from the track.
boolean	equals(Object o) Compare this object with another
void	findKeyframe(String name, IAGKeyframe[] ppKeyframe) Finds a keyframe by name.
void	findKeyframe(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.
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) getClassID
static String	getClsid() 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.
String	getName() The name of the track.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
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(Object pObject) Indicates if the given objects is attached to the track.
boolean	isCycle() Indicates if the track is repeated periodically.
void	isDirty() isDirty
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) load
void	moveKeyframe(int originIndex, int destinationIndex) Moves the keyframe with the given index, inserting it with a different index.
void	readExternal(ObjectInput in)
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) save
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(String name) The name of the track.
void	sortKeyframes() Sorts the keyframes in ascending time order.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

AnimationTrack

public AnimationTrack()
               throws IOException,
                      UnknownHostException

Constructs a AnimationTrack using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

AnimationTrack

public AnimationTrack(Object obj)
               throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AnimationTrack theAnimationTrack = (AnimationTrack) obj;

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.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getActiveProperties

public ILongArray getActiveProperties()
                               throws IOException,
                                      AutomationException

The combination of active properties for the track.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getActiveProperties in interface IAnimationTrack

Specified by:

getActiveProperties in interface IAGAnimationTrackKeyframes

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.

setActiveProperties

public void setActiveProperties(ILongArray ppActiveProps)
                         throws IOException,
                                AutomationException

The combination of active properties for the track.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setActiveProperties in interface IAnimationTrack

Specified by:

setActiveProperties in interface IAGAnimationTrackKeyframes

Parameters:

ppActiveProps - 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.

isActiveProperty

public boolean isActiveProperty(int propIndex)
                         throws IOException,
                                AutomationException

Indicates if an animation property is active.

Product Availability

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

Specified by:

isActiveProperty in interface IAnimationTrack

Specified by:

isActiveProperty in interface IAGAnimationTrackKeyframes

Parameters:

propIndex - The propIndex (in)

Returns:

The pbIsActiveProp

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsActiveProperty

public void setIsActiveProperty(int propIndex,
                                boolean pbIsActiveProp)
                         throws IOException,
                                AutomationException

Indicates if an animation property is active.

Product Availability

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

Specified by:

setIsActiveProperty in interface IAnimationTrack

Specified by:

setIsActiveProperty in interface IAGAnimationTrackKeyframes

Parameters:

propIndex - The propIndex (in)

pbIsActiveProp - The pbIsActiveProp (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the track.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IAnimationTrack

Specified by:

getName in interface IAGAnimationTrack

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

The name of the track.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IAnimationTrack

Specified by:

setName in interface IAGAnimationTrack

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAnimationType

public IAnimationType getAnimationType()
                                throws IOException,
                                       AutomationException

The animation type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAnimationType in interface IAnimationTrack

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.

setAnimationTypeByRef

public void setAnimationTypeByRef(IAnimationType ppAnimationType)
                           throws IOException,
                                  AutomationException

The animation type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAnimationTypeByRef in interface IAnimationTrack

Parameters:

ppAnimationType - 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.

getKeyframeCount

public int getKeyframeCount()
                     throws IOException,
                            AutomationException

The number of keyframes defined in the track.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getKeyframeCount in interface IAnimationTrack

Specified by:

getKeyframeCount in interface IAGAnimationTrackKeyframes

Returns:

The pKeyframeCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKeyframe

public IKeyframe getKeyframe(int index)
                      throws IOException,
                             AutomationException

The keyframe with the given index in the track.

Product Availability

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

Specified by:

getKeyframe in interface IAnimationTrack

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCycle

public boolean isCycle()
                throws IOException,
                       AutomationException

Indicates if the track is repeated periodically.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCycle in interface IAnimationTrack

Specified by:

isCycle in interface IAGAnimationTrack

Returns:

The pbIsCycle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsCycle

public void setIsCycle(boolean pbIsCycle)
                throws IOException,
                       AutomationException

Indicates if the track is repeated periodically.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setIsCycle in interface IAnimationTrack

Specified by:

setIsCycle in interface IAGAnimationTrack

Parameters:

pbIsCycle - The pbIsCycle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBeginTime

public double getBeginTime()
                    throws IOException,
                           AutomationException

The initial time of the track.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBeginTime in interface IAnimationTrack

Specified by:

getBeginTime in interface IAGAnimationTrack

Returns:

The pBeginTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBeginTime

public void setBeginTime(double pBeginTime)
                  throws IOException,
                         AutomationException

The initial time of the track.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBeginTime in interface IAnimationTrack

Specified by:

setBeginTime in interface IAGAnimationTrack

Parameters:

pBeginTime - The pBeginTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndTime

public double getEndTime()
                  throws IOException,
                         AutomationException

The final time of the track.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getEndTime in interface IAnimationTrack

Specified by:

getEndTime in interface IAGAnimationTrack

Returns:

The pEndTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndTime

public void setEndTime(double pEndTime)
                throws IOException,
                       AutomationException

The final time of the track.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setEndTime in interface IAnimationTrack

Specified by:

setEndTime in interface IAGAnimationTrack

Parameters:

pEndTime - The pEndTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnabled

public boolean isEnabled()
                  throws IOException,
                         AutomationException

Indicates if the track is enabled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEnabled in interface IAnimationTrack

Specified by:

isEnabled in interface IAGAnimationTrack

Returns:

The pbIsEnabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsEnabled

public void setIsEnabled(boolean pbIsEnabled)
                  throws IOException,
                         AutomationException

Indicates if the track is enabled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setIsEnabled in interface IAnimationTrack

Specified by:

setIsEnabled in interface IAGAnimationTrack

Parameters:

pbIsEnabled - The pbIsEnabled (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEvenTimeStamps

public void setEvenTimeStamps(boolean pbEvenTimeStamps)
                       throws IOException,
                              AutomationException

Indicates whether to distribute time stamps evenly in the interval 0-1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setEvenTimeStamps in interface IAnimationTrack

Specified by:

setEvenTimeStamps in interface IAGAnimationTrackKeyframes

Parameters:

pbEvenTimeStamps - The pbEvenTimeStamps (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEvenTimeStamps

public boolean isEvenTimeStamps()
                         throws IOException,
                                AutomationException

Indicates whether to distribute time stamps evenly in the interval 0-1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEvenTimeStamps in interface IAnimationTrack

Specified by:

isEvenTimeStamps in interface IAGAnimationTrackKeyframes

Returns:

The pbEvenTimeStamps

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setApplyToAllViewers

public void setApplyToAllViewers(boolean pbApplyToAllViewers)
                          throws IOException,
                                 AutomationException

Indicates whether to apply a camera track to all scene viewers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setApplyToAllViewers in interface IAnimationTrack

Specified by:

setApplyToAllViewers in interface IAGAnimationTrack

Parameters:

pbApplyToAllViewers - The pbApplyToAllViewers (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isApplyToAllViewers

public boolean isApplyToAllViewers()
                            throws IOException,
                                   AutomationException

Indicates whether to apply a camera track to all scene viewers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isApplyToAllViewers in interface IAnimationTrack

Specified by:

isApplyToAllViewers in interface IAGAnimationTrack

Returns:

The pbApplyToAllViewers

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAttachedObjectsCount

public int getAttachedObjectsCount()
                            throws IOException,
                                   AutomationException

The number of objects to which the track is attached.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAttachedObjectsCount in interface IAnimationTrack

Specified by:

getAttachedObjectsCount in interface IAGAnimationTrack

Returns:

The pObjectCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAttachedObjects

public IArray getAttachedObjects()
                          throws IOException,
                                 AutomationException

The objects to which the track is attached, or null.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAttachedObjects in interface IAnimationTrack

Specified by:

getAttachedObjects in interface IAGAnimationTrack

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.

isAttached

public boolean isAttached(Object pObject)
                   throws IOException,
                          AutomationException

Indicates if the given objects is attached to the track.

Product Availability

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

Specified by:

isAttached in interface IAnimationTrack

Specified by:

isAttached in interface IAGAnimationTrack

Parameters:

pObject - A reference to another Object (IUnknown) (in)

Returns:

The pbIsAttached

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAttachedObjects

public void setAttachedObjects(IArray ppObjectArray)
                        throws IOException,
                               AutomationException

The objects to which the track is attached, or null.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAttachedObjects in interface IAnimationTrack

Specified by:

setAttachedObjects in interface IAGAnimationTrack

Parameters:

ppObjectArray - 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.

attachObject

public void attachObject(Object pObject)
                  throws IOException,
                         AutomationException

Attach object to the track.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

attachObject in interface IAnimationTrack

Specified by:

attachObject in interface IAGAnimationTrack

Parameters:

pObject - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

detachObject

public void detachObject(Object pObject)
                  throws IOException,
                         AutomationException

Detach object from the track.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

detachObject in interface IAnimationTrack

Specified by:

detachObject in interface IAGAnimationTrack

Parameters:

pObject - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

detachAllObjects

public void detachAllObjects()
                      throws IOException,
                             AutomationException

Detach all objects from the track.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

detachAllObjects in interface IAnimationTrack

Specified by:

detachAllObjects in interface IAGAnimationTrack

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resetAttachedObjects

public void resetAttachedObjects(IScene pScene)
                          throws IOException,
                                 AutomationException

Reset the state of the attached objects to be ready for animation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

resetAttachedObjects in interface IAnimationTrack

Parameters:

pScene - A reference to a com.esri.arcgis.analyst3d.IScene (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insertKeyframe

public void insertKeyframe(IKeyframe pKeyframe,
                           int index)
                    throws IOException,
                           AutomationException

Inserts a new keyframe. If the index is -1, it is added last.

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeKeyframe

public void removeKeyframe(int index)
                    throws IOException,
                           AutomationException

Removes the keyframe with the given index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

removeKeyframe in interface IAnimationTrack

Specified by:

removeKeyframe in interface IAGAnimationTrackKeyframes

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAllKeyframes

public void removeAllKeyframes()
                        throws IOException,
                               AutomationException

Removes all the keyframes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

removeAllKeyframes in interface IAnimationTrack

Specified by:

removeAllKeyframes in interface IAGAnimationTrackKeyframes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findKeyframe

public void findKeyframe(String name,
                         IKeyframe[] ppKeyframe)
                  throws IOException,
                         AutomationException

Finds a keyframe by name.

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

moveKeyframe

public void moveKeyframe(int originIndex,
                         int destinationIndex)
                  throws IOException,
                         AutomationException

Moves the keyframe with the given index, inserting it with a different index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

moveKeyframe in interface IAnimationTrack

Specified by:

moveKeyframe in interface IAGAnimationTrackKeyframes

Parameters:

originIndex - The originIndex (in)

destinationIndex - The destinationIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

sortKeyframes

public void sortKeyframes()
                   throws IOException,
                          AutomationException

Sorts the keyframes in ascending time order.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

sortKeyframes in interface IAnimationTrack

Specified by:

sortKeyframes in interface IAGAnimationTrackKeyframes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resetTimeStamps

public void resetTimeStamps()
                     throws IOException,
                            AutomationException

Redistributes the time stamps in the interval [0,1].

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

resetTimeStamps in interface IAnimationTrack

Specified by:

resetTimeStamps in interface IAGAnimationTrackKeyframes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveObjectProperties

public void saveObjectProperties(IScene pScene,
                                 int index)
                          throws IOException,
                                 AutomationException

Internally saves the properties of the attached object specified.

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

restoreObjectProperties

public void restoreObjectProperties(IScene pScene,
                                    int index)
                             throws IOException,
                                    AutomationException

Restores the saved properties of the attached object specified.

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interpolateObjectProperties

public void interpolateObjectProperties(IScene pScene,
                                        double time)
                                 throws IOException,
                                        AutomationException

Interpolates the state of the attached object for a time between BeginTime and Endtime.

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

IAGAnimationTrack_getAnimationType

public IAGAnimationType IAGAnimationTrack_getAnimationType()
                                                    throws IOException,
                                                           AutomationException

The animation type.

Product Availability

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

Specified by:

IAGAnimationTrack_getAnimationType in interface IAGAnimationTrack

Returns:

A reference to a com.esri.arcgis.animation.IAGAnimationType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAnimationTypeByRef

public void setAnimationTypeByRef(IAGAnimationType ppAnimationType)
                           throws IOException,
                                  AutomationException

The animation type.

Product Availability

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

Specified by:

setAnimationTypeByRef in interface IAGAnimationTrack

Parameters:

ppAnimationType - A reference to a com.esri.arcgis.animation.IAGAnimationType (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resetAttachedObjects

public void resetAttachedObjects(IAGAnimationContainer pContainer)
                          throws IOException,
                                 AutomationException

Reset the state of the attached objects to be ready for animation.

Product Availability

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

Specified by:

resetAttachedObjects in interface IAGAnimationTrack

Parameters:

pContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interpolateObjectProperties

public void interpolateObjectProperties(IAGAnimationContainer pContainer,
                                        double time)
                                 throws IOException,
                                        AutomationException

Interpolates the state of the attached object for a time between BeginTime and Endtime.

Product Availability

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

Specified by:

interpolateObjectProperties in interface IAGAnimationTrack

Parameters:

pContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (in)

time - The time (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAnimationObjectContainer

public IAGAnimationContainer getAnimationObjectContainer()
                                                  throws IOException,
                                                         AutomationException

The container of the animation objects attached to the tracks.

Product Availability

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

Specified by:

getAnimationObjectContainer in interface IAGAnimationTrack

Returns:

A reference to a com.esri.arcgis.animation.IAGAnimationContainer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAnimationObjectContainerByRef

public void setAnimationObjectContainerByRef(IAGAnimationContainer ppContainer)
                                      throws IOException,
                                             AutomationException

The container of the animation objects attached to the tracks.

Product Availability

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

Specified by:

setAnimationObjectContainerByRef in interface IAGAnimationTrack

Parameters:

ppContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

IAGAnimationTrackKeyframes_getKeyframe

public IAGKeyframe IAGAnimationTrackKeyframes_getKeyframe(int index)
                                                   throws IOException,
                                                          AutomationException

The keyframe with the given index in the track.

Product Availability

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

Specified by:

IAGAnimationTrackKeyframes_getKeyframe in interface IAGAnimationTrackKeyframes

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.animation.IAGKeyframe

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createKeyframe

public IAGKeyframe createKeyframe(int index)
                           throws IOException,
                                  AutomationException

Creates a new keyframe of the appropriate type and inserts it. If the index is -1, it is added last.

Product Availability

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

Specified by:

createKeyframe in interface IAGAnimationTrackKeyframes

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.animation.IAGKeyframe

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insertKeyframe

public void insertKeyframe(IAGKeyframe pKeyframe,
                           int index)
                    throws IOException,
                           AutomationException

Inserts a new keyframe. If the index is -1, it is added last.

Product Availability

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

Specified by:

insertKeyframe in interface IAGAnimationTrackKeyframes

Parameters:

pKeyframe - A reference to a com.esri.arcgis.animation.IAGKeyframe (in)

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findKeyframe

public void findKeyframe(String name,
                         IAGKeyframe[] ppKeyframe)
                  throws IOException,
                         AutomationException

Finds a keyframe by name.

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveObjectProperties

public void saveObjectProperties(IAGAnimationContainer pContainer,
                                 int index)
                          throws IOException,
                                 AutomationException

Internally saves the properties of the attached object specified.

Product Availability

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

Specified by:

saveObjectProperties in interface IAGAnimationTrackKeyframes

Parameters:

pContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (in)

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

restoreObjectProperties

public void restoreObjectProperties(IAGAnimationContainer pContainer,
                                    int index)
                             throws IOException,
                                    AutomationException

Restores the saved properties of the attached object specified.

Product Availability

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

Specified by:

restoreObjectProperties in interface IAGAnimationTrackKeyframes

Parameters:

pContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (in)

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastInterpolatedKeyframe

public IAGKeyframe getLastInterpolatedKeyframe()
                                        throws IOException,
                                               AutomationException

The last keyframe that was interpolated in the track.

Product Availability

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

Specified by:

getLastInterpolatedKeyframe in interface IAGAnimationTrackKeyframes

Returns:

A reference to a com.esri.arcgis.animation.IAGKeyframe

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException