com.esri.arcgis.analyst3d
Interface IAnimationType

All Superinterfaces:
Serializable
All Known Implementing Classes:
AnimationTypeCamera, AnimationTypeGlobeCamera, AnimationTypeGlobeLayer, AnimationTypeLayer, AnimationTypeScene

public interface IAnimationType
extends Serializable

Provides access to the animation type objects.

Remarks

One animation track is associated with an animation type, which could be one of the three built-in types (Camera, Layer, or Scene), or a type that's defined by the developer. IAnimationType interface provides the properties and a method that can be used to manage an animation type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux


Method Summary
 Object getAnimationObjectByID(IScene pScene, int objectID)
          The animated object with the given ID.
 int getAnimationObjectID(IScene pScene, Object pObject)
          The ID (index) of the given object among those of its animation type in the scene.
 String getAnimationObjectName(IScene pScene, 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.
 String getEnumPropertyValueName(int index, int value)
          The name of a value in an enumerated property.
 IUID getKeyframeCLSID()
          The class ID of the associated keyframe.
 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.
 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(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, Object pObject)
          Resets the state of the object, preparing it for animation.
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
The name of the animation type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

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

getCLSID

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

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

getKeyframeCLSID

IUID getKeyframeCLSID()
                      throws IOException,
                             AutomationException
The class ID of the associated keyframe.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

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

isAppliesToObject

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

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

getPropertyCount

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

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

getPropertyType

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

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

getPropertyName

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

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

isEnumProperty

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

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

getEnumPropertyValueName

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

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

getEnumPropertyMinValue

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

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

getEnumPropertyMaxValue

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

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

getObjectArray

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Parameters:
pScene - A reference to a com.esri.arcgis.analyst3d.IScene (in)
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.

getAnimationObjectID

int getAnimationObjectID(IScene pScene,
                         Object pObject)
                         throws IOException,
                                AutomationException
The ID (index) of the given object among those of its animation type in the scene.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

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

getAnimationObjectByID

Object getAnimationObjectByID(IScene pScene,
                              int objectID)
                              throws IOException,
                                     AutomationException
The animated object with the given ID.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

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

getAnimationObjectName

String getAnimationObjectName(IScene pScene,
                              Object pObject)
                              throws IOException,
                                     AutomationException
The name of the given object for animation purposes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

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

resetObject

void resetObject(IScene pScene,
                 Object pObject)
                 throws IOException,
                        AutomationException
Resets the state of the object, preparing it for animation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

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