com.esri.arcgis.analyst3d
Class Bookmark3D

java.lang.Object
  com.esri.arcgis.analyst3d.Bookmark3D

All Implemented Interfaces:

IAGKeyframe, IBookmark3D, IBookmarkToKeyframe, IClone, IKeyframe, IPersist, IPersistStream, java.io.Serializable

public class Bookmark3D

extends java.lang.Object

implements IBookmark3D, IKeyframe, IAGKeyframe, IBookmarkToKeyframe, IPersistStream, IClone

The 3D bookmark coclass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Remarks

Bookmark3D coclass manages 3D bookmarks and camera keyframes. It also provides the facility to convert a 3D bookmark into a camera keyframe (via IBookmarkToKeyframe interface). There are 8 different camera properties that can be used for a camera animation through its IKeyframe interface.

See Also:

Serialized Form

Constructor Summary

Bookmark3D()
Constructs a Bookmark3D using ArcGIS Engine.

Bookmark3D(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

void	apply(IAGAnimationTrack pTrack, IAGAnimationContainer pContainer, java.lang.Object pObject) Apply to the object the active properties of the keyframe.
void	apply(IScene pScene, java.lang.Object pObject) Apply to the object the active properties of the keyframe.
void	apply(ISceneViewer pViewer, boolean bAnimate, double animDuration) Applies bookmark to given viewer.
void	assign(IClone src) Assigns the properties of src to the receiver.
void	capture(ICamera pCamera) Copies bookmark properties from given camera.
void	captureProperties(IAGAnimationContainer pContainer, java.lang.Object pObject) Copy the properties from the object to the keyframe.
void	captureProperties(IScene pScene, java.lang.Object pObject) Copy the properties from the object to the keyframe.
IKeyframe	convertToKeyframe() Create a Camera keyframe based on bookmark properties.
boolean	equals(java.lang.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.
IAnimationType	getAnimationType() The animation type.
IAGKeyframe	getAsIAGKeyframe() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IBookmark3D	getAsIBookmark3D() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IBookmarkToKeyframe	getAsIBookmarkToKeyframe() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IClone	getAsIClone() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IKeyframe	getAsIKeyframe() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStream	getAsIPersistStream() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	getClsid()
java.lang.String	getName() The name of the 3D bookmark.
java.lang.Object	getPropertyValue(int propIndex) The value of a typed property.
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.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) Supported Platforms
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, 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]).
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.
void	isDirty() Supported Platforms
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.
boolean	isPropertyValueBoolean(int propIndex) Indicates if the property is TRUE.
void	load(IStream pstm) Supported Platforms
void	refreshObject(IAGAnimationTrack pTrack, IAGAnimationContainer pContainer, java.lang.Object pObject) Recreates the object after its properties have been interpolated.
void	refreshObject(IScene pScene, java.lang.Object pObject) Recreates the object after its properties have been interpolated.
void	save(IStream pstm, int fClearDirty) Supported Platforms
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 3D bookmark.
void	setPropertyValue(int propIndex, java.lang.Object pValue) The value of a typed property.
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 java.lang.Object

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

Constructor Detail

Bookmark3D

public Bookmark3D()
           throws java.io.IOException,
                  java.net.UnknownHostException

Constructs a Bookmark3D using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

Bookmark3D

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a Bookmark3D using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to Bookmark3D.
Bookmark3D theBookmark3D = (Bookmark3D) obj;

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIBookmark3D

public IBookmark3D getAsIBookmark3D()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIKeyframe

public IKeyframe getAsIKeyframe()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIAGKeyframe

public IAGKeyframe getAsIAGKeyframe()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIBookmarkToKeyframe

public IBookmarkToKeyframe getAsIBookmarkToKeyframe()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIClone

public IClone getAsIClone()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getName

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

Description copied from interface: IBookmark3D

The name of the 3D bookmark.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IBookmark3D

Returns:

The name

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setName

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

Description copied from interface: IBookmark3D

The name of the 3D bookmark.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IBookmark3D

Parameters:

name - The name (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

capture

public void capture(ICamera pCamera)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IBookmark3D

Copies bookmark properties from given camera.

Supported Platforms

Windows, Solaris, Linux

Specified by:

capture in interface IBookmark3D

Parameters:

pCamera - A reference to a com.esri.arcgis.analyst3d.ICamera (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

apply

public void apply(ISceneViewer pViewer,
                  boolean bAnimate,
                  double animDuration)
           throws java.io.IOException,
                  AutomationException

Description copied from interface: IBookmark3D

Applies bookmark to given viewer.

Supported Platforms

Windows, Solaris, Linux

Specified by:

apply in interface IBookmark3D

Parameters:

pViewer - A reference to a com.esri.arcgis.analyst3d.ISceneViewer (in)

bAnimate - The bAnimate (in)

animDuration - The animDuration (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

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.

getPropertyValue

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

Description copied from interface: IAGKeyframe

The value of a typed property.

Remarks

This property returns the animated object property value at a given index. You need to know the property names, indexes and types in an animation keyframe in order to access the property values. You can get such information through the help for the interface IAGAnimationType.

Specified by:

getPropertyValue in interface IAGKeyframe

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

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

Description copied from interface: IAGKeyframe

The value of a typed property.

Specified by:

setPropertyValue in interface IAGKeyframe

Parameters:

propIndex - The propIndex (in)

pValue - A Variant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

IAGKeyframe_getAnimationType

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

Description copied from interface: IAGKeyframe

The animation type.

Specified by:

IAGKeyframe_getAnimationType in interface IAGKeyframe

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

apply

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

Description copied from interface: IAGKeyframe

Apply to the object the active properties of the keyframe.

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:

AutomationException - If the ArcObject component throws an exception.

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

captureProperties

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

Description copied from interface: IAGKeyframe

Copy the properties from the object to the keyframe.

Specified by:

captureProperties in interface IAGKeyframe

Parameters:

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

pObject - A Variant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

interpolate

public 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

Description copied from interface: IAGKeyframe

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

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:

AutomationException - If the ArcObject component throws an exception.

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

refreshObject

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

Description copied from interface: IAGKeyframe

Recreates the object after its properties have been interpolated.

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:

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

AutomationException - If the ArcObject component throws an exception.

convertToKeyframe

public IKeyframe convertToKeyframe()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IBookmarkToKeyframe

Create a Camera keyframe based on bookmark properties.

Supported Platforms

Windows, Solaris, Linux

Specified by:

convertToKeyframe in interface IBookmarkToKeyframe

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IClone

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IClone

Assigns the properties of src to the receiver.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IClone

Returns TRUE when the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IClone

Returns TRUE when the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

AutomationException - If the ArcObject component throws an exception.

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