com.esri.arcgis.analyst3d
Interface IAnimationType

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
AnimationTypeCamera, AnimationTypeGlobeCamera, AnimationTypeGlobeLayer, AnimationTypeLayer, AnimationTypeScene, IAnimationTypeProxy

public interface IAnimationType
extends java.io.Serializable

COM Interface 'IAnimationType'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esri3DAnalyst.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 IIDbbf1af30_a6ec_11d5_b2a0_00508bcdde28
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 java.lang.Object getAnimationObjectByID(IScene pScene, int objectID)
          The animated object with the given ID.
 int getAnimationObjectID(IScene pScene, java.lang.Object pObject)
          The ID (index) of the given object among those of its animation type in the scene.
 java.lang.String getAnimationObjectName(IScene pScene, java.lang.Object pObject)
          The name of the given object for animation purposes.
 IUID getCLSID()
          The class ID of the animation type.
 int getEnumPropertyMaxValue(int index)
          The maximum value of an integer or long enumerated property.
 int getEnumPropertyMinValue(int index)
          The minimum value of an integer or long enumerated property.
 java.lang.String getEnumPropertyValueName(int index, int value)
          The name of a value in an enumerated property.
 IUID getKeyframeCLSID()
          The class ID of the associated keyframe.
 java.lang.String getName()
          The name of the animation type.
 IArray getObjectArray(IScene pScene)
          The array of objects of this type in the scene.
 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.
 boolean isEnumProperty(int index)
          Indicates if an integer or long property is an enumeration.
 void resetObject(IScene pScene, java.lang.Object pObject)
          Resets the state of the object, preparing it for animation.
 

Field Detail

IIDbbf1af30_a6ec_11d5_b2a0_00508bcdde28

static final int IIDbbf1af30_a6ec_11d5_b2a0_00508bcdde28
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.

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.

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.

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.

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.

isEnumProperty

boolean isEnumProperty(int index)
                       throws java.io.IOException,
                              AutomationException
Indicates if an integer or long property is an enumeration.

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

getEnumPropertyValueName

java.lang.String getEnumPropertyValueName(int index,
                                          int value)
                                          throws java.io.IOException,
                                                 AutomationException
The name of a value in an enumerated property.

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

getEnumPropertyMinValue

int getEnumPropertyMinValue(int index)
                            throws java.io.IOException,
                                   AutomationException
The minimum value of an integer or long enumerated property.

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

getEnumPropertyMaxValue

int getEnumPropertyMaxValue(int index)
                            throws java.io.IOException,
                                   AutomationException
The maximum value of an integer or long enumerated property.

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

getObjectArray

IArray getObjectArray(IScene pScene)
                      throws java.io.IOException,
                             AutomationException
The array of objects of this type in the scene.

Parameters:
pScene - A reference to a com.esri.arcgis.analyst3d.IScene (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(IScene pScene,
                         java.lang.Object pObject)
                         throws java.io.IOException,
                                AutomationException
The ID (index) of the given object among those of its animation type in the scene.

Parameters:
pScene - A reference to a com.esri.arcgis.analyst3d.IScene (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(IScene pScene,
                                        int objectID)
                                        throws java.io.IOException,
                                               AutomationException
The animated object with the given ID.

Parameters:
pScene - A reference to a com.esri.arcgis.analyst3d.IScene (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(IScene pScene,
                                        java.lang.Object pObject)
                                        throws java.io.IOException,
                                               AutomationException
The name of the given object for animation purposes.

Parameters:
pScene - A reference to a com.esri.arcgis.analyst3d.IScene (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(IScene pScene,
                 java.lang.Object pObject)
                 throws java.io.IOException,
                        AutomationException
Resets the state of the object, preparing it for animation.

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