com.esri.arcgis.animation
Interface IAGAnimationType

All Superinterfaces:

Serializable

All Known Implementing Classes:

AnimationTypeCamera, AnimationTypeGlobeCamera, AnimationTypeGlobeLayer, AnimationTypeLayer, AnimationTypeMapLayer, AnimationTypeMapView, AnimationTypeScene, AnimationTypeTime, AnimationTypeTimeLayer

public interface IAGAnimationType
extends Serializable

Provides access to the animation type objects.

Remarks

An animation type object provides information for a given animation type. For each animation track, an animation type has to be specified. You can get the animated property names and types of each animation type through the PropertyName() and PropertyType() members found on this interface.

The following tables list the animated property names and types for the out-of-the-box animation types in ArcMap:

Properties animated in a map view animation:

Property	Name	Type
0	View Extent of a Map	IEnvelope

Properties animated in a map layer animation:

Property	Name	Type
0	Visibility of Layer(s)	Boolean
1	Transparency of Layer(s)	Integer

Properties of a time layer animation keyframe:

Property	Name	Type
0	Time	Date
1	Interval	Double
2	Units	Long

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

int	getAnimationClass() The class of the animation type.
Object	getAnimationObjectByID(IAGAnimationContainer pContainer, int objectID) The animated object with the given ID.
int	getAnimationObjectID(IAGAnimationContainer pContainer, Object pObject) The ID (index) of the given object among those of its animation type.
String	getAnimationObjectName(IAGAnimationContainer pContainer, 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.
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.
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.
void	resetObject(IAGAnimationContainer pContainer, 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.

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.

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAnimationClass

int getAnimationClass()
                      throws IOException,
                             AutomationException

The class of the animation type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A com.esri.arcgis.animation.esriAnimationClass constant

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.

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, or 0 if it has none.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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.

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.

Returns:

The pPropCount

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.

Parameters:

index - The index (in)

Returns:

The pPropName

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.

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.

getObjectArray

IArray getObjectArray(IAGAnimationContainer pContainer)
                      throws IOException,
                             AutomationException

The array of objects of this type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (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(IAGAnimationContainer pContainer,
                         Object pObject)
                         throws IOException,
                                AutomationException

The ID (index) of the given object among those of its animation type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (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(IAGAnimationContainer pContainer,
                              int objectID)
                              throws IOException,
                                     AutomationException

The animated object with the given ID.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

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

Parameters:

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

Parameters:

pContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (in)

pObject - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateTrackExtensions

void updateTrackExtensions(IAGAnimationTrack pTrack)
                           throws IOException,
                                  AutomationException

Creates or modifies extensions of the given track when its type is assigned or objects are attached/detached.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pTrack - A reference to a com.esri.arcgis.animation.IAGAnimationTrack (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.