com.esri.arcgis.analyst3d
Interface IAnimationTrack

All Superinterfaces:

Serializable

All Known Implementing Classes:

AnimationTrack

public interface IAnimationTrack
extends Serializable

Provides access to animation tracks.

Remarks

Animation tracks are conceptually containers of animation keyframes. IAnimationTrack encapsulates properties and methods related to managing its keyframes and associating the animation track to proper objects.

Product Availability

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

Method Summary

void	attachObject(Object pObject) Attach object to the track.
void	detachAllObjects() Detach all objects from the track.
void	detachObject(Object pObject) Detach object from the track.
void	findKeyframe(String name, IKeyframe[] ppKeyframe) Finds a keyframe by name.
ILongArray	getActiveProperties() The combination of active properties for the track.
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.
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.
String	getName() The name of the track.
void	insertKeyframe(IKeyframe pKeyframe, int index) Inserts a new keyframe.
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.
boolean	isEnabled() Indicates if the track is enabled.
boolean	isEvenTimeStamps() Indicates whether to distribute time stamps evenly in the interval 0-1.
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(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(IScene pScene, int index) Restores the saved 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	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.

Method Detail

getActiveProperties

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

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

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

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

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.

Parameters:

propIndex - The propIndex (in)

Returns:

The pbIsActiveProp

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsActiveProperty

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.

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

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAnimationType

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

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

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

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

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

Returns:

The pKeyframeCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKeyframe

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.

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

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

Returns:

The pbIsCycle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsCycle

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

Parameters:

pbIsCycle - The pbIsCycle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBeginTime

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

Returns:

The pBeginTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBeginTime

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

Parameters:

pBeginTime - The pBeginTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndTime

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

Returns:

The pEndTime

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndTime

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

Parameters:

pEndTime - The pEndTime (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnabled

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

Returns:

The pbIsEnabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsEnabled

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

Parameters:

pbIsEnabled - The pbIsEnabled (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEvenTimeStamps

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

Parameters:

pbEvenTimeStamps - The pbEvenTimeStamps (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEvenTimeStamps

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

Returns:

The pbEvenTimeStamps

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setApplyToAllViewers

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

Parameters:

pbApplyToAllViewers - The pbApplyToAllViewers (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isApplyToAllViewers

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

Returns:

The pbApplyToAllViewers

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAttachedObjectsCount

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

Returns:

The pObjectCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAttachedObjects

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

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

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.

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

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

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

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

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

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

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resetAttachedObjects

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

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

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

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

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

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAllKeyframes

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findKeyframe

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

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

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

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resetTimeStamps

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveObjectProperties

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

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

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

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

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

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.