com.esri.arcgis.animation
Class TimeLayerKeyframe

java.lang.Object
  extended by com.esri.arcgis.animation.TimeLayerKeyframe
All Implemented Interfaces:
IAGKeyframe, IAGKeyframeInterval, IAGKeyframeUI, com.esri.arcgis.interop.RemoteObjRef, IClone, Serializable

public class TimeLayerKeyframe
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAGKeyframe, IAGKeyframeUI, IClone, IAGKeyframeInterval

Time layer keyframe object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
TimeLayerKeyframe()
          Constructs a TimeLayerKeyframe using ArcGIS Engine.
TimeLayerKeyframe(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TimeLayerKeyframe theTimeLayerKeyframe = (TimeLayerKeyframe) obj;
 
Method Summary
 void apply(IAGAnimationTrack pTrack, IAGAnimationContainer pContainer, Object pObject)
          Apply to the object the active properties of the keyframe.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void captureProperties(IAGAnimationContainer pContainer, Object pObject)
          Copy the properties from the object to the keyframe.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 ILongArray getActiveProperties()
          The combination of active properties.
 double getAnimationInterval(IAGKeyframe pNextKeyframe)
          The interval for this keyframe.
static String getClsid()
          getClsid.
 void getDisplayTime(String[] pDisplayTime)
          The last interpolated time interval for this keyframe.
 String getName()
          The name of the keyframe.
 Object getPropertyValue(int propIndex)
          The value of a typed property.
 String getText(int propIndex, int columnIndex)
          Get the column text.
 double getTimeStamp()
          The time stamp (in the interval 0-1).
 int hashCode()
          the hashcode for this object
 IAGAnimationType IAGKeyframe_getAnimationType()
          The animation type.
 void interpolate(IAGAnimationTrack pTrack, IAGAnimationContainer pContainer, Object pObject, int propertyIndex, double time, IAGKeyframe pNextKeyframe, IAGKeyframe pPrevKeyframe, IAGKeyframe pAfterNextKeyframe)
          Interpolates the values of an object property for a time between this keyframe and the next (time is in [0,1]).
 boolean isActiveProperty(int propIndex)
          Indicates if an animation property is active.
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 boolean isObjectNeedsRefresh()
          Indicates if the object must be refreshed after interpolating its state.
 void refreshObject(IAGAnimationTrack pTrack, IAGAnimationContainer pContainer, Object pObject)
          Recreates the object after its properties have been interpolated.
 void setActiveProperties(ILongArray ppActiveProps)
          The combination of active properties.
 void setIsActiveProperty(int propIndex, boolean pbIsActiveProp)
          Indicates if an animation property is active.
 void setName(String name)
          The name of the keyframe.
 void setPropertyValue(int propIndex, Object pValue)
          The value of a typed property.
 void setText(int propIndex, int columnIndex, String text)
          Set the column text.
 void setTimeStamp(double pTimeStamp)
          The time stamp (in the interval 0-1).
 
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

TimeLayerKeyframe

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

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

TimeLayerKeyframe

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

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

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

Product Availability

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

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

setName

public void setName(String name)
             throws IOException,
                    AutomationException
The name of the keyframe.

Product Availability

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

Specified by:
setName in interface IAGKeyframe
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getActiveProperties

public ILongArray getActiveProperties()
                               throws IOException,
                                      AutomationException
The combination of active properties.

Product Availability

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

Specified by:
getActiveProperties in interface IAGKeyframe
Returns:
A reference to a com.esri.arcgis.system.ILongArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setActiveProperties

public void setActiveProperties(ILongArray ppActiveProps)
                         throws IOException,
                                AutomationException
The combination of active properties.

Product Availability

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

Specified by:
setActiveProperties in interface IAGKeyframe
Parameters:
ppActiveProps - A reference to a com.esri.arcgis.system.ILongArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isActiveProperty

public boolean isActiveProperty(int propIndex)
                         throws IOException,
                                AutomationException
Indicates if an animation property is active.

Product Availability

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

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

setIsActiveProperty

public void setIsActiveProperty(int propIndex,
                                boolean pbIsActiveProp)
                         throws IOException,
                                AutomationException
Indicates if an animation property is active.

Product Availability

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

Specified by:
setIsActiveProperty in interface IAGKeyframe
Parameters:
propIndex - The propIndex (in)
pbIsActiveProp - The pbIsActiveProp (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPropertyValue

public Object getPropertyValue(int propIndex)
                        throws IOException,
                               AutomationException
The value of a typed property.

Product Availability

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

Specified by:
getPropertyValue in interface IAGKeyframe
Parameters:
propIndex - The propIndex (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPropertyValue

public void setPropertyValue(int propIndex,
                             Object pValue)
                      throws IOException,
                             AutomationException
The value of a typed property.

Product Availability

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

Specified by:
setPropertyValue in interface IAGKeyframe
Parameters:
propIndex - The propIndex (in)
pValue - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeStamp

public void setTimeStamp(double pTimeStamp)
                  throws IOException,
                         AutomationException
The time stamp (in the interval 0-1).

Product Availability

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

Specified by:
setTimeStamp in interface IAGKeyframe
Parameters:
pTimeStamp - The pTimeStamp (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeStamp

public double getTimeStamp()
                    throws IOException,
                           AutomationException
The time stamp (in the interval 0-1).

Product Availability

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

Specified by:
getTimeStamp in interface IAGKeyframe
Returns:
The pTimeStamp
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

IAGKeyframe_getAnimationType

public IAGAnimationType IAGKeyframe_getAnimationType()
                                              throws IOException,
                                                     AutomationException
The animation type.

Product Availability

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

Specified by:
IAGKeyframe_getAnimationType in interface IAGKeyframe
Returns:
A reference to a com.esri.arcgis.animation.IAGAnimationType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

apply

public void apply(IAGAnimationTrack pTrack,
                  IAGAnimationContainer pContainer,
                  Object pObject)
           throws IOException,
                  AutomationException
Apply to the object the active properties of the keyframe.

Product Availability

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

Specified by:
apply in interface IAGKeyframe
Parameters:
pTrack - A reference to a com.esri.arcgis.animation.IAGAnimationTrack (in)
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.

captureProperties

public void captureProperties(IAGAnimationContainer pContainer,
                              Object pObject)
                       throws IOException,
                              AutomationException
Copy the properties from the object to the keyframe.

Product Availability

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

Specified by:
captureProperties in interface IAGKeyframe
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.

interpolate

public void interpolate(IAGAnimationTrack pTrack,
                        IAGAnimationContainer pContainer,
                        Object pObject,
                        int propertyIndex,
                        double time,
                        IAGKeyframe pNextKeyframe,
                        IAGKeyframe pPrevKeyframe,
                        IAGKeyframe pAfterNextKeyframe)
                 throws IOException,
                        AutomationException
Interpolates the values of an object property for a time between this keyframe and the next (time is in [0,1]).

Product Availability

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

Specified by:
interpolate in interface IAGKeyframe
Parameters:
pTrack - A reference to a com.esri.arcgis.animation.IAGAnimationTrack (in)
pContainer - A reference to a com.esri.arcgis.animation.IAGAnimationContainer (in)
pObject - A Variant (in)
propertyIndex - The propertyIndex (in)
time - The time (in)
pNextKeyframe - A reference to a com.esri.arcgis.animation.IAGKeyframe (in)
pPrevKeyframe - A reference to a com.esri.arcgis.animation.IAGKeyframe (in)
pAfterNextKeyframe - A reference to a com.esri.arcgis.animation.IAGKeyframe (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isObjectNeedsRefresh

public boolean isObjectNeedsRefresh()
                             throws IOException,
                                    AutomationException
Indicates if the object must be refreshed after interpolating its state.

Product Availability

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

Specified by:
isObjectNeedsRefresh in interface IAGKeyframe
Returns:
The pNeedsRefresh
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refreshObject

public void refreshObject(IAGAnimationTrack pTrack,
                          IAGAnimationContainer pContainer,
                          Object pObject)
                   throws IOException,
                          AutomationException
Recreates the object after its properties have been interpolated.

Product Availability

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

Specified by:
refreshObject in interface IAGKeyframe
Parameters:
pTrack - A reference to a com.esri.arcgis.animation.IAGAnimationTrack (in)
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.

getText

public String getText(int propIndex,
                      int columnIndex)
               throws IOException,
                      AutomationException
Get the column text.

Product Availability

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

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

setText

public void setText(int propIndex,
                    int columnIndex,
                    String text)
             throws IOException,
                    AutomationException
Set the column text.

Product Availability

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

Specified by:
setText in interface IAGKeyframeUI
Parameters:
propIndex - The propIndex (in)
columnIndex - The columnIndex (in)
text - The text (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnimationInterval

public double getAnimationInterval(IAGKeyframe pNextKeyframe)
                            throws IOException,
                                   AutomationException
The interval for this keyframe.

Product Availability

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

Specified by:
getAnimationInterval in interface IAGKeyframeInterval
Parameters:
pNextKeyframe - A reference to a com.esri.arcgis.animation.IAGKeyframe (in)
Returns:
The pInterval
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDisplayTime

public void getDisplayTime(String[] pDisplayTime)
                    throws IOException,
                           AutomationException
The last interpolated time interval for this keyframe.

Product Availability

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

Specified by:
getDisplayTime in interface IAGKeyframeInterval
Parameters:
pDisplayTime - The pDisplayTime (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.