com.esri.arcgis.analyst3d
Class AnimationTypeLayer

java.lang.Object
  extended by com.esri.arcgis.analyst3d.AnimationTypeLayer
All Implemented Interfaces:
IAnimationType, IAGAnimationType, IAGAnimationTypeUI, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class AnimationTypeLayer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAnimationType, IAGAnimationType, IAGAnimationTypeUI

The Layer Animation Type coclass.

Remarks

AnimationTypeLayer is one of the three built-in animation types (the other two are AnimationTypeCamera and AnimationTypeScene) that are associated with an animation track.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Singleton:

This type is a singleton.

See Also:
Serialized Form

Constructor Summary
AnimationTypeLayer()
          Constructs a AnimationTypeLayer using ArcGIS Engine.
AnimationTypeLayer(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AnimationTypeLayer theAnimationTypeLayer = (AnimationTypeLayer) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 int getAnimationClass()
          The class of the animation type.
 Object getAnimationObjectByID(IAGAnimationContainer pContainer, int objectID)
          The animated object with the given ID.
 Object getAnimationObjectByID(IScene pScene, 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.
 int getAnimationObjectID(IScene pScene, Object pObject)
          The ID (index) of the given object among those of its animation type in the scene.
 String getAnimationObjectName(IAGAnimationContainer pContainer, Object pObject)
          The name of the given object for animation purposes.
 String getAnimationObjectName(IScene pScene, Object pObject)
          The name of the given object for animation purposes.
 IStringArray getChoiceList(int propIndex, int columnIndex)
          The column choice list.
static String getClsid()
          getClsid.
 IUID getCLSID()
          The class ID of the animation type.
 int getColumnCount(int propIndex)
          The number of columns.
 String getColumnName(int propIndex, int columnIndex)
          The column name.
 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(IAGAnimationContainer pContainer)
          The array of objects of this 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.
 int hashCode()
          the hashcode for this object
 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(IAGAnimationContainer pContainer, Object pObject)
          Resets the state of the object, preparing it for animation.
 void resetObject(IScene pScene, 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.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

AnimationTypeLayer

public AnimationTypeLayer()
                   throws IOException,
                          UnknownHostException
Constructs a AnimationTypeLayer using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

AnimationTypeLayer

public AnimationTypeLayer(Object obj)
                   throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AnimationTypeLayer theAnimationTypeLayer = (AnimationTypeLayer) obj;

Construct a AnimationTypeLayer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AnimationTypeLayer.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getName

public 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

Specified by:
getName in interface IAnimationType
Specified by:
getName in interface IAGAnimationType
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCLSID

public 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

Specified by:
getCLSID in interface IAnimationType
Specified by:
getCLSID in interface IAGAnimationType
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

public 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

Specified by:
getKeyframeCLSID in interface IAnimationType
Specified by:
getKeyframeCLSID in interface IAGAnimationType
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

public 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.

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

getPropertyCount

public 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

Specified by:
getPropertyCount in interface IAnimationType
Specified by:
getPropertyCount in interface IAGAnimationType
Returns:
The pPropCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPropertyType

public 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.

Specified by:
getPropertyType in interface IAnimationType
Specified by:
getPropertyType in interface IAGAnimationType
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

public 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.

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

isEnumProperty

public 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.

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

getEnumPropertyValueName

public 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.

Specified by:
getEnumPropertyValueName in interface IAnimationType
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

public 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.

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

getEnumPropertyMaxValue

public 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.

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

getObjectArray

public 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.

Specified by:
getObjectArray in interface IAnimationType
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

public 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.

Specified by:
getAnimationObjectID in interface IAnimationType
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

public 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.

Specified by:
getAnimationObjectByID in interface IAnimationType
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

public 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.

Specified by:
getAnimationObjectName in interface IAnimationType
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

public 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

Specified by:
resetObject in interface IAnimationType
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.

getAnimationClass

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

Product Availability

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

Specified by:
getAnimationClass in interface IAGAnimationType
Returns:
A com.esri.arcgis.animation.esriAnimationClass constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getObjectArray

public 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.

Specified by:
getObjectArray in interface IAGAnimationType
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

public 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.

Specified by:
getAnimationObjectID in interface IAGAnimationType
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

public 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.

Specified by:
getAnimationObjectByID in interface IAGAnimationType
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

public 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.

Specified by:
getAnimationObjectName in interface IAGAnimationType
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

public 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.

Specified by:
resetObject in interface IAGAnimationType
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

public 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.

Specified by:
updateTrackExtensions in interface IAGAnimationType
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.

getColumnCount

public int getColumnCount(int propIndex)
                   throws IOException,
                          AutomationException
The number of columns.

Product Availability

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

Specified by:
getColumnCount in interface IAGAnimationTypeUI
Parameters:
propIndex - The propIndex (in)
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColumnName

public String getColumnName(int propIndex,
                            int columnIndex)
                     throws IOException,
                            AutomationException
The column name.

Product Availability

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

Specified by:
getColumnName in interface IAGAnimationTypeUI
Parameters:
propIndex - The propIndex (in)
columnIndex - The columnIndex (in)
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getChoiceList

public IStringArray getChoiceList(int propIndex,
                                  int columnIndex)
                           throws IOException,
                                  AutomationException
The column choice list.

Product Availability

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

Specified by:
getChoiceList in interface IAGAnimationTypeUI
Parameters:
propIndex - The propIndex (in)
columnIndex - The columnIndex (in)
Returns:
A reference to a com.esri.arcgis.system.IStringArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.