com.esri.arcgis.analyst3d
Class IKeyframeProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.analyst3d.IKeyframeProxy

All Implemented Interfaces:

java.io.Externalizable, IKeyframe, java.io.Serializable

public class IKeyframeProxy

extends Dispatch

implements IKeyframe, java.io.Serializable

Provides access to keyframe of animated objects.

Product Availability

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

See Also:

Serialized Form

Field Summary

static java.lang.Class

targetClass

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF

Constructor Summary

	IKeyframeProxy() For internal use only
	IKeyframeProxy(java.lang.Object obj)
protected	IKeyframeProxy(java.lang.Object obj, java.lang.String iid)
	IKeyframeProxy(java.lang.String CLSID, java.lang.String host, AuthInfo authInfo)
protected	IKeyframeProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, AuthInfo authInfo)

Method Summary

void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource) Adds a Java object to be a listener for a specific kind of event generated by the COM object.
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	removeListener(java.lang.String iidStr, java.lang.Object theListener) Removes a Java object as a listener to events generated by a COM object.
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).

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, hashCode, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, readExternal, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

targetClass

public static final java.lang.Class targetClass

Constructor Detail

IKeyframeProxy

public IKeyframeProxy(java.lang.String CLSID,
                      java.lang.String host,
                      AuthInfo authInfo)
               throws java.net.UnknownHostException,
                      java.io.IOException

IKeyframeProxy

public IKeyframeProxy()

For internal use only

IKeyframeProxy

public IKeyframeProxy(java.lang.Object obj)
               throws java.io.IOException

IKeyframeProxy

protected IKeyframeProxy(java.lang.Object obj,
                         java.lang.String iid)
                  throws java.io.IOException

IKeyframeProxy

protected IKeyframeProxy(java.lang.String CLSID,
                         java.lang.String iid,
                         java.lang.String host,
                         AuthInfo authInfo)
                  throws java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Description copied from class: Dispatch

Adds a Java object to be a listener for a specific kind of event generated by the COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

addListener in class Dispatch

Parameters:

iidStr - the ID of the outgoing interface, implemented by the listener

theListener - the object to be informed of the events

theSource - the proxy class that represents the COM class that is the source of the events

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Description copied from class: Dispatch

Removes a Java object as a listener to events generated by a COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

removeListener in class Dispatch

Parameters:

iidStr - the ID of the outgoing interface, implemented by the listener

theListener - the object that no longer wishes to be informed of the events

Throws:

java.io.IOException

getName

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

Description copied from interface: IKeyframe

The name of the keyframe.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IKeyframe

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

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

Description copied from interface: IKeyframe

The name of the keyframe.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IKeyframe

Parameters:

name - The name (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getActiveProperties

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

Description copied from interface: IKeyframe

The combination of active properties.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getActiveProperties in interface IKeyframe

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

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

Description copied from interface: IKeyframe

The combination of active properties.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setActiveProperties in interface IKeyframe

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

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

Description copied from interface: IKeyframe

Indicates if an animation property is active.

Specified by:

isActiveProperty in interface IKeyframe

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

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

Description copied from interface: IKeyframe

Indicates if an animation property is active.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setIsActiveProperty in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

pbIsActiveProp - The pbIsActiveProp (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getPropertyValueInt

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

Description copied from interface: IKeyframe

The value of an integer typed property.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPropertyValueInt in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

Returns:

The pIntValue

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getPropertyValueLong

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

Description copied from interface: IKeyframe

The value of a long integer typed property.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPropertyValueLong in interface IKeyframe

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

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

Description copied from interface: IKeyframe

The value of a double-typed property.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPropertyValueDouble in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

Returns:

The pDoubleValue

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isPropertyValueBoolean

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

Description copied from interface: IKeyframe

Indicates if the property is TRUE.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isPropertyValueBoolean in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

Returns:

The pBoolValue

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getPropertyValuePoint

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

Description copied from interface: IKeyframe

The value of a Point-typed property.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPropertyValuePoint in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getPropertyValueExtent

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

Description copied from interface: IKeyframe

The value of an Extent-typed property.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPropertyValueExtent in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getPropertyValueRGBColor

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

Description copied from interface: IKeyframe

The value of an RGB Color-typed property.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPropertyValueRGBColor in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setPropertyValueInt

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

Description copied from interface: IKeyframe

The value of an integer typed property.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPropertyValueInt in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

pIntValue - The pIntValue (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setPropertyValueLong

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

Description copied from interface: IKeyframe

The value of a long integer typed property.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPropertyValueLong in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

pLongValue - The pLongValue (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setPropertyValueDouble

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

Description copied from interface: IKeyframe

The value of a double-typed property.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPropertyValueDouble in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

pDoubleValue - The pDoubleValue (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setPropertyValueBoolean

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

Description copied from interface: IKeyframe

Indicates if the property is TRUE.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPropertyValueBoolean in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

pBoolValue - The pBoolValue (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setPropertyValuePoint

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

Description copied from interface: IKeyframe

The value of a Point-typed property.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPropertyValuePoint in interface IKeyframe

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

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

Description copied from interface: IKeyframe

The value of an Extent-typed property.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPropertyValueExtent in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setPropertyValueRGBColor

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

Description copied from interface: IKeyframe

The value of an RGB Color-typed property.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPropertyValueRGBColor in interface IKeyframe

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

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

Description copied from interface: IKeyframe

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTimeStamp in interface IKeyframe

Parameters:

pTimeStamp - The pTimeStamp (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeStamp

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

Description copied from interface: IKeyframe

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTimeStamp in interface IKeyframe

Returns:

The pTimeStamp

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getAnimationType

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

Description copied from interface: IKeyframe

The animation type.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAnimationType in interface IKeyframe

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

apply

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

Description copied from interface: IKeyframe

Apply to the object the active properties of the keyframe.

Supported Platforms

Windows, Solaris, Linux

Remarks

The second argument of this method can be a Camera, a Layer, or a Scene object, which corresponds to one of the three built-in animation types.

Specified by:

apply in interface IKeyframe

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

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

Description copied from interface: IKeyframe

Copy the properties from the object to the keyframe.

Supported Platforms

Windows, Solaris, Linux

Specified by:

captureProperties in interface IKeyframe

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

public void interpolate(IScene pScene,
                        java.lang.Object pObject,
                        int propertyIndex,
                        double time,
                        IKeyframe pNextKeyframe,
                        IKeyframe pPrevKeyframe,
                        IKeyframe pAfterNextKeyframe)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IKeyframe

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interpolate in interface IKeyframe

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:

AutomationException - If the ArcObject component throws an exception.

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

isObjectNeedsRefresh

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

Description copied from interface: IKeyframe

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isObjectNeedsRefresh in interface IKeyframe

Returns:

The pNeedsRefresh

Throws:

AutomationException - If the ArcObject component throws an exception.

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

refreshObject

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

Description copied from interface: IKeyframe

Recreates the object after its properties have been interpolated.

Supported Platforms

Windows, Solaris, Linux

Specified by:

refreshObject in interface IKeyframe

Parameters:

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

pObject - A Variant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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