com.esri.arcgis.analyst3d
Interface IKeyframe

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

Bookmark3D, GlobeCameraKeyframe, GlobeLayerKeyframe, IKeyframeProxy, LayerKeyframe, SceneKeyframe

public interface IKeyframe
extends java.io.Serializable

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

Description: 'Provides access to keyframe 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	IID767c9b53_5a8e_11d5_b295_00508bcdde28
static int	xxDummy Deprecated. Internal use only

Method Summary

void	apply(IScene pScene, java.lang.Object pObject) Apply to the object the active properties of the keyframe.
void	captureProperties(IScene pScene, java.lang.Object pObject) Copy the properties from the object to the keyframe.
ILongArray	getActiveProperties() The combination of active properties.
IAnimationType	getAnimationType() The animation type.
java.lang.String	getName() The name of the keyframe.
double	getPropertyValueDouble(int propIndex) The value of a double-typed property.
IEnvelope	getPropertyValueExtent(int propIndex) The value of an Extent-typed property.
int	getPropertyValueInt(int propIndex) The value of an integer typed property.
int	getPropertyValueLong(int propIndex) The value of a long integer typed property.
IPoint	getPropertyValuePoint(int propIndex) The value of a Point-typed property.
IColor	getPropertyValueRGBColor(int propIndex) The value of an RGB Color-typed property.
double	getTimeStamp() The time stamp (in the interval 0-1).
void	interpolate(IScene pScene, java.lang.Object pObject, int propertyIndex, double time, IKeyframe pNextKeyframe, IKeyframe pPrevKeyframe, IKeyframe 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.
boolean	isPropertyValueBoolean(int propIndex) Indicates if the property is TRUE.
void	refreshObject(IScene pScene, 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	setPropertyValueBoolean(int propIndex, boolean pBoolValue) Indicates if the property is TRUE.
void	setPropertyValueDouble(int propIndex, double pDoubleValue) The value of a double-typed property.
void	setPropertyValueExtent(int propIndex, IEnvelope ppExtent) The value of an Extent-typed property.
void	setPropertyValueInt(int propIndex, int pIntValue) The value of an integer typed property.
void	setPropertyValueLong(int propIndex, int pLongValue) The value of a long integer typed property.
void	setPropertyValuePoint(int propIndex, IPoint ppPoint) The value of a Point-typed property.
void	setPropertyValueRGBColor(int propIndex, IColor ppColor) The value of an RGB Color-typed property.
void	setTimeStamp(double pTimeStamp) The time stamp (in the interval 0-1).

Field Detail

IID767c9b53_5a8e_11d5_b295_00508bcdde28

static final int IID767c9b53_5a8e_11d5_b295_00508bcdde28

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.

getPropertyValueInt

int getPropertyValueInt(int propIndex)
                        throws java.io.IOException,
                               AutomationException

The value of an integer typed property.

Parameters:

propIndex - The propIndex (in)

Returns:

The pIntValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPropertyValueLong

int getPropertyValueLong(int propIndex)
                         throws java.io.IOException,
                                AutomationException

The value of a long integer typed property.

Parameters:

propIndex - The propIndex (in)

Returns:

The pLongValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPropertyValueDouble

double getPropertyValueDouble(int propIndex)
                              throws java.io.IOException,
                                     AutomationException

The value of a double-typed property.

Parameters:

propIndex - The propIndex (in)

Returns:

The pDoubleValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isPropertyValueBoolean

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

Indicates if the property is TRUE.

Parameters:

propIndex - The propIndex (in)

Returns:

The pBoolValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPropertyValuePoint

IPoint getPropertyValuePoint(int propIndex)
                             throws java.io.IOException,
                                    AutomationException

The value of a Point-typed property.

Parameters:

propIndex - The propIndex (in)

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPropertyValueExtent

IEnvelope getPropertyValueExtent(int propIndex)
                                 throws java.io.IOException,
                                        AutomationException

The value of an Extent-typed property.

Parameters:

propIndex - The propIndex (in)

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPropertyValueRGBColor

IColor getPropertyValueRGBColor(int propIndex)
                                throws java.io.IOException,
                                       AutomationException

The value of an RGB Color-typed property.

Parameters:

propIndex - The propIndex (in)

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPropertyValueInt

void setPropertyValueInt(int propIndex,
                         int pIntValue)
                         throws java.io.IOException,
                                AutomationException

The value of an integer typed property.

Parameters:

propIndex - The propIndex (in)

pIntValue - The pIntValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPropertyValueLong

void setPropertyValueLong(int propIndex,
                          int pLongValue)
                          throws java.io.IOException,
                                 AutomationException

The value of a long integer typed property.

Parameters:

propIndex - The propIndex (in)

pLongValue - The pLongValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPropertyValueDouble

void setPropertyValueDouble(int propIndex,
                            double pDoubleValue)
                            throws java.io.IOException,
                                   AutomationException

The value of a double-typed property.

Parameters:

propIndex - The propIndex (in)

pDoubleValue - The pDoubleValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPropertyValueBoolean

void setPropertyValueBoolean(int propIndex,
                             boolean pBoolValue)
                             throws java.io.IOException,
                                    AutomationException

Indicates if the property is TRUE.

Parameters:

propIndex - The propIndex (in)

pBoolValue - The pBoolValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPropertyValuePoint

void setPropertyValuePoint(int propIndex,
                           IPoint ppPoint)
                           throws java.io.IOException,
                                  AutomationException

The value of a Point-typed property.

Parameters:

propIndex - The propIndex (in)

ppPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPropertyValueExtent

void setPropertyValueExtent(int propIndex,
                            IEnvelope ppExtent)
                            throws java.io.IOException,
                                   AutomationException

The value of an Extent-typed property.

Parameters:

propIndex - The propIndex (in)

ppExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPropertyValueRGBColor

void setPropertyValueRGBColor(int propIndex,
                              IColor ppColor)
                              throws java.io.IOException,
                                     AutomationException

The value of an RGB Color-typed property.

Parameters:

propIndex - The propIndex (in)

ppColor - A reference to a com.esri.arcgis.display.IColor (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.

getAnimationType

IAnimationType getAnimationType()
                                throws java.io.IOException,
                                       AutomationException

The animation type.

Returns:

A reference to a com.esri.arcgis.analyst3d.IAnimationType

Throws:

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

AutomationException - If the ArcObject component throws an exception.

apply

void apply(IScene pScene,
           java.lang.Object pObject)
           throws java.io.IOException,
                  AutomationException

Apply to the object the active properties of the keyframe.

Parameters:

pScene - A reference to a com.esri.arcgis.analyst3d.IScene (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(IScene pScene,
                       java.lang.Object pObject)
                       throws java.io.IOException,
                              AutomationException

Copy the properties from the object to the keyframe.

Parameters:

pScene - A reference to a com.esri.arcgis.analyst3d.IScene (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(IScene pScene,
                 java.lang.Object pObject,
                 int propertyIndex,
                 double time,
                 IKeyframe pNextKeyframe,
                 IKeyframe pPrevKeyframe,
                 IKeyframe 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:

pScene - A reference to a com.esri.arcgis.analyst3d.IScene (in)

pObject - A Variant (in)

propertyIndex - The propertyIndex (in)

time - The time (in)

pNextKeyframe - A reference to a com.esri.arcgis.analyst3d.IKeyframe (in)

pPrevKeyframe - A reference to a com.esri.arcgis.analyst3d.IKeyframe (in)

pAfterNextKeyframe - A reference to a com.esri.arcgis.analyst3d.IKeyframe (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(IScene pScene,
                   java.lang.Object pObject)
                   throws java.io.IOException,
                          AutomationException

Recreates the object after its properties have been interpolated.

Parameters:

pScene - A reference to a com.esri.arcgis.analyst3d.IScene (in)

pObject - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.