com.esri.arcgis.animation
Interface IAGAnimationTrack

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
AGAnimationTrack, AnimationTrack, IAGAnimationTrackProxy

public interface IAGAnimationTrack
extends java.io.Serializable

COM Interface 'IAGAnimationTrack'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esriAnimation.olb'

Description: 'Provides access to animation tracks.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID79dd6360_268d_47ee_a4fc_384f2cbe1aa5
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void attachObject(java.lang.Object pObject)
          Attach object to the track.
 void detachAllObjects()
          Detach all objects from the track.
 void detachObject(java.lang.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.
 java.lang.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(java.lang.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(java.lang.String name)
          The name of the track.
 

Field Detail

IID79dd6360_268d_47ee_a4fc_384f2cbe1aa5

static final int IID79dd6360_268d_47ee_a4fc_384f2cbe1aa5
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
The name of the track.

Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException
The name of the track.

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

IAGAnimationTrack_getAnimationType

IAGAnimationType IAGAnimationTrack_getAnimationType()
                                                    throws java.io.IOException,
                                                           AutomationException
The animation type.

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

setAnimationTypeByRef

void setAnimationTypeByRef(IAGAnimationType ppAnimationType)
                           throws java.io.IOException,
                                  AutomationException
The animation type.

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.

isCycle

boolean isCycle()
                throws java.io.IOException,
                       AutomationException
Indicates if the track is repeated periodically.

Returns:
The pbIsCycle
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsCycle

void setIsCycle(boolean pbIsCycle)
                throws java.io.IOException,
                       AutomationException
Indicates if the track is repeated periodically.

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

getBeginTime

double getBeginTime()
                    throws java.io.IOException,
                           AutomationException
The initial time of the track.

Returns:
The pBeginTime
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBeginTime

void setBeginTime(double pBeginTime)
                  throws java.io.IOException,
                         AutomationException
The initial time of the track.

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

getEndTime

double getEndTime()
                  throws java.io.IOException,
                         AutomationException
The final time of the track.

Returns:
The pEndTime
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEndTime

void setEndTime(double pEndTime)
                throws java.io.IOException,
                       AutomationException
The final time of the track.

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

isEnabled

boolean isEnabled()
                  throws java.io.IOException,
                         AutomationException
Indicates if the track is enabled.

Returns:
The pbIsEnabled
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsEnabled

void setIsEnabled(boolean pbIsEnabled)
                  throws java.io.IOException,
                         AutomationException
Indicates if the track is enabled.

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

setApplyToAllViewers

void setApplyToAllViewers(boolean pbApplyToAllViewers)
                          throws java.io.IOException,
                                 AutomationException
Indicates whether to apply a camera track to all viewers.

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

isApplyToAllViewers

boolean isApplyToAllViewers()
                            throws java.io.IOException,
                                   AutomationException
Indicates whether to apply a camera track to all viewers.

Returns:
The pbApplyToAllViewers
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAttachedObjectsCount

int getAttachedObjectsCount()
                            throws java.io.IOException,
                                   AutomationException
The number of objects to which the track is attached.

Returns:
The pObjectCount
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAttachedObjects

IArray getAttachedObjects()
                          throws java.io.IOException,
                                 AutomationException
The objects to which the track is attached, or null.

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

boolean isAttached(java.lang.Object pObject)
                   throws java.io.IOException,
                          AutomationException
Indicates if the given object is attached to the track.

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

void setAttachedObjects(IArray ppObjectArray)
                        throws java.io.IOException,
                               AutomationException
The objects to which the track is attached, or null.

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

void attachObject(java.lang.Object pObject)
                  throws java.io.IOException,
                         AutomationException
Attach object to the track.

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.

detachObject

void detachObject(java.lang.Object pObject)
                  throws java.io.IOException,
                         AutomationException
Detach object from the track.

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

void detachAllObjects()
                      throws java.io.IOException,
                             AutomationException
Detach all objects from the track.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

resetAttachedObjects

void resetAttachedObjects(IAGAnimationContainer pContainer)
                          throws java.io.IOException,
                                 AutomationException
Reset the state of the attached objects to be ready for animation.

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

void interpolateObjectProperties(IAGAnimationContainer pContainer,
                                 double time)
                                 throws java.io.IOException,
                                        AutomationException
Interpolates the state of the attached object for a time between BeginTime and Endtime.

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

IAGAnimationContainer getAnimationObjectContainer()
                                                  throws java.io.IOException,
                                                         AutomationException
The container of the animation objects attached to the tracks.

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

setAnimationObjectContainerByRef

void setAnimationObjectContainerByRef(IAGAnimationContainer ppContainer)
                                      throws java.io.IOException,
                                             AutomationException
The container of the animation objects attached to the tracks.

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.