com.esri.arcgis.animation
Interface IAGAnimationType

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
AnimationTypeCamera, AnimationTypeGlobeCamera, AnimationTypeGlobeLayer, AnimationTypeLayer, AnimationTypeMapLayer, AnimationTypeMapView, AnimationTypeScene, AnimationTypeTime, AnimationTypeTimeLayer, IAGAnimationTypeProxy

public interface IAGAnimationType
extends java.io.Serializable

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

Description: 'Provides access to the animation type objects.' 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 IID17559cca_0532_4c48_9031_b26d0fe80585
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 int getAnimationClass()
          The class of the animation type.
 java.lang.Object getAnimationObjectByID(IAGAnimationContainer pContainer, int objectID)
          The animated object with the given ID.
 int getAnimationObjectID(IAGAnimationContainer pContainer, java.lang.Object pObject)
          The ID (index) of the given object among those of its animation type.
 java.lang.String getAnimationObjectName(IAGAnimationContainer pContainer, java.lang.Object pObject)
          The name of the given object for animation purposes.
 IUID getCLSID()
          The class ID of the animation type.
 IUID getKeyframeCLSID()
          The class ID of the associated keyframe, or 0 if it has none.
 java.lang.String getName()
          The name of the animation type.
 IArray getObjectArray(IAGAnimationContainer pContainer)
          The array of objects of this type.
 int getPropertyCount()
          The number of properties that can be animated.
 java.lang.String getPropertyName(int index)
          The name of the properties that can be animated.
 int getPropertyType(int index)
          The type of the properties that can be animated.
 boolean isAppliesToObject(java.lang.Object pObject)
          Indicates if the animation type applies to a specific object.
 void resetObject(IAGAnimationContainer pContainer, java.lang.Object pObject)
          Resets the state of the object, preparing it for animation.
 void updateTrackExtensions(IAGAnimationTrack pTrack)
          Creates or modifies extensions of the given track when its type is assigned or objects are attached/detached.
 

Field Detail

IID17559cca_0532_4c48_9031_b26d0fe80585

static final int IID17559cca_0532_4c48_9031_b26d0fe80585
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 animation type.

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

getAnimationClass

int getAnimationClass()
                      throws java.io.IOException,
                             AutomationException
The class of the animation type.

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

getCLSID

IUID getCLSID()
              throws java.io.IOException,
                     AutomationException
The class ID of the animation type.

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

getKeyframeCLSID

IUID getKeyframeCLSID()
                      throws java.io.IOException,
                             AutomationException
The class ID of the associated keyframe, or 0 if it has none.

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

isAppliesToObject

boolean isAppliesToObject(java.lang.Object pObject)
                          throws java.io.IOException,
                                 AutomationException
Indicates if the animation type applies to a specific object.

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

getPropertyCount

int getPropertyCount()
                     throws java.io.IOException,
                            AutomationException
The number of properties that can be animated.

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

getPropertyName

java.lang.String getPropertyName(int index)
                                 throws java.io.IOException,
                                        AutomationException
The name of the properties that can be animated.

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

getPropertyType

int getPropertyType(int index)
                    throws java.io.IOException,
                           AutomationException
The type of the properties that can be animated.

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

getObjectArray

IArray getObjectArray(IAGAnimationContainer pContainer)
                      throws java.io.IOException,
                             AutomationException
The array of objects of this type.

Parameters:
pContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (in)
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.

getAnimationObjectID

int getAnimationObjectID(IAGAnimationContainer pContainer,
                         java.lang.Object pObject)
                         throws java.io.IOException,
                                AutomationException
The ID (index) of the given object among those of its animation type.

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

getAnimationObjectByID

java.lang.Object getAnimationObjectByID(IAGAnimationContainer pContainer,
                                        int objectID)
                                        throws java.io.IOException,
                                               AutomationException
The animated object with the given ID.

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

getAnimationObjectName

java.lang.String getAnimationObjectName(IAGAnimationContainer pContainer,
                                        java.lang.Object pObject)
                                        throws java.io.IOException,
                                               AutomationException
The name of the given object for animation purposes.

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

resetObject

void resetObject(IAGAnimationContainer pContainer,
                 java.lang.Object pObject)
                 throws java.io.IOException,
                        AutomationException
Resets the state of the object, preparing it for animation.

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

updateTrackExtensions

void updateTrackExtensions(IAGAnimationTrack pTrack)
                           throws java.io.IOException,
                                  AutomationException
Creates or modifies extensions of the given track when its type is assigned or objects are attached/detached.

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