com.esri.arcgis.animation
Interface IAGKeyframe

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

Bookmark3D, GlobeCameraKeyframe, GlobeLayerKeyframe, IAGKeyframeProxy, LayerKeyframe, MapLayerKeyframe, MapViewKeyframe, SceneKeyframe, TimeKeyframe, TimeLayerKeyframe

public interface IAGKeyframe
extends java.io.Serializable

COM Interface 'IAGKeyframe'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esriAnimation.olb'

Description: 'Provides access to keyframes of animated objects.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID7c35dc01_7cdf_463e_9b7a_87c9ae769bef
static int	xxDummy Deprecated. Internal use only

Method Summary

void	apply(IAGAnimationTrack pTrack, IAGAnimationContainer pContainer, java.lang.Object pObject) Apply to the object the active properties of the keyframe.
void	captureProperties(IAGAnimationContainer pContainer, java.lang.Object pObject) Copy the properties from the object to the keyframe.
ILongArray	getActiveProperties() The combination of active properties.
java.lang.String	getName() The name of the keyframe.
java.lang.Object	getPropertyValue(int propIndex) The value of a typed property.
double	getTimeStamp() The time stamp (in the interval 0-1).
IAGAnimationType	IAGKeyframe_getAnimationType() The animation type.
void	interpolate(IAGAnimationTrack pTrack, IAGAnimationContainer pContainer, java.lang.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	isObjectNeedsRefresh() Indicates if the object must be refreshed after interpolating its state.
void	refreshObject(IAGAnimationTrack pTrack, IAGAnimationContainer pContainer, java.lang.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(java.lang.String name) The name of the keyframe.
void	setPropertyValue(int propIndex, java.lang.Object pValue) The value of a typed property.
void	setTimeStamp(double pTimeStamp) The time stamp (in the interval 0-1).

Field Detail

IID7c35dc01_7cdf_463e_9b7a_87c9ae769bef

static final int IID7c35dc01_7cdf_463e_9b7a_87c9ae769bef

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the keyframe.

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

The name of the keyframe.

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActiveProperties

ILongArray getActiveProperties()
                               throws java.io.IOException,
                                      AutomationException

The combination of active properties.

Returns:

A reference to a com.esri.arcgis.system.ILongArray

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActiveProperties

void setActiveProperties(ILongArray ppActiveProps)
                         throws java.io.IOException,
                                AutomationException

The combination of active properties.

Parameters:

ppActiveProps - A reference to a com.esri.arcgis.system.ILongArray (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isActiveProperty

boolean isActiveProperty(int propIndex)
                         throws java.io.IOException,
                                AutomationException

Indicates if an animation property is active.

Parameters:

propIndex - The propIndex (in)

Returns:

The pbIsActiveProp

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsActiveProperty

void setIsActiveProperty(int propIndex,
                         boolean pbIsActiveProp)
                         throws java.io.IOException,
                                AutomationException

Indicates if an animation property is active.

Parameters:

propIndex - The propIndex (in)

pbIsActiveProp - The pbIsActiveProp (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropertyValue

java.lang.Object getPropertyValue(int propIndex)
                                  throws java.io.IOException,
                                         AutomationException

The value of a typed property.

Parameters:

propIndex - The propIndex (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPropertyValue

void setPropertyValue(int propIndex,
                      java.lang.Object pValue)
                      throws java.io.IOException,
                             AutomationException

The value of a typed property.

Parameters:

propIndex - The propIndex (in)

pValue - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeStamp

void setTimeStamp(double pTimeStamp)
                  throws java.io.IOException,
                         AutomationException

The time stamp (in the interval 0-1).

Parameters:

pTimeStamp - The pTimeStamp (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeStamp

double getTimeStamp()
                    throws java.io.IOException,
                           AutomationException

The time stamp (in the interval 0-1).

Returns:

The pTimeStamp

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

IAGKeyframe_getAnimationType

IAGAnimationType IAGKeyframe_getAnimationType()
                                              throws java.io.IOException,
                                                     AutomationException

The animation type.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

apply

void apply(IAGAnimationTrack pTrack,
           IAGAnimationContainer pContainer,
           java.lang.Object pObject)
           throws java.io.IOException,
                  AutomationException

Apply to the object the active properties of the keyframe.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

captureProperties

void captureProperties(IAGAnimationContainer pContainer,
                       java.lang.Object pObject)
                       throws java.io.IOException,
                              AutomationException

Copy the properties from the object to the keyframe.

Parameters:

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

pObject - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interpolate

void interpolate(IAGAnimationTrack pTrack,
                 IAGAnimationContainer pContainer,
                 java.lang.Object pObject,
                 int propertyIndex,
                 double time,
                 IAGKeyframe pNextKeyframe,
                 IAGKeyframe pPrevKeyframe,
                 IAGKeyframe pAfterNextKeyframe)
                 throws java.io.IOException,
                        AutomationException

Interpolates the values of an object property for a time between this keyframe and the next (time is in [0,1]).

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isObjectNeedsRefresh

boolean isObjectNeedsRefresh()
                             throws java.io.IOException,
                                    AutomationException

Indicates if the object must be refreshed after interpolating its state.

Returns:

The pNeedsRefresh

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refreshObject

void refreshObject(IAGAnimationTrack pTrack,
                   IAGAnimationContainer pContainer,
                   java.lang.Object pObject)
                   throws java.io.IOException,
                          AutomationException

Recreates the object after its properties have been interpolated.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.