com.esri.arcgis.animation
Interface IAGAnimationTrackKeyframes

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

public interface IAGAnimationTrackKeyframes
extends java.io.Serializable

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

Description: 'Provides access to animation tracks that support keyframes.' 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 IID8d9fe1b4_25fe_4586_b011_c60f36ea0a8b
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 IAGKeyframe createKeyframe(int index)
          Creates a new keyframe of the appropriate type and inserts it.
 void findKeyframe(java.lang.String name, IAGKeyframe[] ppKeyframe)
          Finds a keyframe by name.
 ILongArray getActiveProperties()
          The combination of active properties for the track.
 int getKeyframeCount()
          The number of keyframes defined in the track.
 IAGKeyframe getLastInterpolatedKeyframe()
          The last keyframe that was interpolated in the track.
 IAGKeyframe IAGAnimationTrackKeyframes_getKeyframe(int index)
          The keyframe with the given index in the track.
 void insertKeyframe(IAGKeyframe pKeyframe, int index)
          Inserts a new keyframe.
 boolean isActiveProperty(int propIndex)
          Indicates if an animation property is active.
 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 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 saveObjectProperties(IAGAnimationContainer pContainer, int index)
          Internally saves the properties of the attached object specified.
 void setActiveProperties(ILongArray ppActiveProps)
          The combination of active properties for 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 sortKeyframes()
          Sorts the keyframes in ascending time order.
 

Field Detail

IID8d9fe1b4_25fe_4586_b011_c60f36ea0a8b

static final int IID8d9fe1b4_25fe_4586_b011_c60f36ea0a8b
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

getActiveProperties

ILongArray getActiveProperties()
                               throws java.io.IOException,
                                      AutomationException
The combination of active properties for the track.

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

setActiveProperties

void setActiveProperties(ILongArray ppActiveProps)
                         throws java.io.IOException,
                                AutomationException
The combination of active properties for the track.

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

isActiveProperty

boolean isActiveProperty(int propIndex)
                         throws java.io.IOException,
                                AutomationException
Indicates if an animation property is active.

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

setIsActiveProperty

void setIsActiveProperty(int propIndex,
                         boolean pbIsActiveProp)
                         throws java.io.IOException,
                                AutomationException
Indicates if an animation property is active.

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

getKeyframeCount

int getKeyframeCount()
                     throws java.io.IOException,
                            AutomationException
The number of keyframes defined in the track.

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

IAGAnimationTrackKeyframes_getKeyframe

IAGKeyframe IAGAnimationTrackKeyframes_getKeyframe(int index)
                                                   throws java.io.IOException,
                                                          AutomationException
The keyframe with the given index in the track.

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

createKeyframe

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

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

insertKeyframe

void insertKeyframe(IAGKeyframe pKeyframe,
                    int index)
                    throws java.io.IOException,
                           AutomationException
Inserts a new keyframe. If the index is -1, it is added last.

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

removeKeyframe

void removeKeyframe(int index)
                    throws java.io.IOException,
                           AutomationException
Removes the keyframe with the given index.

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

removeAllKeyframes

void removeAllKeyframes()
                        throws java.io.IOException,
                               AutomationException
Removes all the keyframes.

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

findKeyframe

void findKeyframe(java.lang.String name,
                  IAGKeyframe[] ppKeyframe)
                  throws java.io.IOException,
                         AutomationException
Finds a keyframe by name.

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

moveKeyframe

void moveKeyframe(int originIndex,
                  int destinationIndex)
                  throws java.io.IOException,
                         AutomationException
Moves the keyframe with the given index, inserting it with a different index.

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

sortKeyframes

void sortKeyframes()
                   throws java.io.IOException,
                          AutomationException
Sorts the keyframes in ascending time order.

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

resetTimeStamps

void resetTimeStamps()
                     throws java.io.IOException,
                            AutomationException
Redistributes the time stamps in the interval [0,1].

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

saveObjectProperties

void saveObjectProperties(IAGAnimationContainer pContainer,
                          int index)
                          throws java.io.IOException,
                                 AutomationException
Internally saves the properties of the attached object specified.

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

restoreObjectProperties

void restoreObjectProperties(IAGAnimationContainer pContainer,
                             int index)
                             throws java.io.IOException,
                                    AutomationException
Restores the saved properties of the attached object specified.

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

setEvenTimeStamps

void setEvenTimeStamps(boolean pbEvenTimeStamps)
                       throws java.io.IOException,
                              AutomationException
Indicates whether to distribute time stamps evenly in the interval 0-1.

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

isEvenTimeStamps

boolean isEvenTimeStamps()
                         throws java.io.IOException,
                                AutomationException
Indicates whether to distribute time stamps evenly in the interval 0-1.

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

getLastInterpolatedKeyframe

IAGKeyframe getLastInterpolatedKeyframe()
                                        throws java.io.IOException,
                                               AutomationException
The last keyframe that was interpolated in the track.

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