com.esri.arcgis.animation
Class AnimationTypeTimeLayer

java.lang.Object
  com.esri.arcgis.animation.AnimationTypeTimeLayer

All Implemented Interfaces:

IAGAnimationType, IAGAnimationTypeUI, IAnimationTypeTimeLayer, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class AnimationTypeTimeLayer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAGAnimationType, IAGAnimationTypeUI, IAnimationTypeTimeLayer

Animation Type Time Layer.

Product Availability

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

Singleton:

This type is a singleton.

See Also:

Serialized Form

Constructor Summary

AnimationTypeTimeLayer()
Constructs a AnimationTypeTimeLayer using ArcGIS Engine.

AnimationTypeTimeLayer(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AnimationTypeTimeLayer theAnimationTypeTimeLayer = (AnimationTypeTimeLayer) obj;

Method Summary

void	assignTimeRange(IAGAnimationTrack pTrack) Calculates the minimum and maximum times for the Time Keyframe from the track.
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.
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.
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.
IUID	getKeyframeCLSID() The class ID of the associated keyframe, or 0 if it has none.
IMDDatasetView	getMDDatasetView(Object pUnk) Provides access to the MDDatasetview for the input datasource.
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.
ITable	getTable(Object pUnk) Provides access to the Table for the input datasource.
ITimeLayerTrackExtension	getTimeLayerTrackExtension(IAGAnimationTrack pTrack) Provides access to the Time Layer Track Extension.
void	getTimeWindow(IAGAnimationTrack pTrack, Object pObject, ITimeWindow ppTimeWindow) Provides access to the time window for the attached object.
int	hashCode() the hashcode for this object
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.

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

AnimationTypeTimeLayer

public AnimationTypeTimeLayer()
                       throws IOException,
                              UnknownHostException

Constructs a AnimationTypeTimeLayer using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

AnimationTypeTimeLayer

public AnimationTypeTimeLayer(Object obj)
                       throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AnimationTypeTimeLayer theAnimationTypeTimeLayer = (AnimationTypeTimeLayer) obj;

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

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.

Specified by:

getName in interface IAGAnimationType

Returns:

The name

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.

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.

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

Product Availability

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

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.

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.

Specified by:

getPropertyCount in interface IAGAnimationType

Returns:

The pPropCount

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.

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.

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.

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.

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.

getTimeWindow

public void getTimeWindow(IAGAnimationTrack pTrack,
                          Object pObject,
                          ITimeWindow ppTimeWindow)
                   throws IOException,
                          AutomationException

Provides access to the time window for the attached object.

Product Availability

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

Specified by:

getTimeWindow in interface IAnimationTypeTimeLayer

Parameters:

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

pObject - A reference to another Object (IUnknown) (in)

ppTimeWindow - A reference to a com.esri.arcgis.animation.ITimeWindow (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assignTimeRange

public void assignTimeRange(IAGAnimationTrack pTrack)
                     throws IOException,
                            AutomationException

Calculates the minimum and maximum times for the Time Keyframe from the track.

Product Availability

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

Specified by:

assignTimeRange in interface IAnimationTypeTimeLayer

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.

getMDDatasetView

public IMDDatasetView getMDDatasetView(Object pUnk)
                                throws IOException,
                                       AutomationException

Provides access to the MDDatasetview for the input datasource.

Product Availability

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

Specified by:

getMDDatasetView in interface IAnimationTypeTimeLayer

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

A reference to a com.esri.arcgis.datasourcesnetCDF.IMDDatasetView

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTable

public ITable getTable(Object pUnk)
                throws IOException,
                       AutomationException

Provides access to the Table for the input datasource.

Product Availability

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

Specified by:

getTable in interface IAnimationTypeTimeLayer

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeLayerTrackExtension

public ITimeLayerTrackExtension getTimeLayerTrackExtension(IAGAnimationTrack pTrack)
                                                    throws IOException,
                                                           AutomationException

Provides access to the Time Layer Track Extension.

Product Availability

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

Specified by:

getTimeLayerTrackExtension in interface IAnimationTypeTimeLayer

Parameters:

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

Returns:

A reference to a com.esri.arcgis.animation.ITimeLayerTrackExtension

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.