com.esri.arcgis.animation
Interface IAGAnimationTrack

All Superinterfaces:

Serializable

All Known Implementing Classes:

AGAnimationTrack, AnimationTrack

public interface IAGAnimationTrack
extends Serializable

Provides access to animation tracks.

Remarks

Animation tracks are conceptually containers of animation keyframes. This interface contains properties of the animation track and methods for managing animation objects attached to the track.

Product Availability

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

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.
IAGAnimationContainer	getAnimationObjectContainer() The container of the animation objects attached to the tracks.
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.
String	getName() The name of the track.
IAGAnimationType	IAGAnimationTrack_getAnimationType() The animation type.
void	interpolateObjectProperties(IAGAnimationContainer pContainer, double time) Interpolates the state of the attached object for a time between BeginTime and Endtime.
boolean	isApplyToAllViewers() Indicates whether to apply a camera track to all viewers.
boolean	isAttached(Object pObject) Indicates if the given object is attached to the track.
boolean	isCycle() Indicates if the track is repeated periodically.
boolean	isEnabled() Indicates if the track is enabled.
void	resetAttachedObjects(IAGAnimationContainer pContainer) Reset the state of the attached objects to be ready for animation.
void	setAnimationObjectContainerByRef(IAGAnimationContainer ppContainer) The container of the animation objects attached to the tracks.
void	setAnimationTypeByRef(IAGAnimationType ppAnimationType) The animation type.
void	setApplyToAllViewers(boolean pbApplyToAllViewers) Indicates whether to apply a camera track to all 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	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.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

The name of the track.

Product Availability

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

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.

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

IAGAnimationTrack_getAnimationType

IAGAnimationType IAGAnimationTrack_getAnimationType()
                                                    throws IOException,
                                                           AutomationException

The animation type.

Product Availability

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

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

void setAnimationTypeByRef(IAGAnimationType ppAnimationType)
                           throws IOException,
                                  AutomationException

The animation type.

Product Availability

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

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.

isCycle

boolean isCycle()
                throws IOException,
                       AutomationException

Indicates if the track is repeated periodically.

Product Availability

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

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.

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.

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.

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.

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.

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.

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.

Parameters:

pbIsEnabled - The pbIsEnabled (in)

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

Product Availability

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

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

Product Availability

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

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.

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.

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 object is attached to the track.

Product Availability

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

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.

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.

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.

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.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resetAttachedObjects

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.

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

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.

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

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.

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

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.

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.