com.esri.arcgis.analyst3d
Class Bookmark3D

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

All Implemented Interfaces:

IBookmark3D, IBookmarkToKeyframe, IKeyframe, IAGKeyframe, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, Externalizable, Serializable

public class Bookmark3D
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IBookmark3D, IKeyframe, IAGKeyframe, IBookmarkToKeyframe, IPersistStream, IClone, Externalizable

The 3D bookmark coclass.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

Bookmark3D()
Constructs a Bookmark3D using ArcGIS Engine.

Bookmark3D(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Bookmark3D theBookmark3D = (Bookmark3D) obj;

Method Summary

void	apply(IAGAnimationTrack pTrack, IAGAnimationContainer pContainer, Object pObject) Apply to the object the active properties of the keyframe.
void	apply(IScene pScene, 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, Object pObject) Copy the properties from the object to the keyframe.
void	captureProperties(IScene pScene, Object pObject) Copy the properties from the object to the keyframe.
IKeyframe	convertToKeyframe() Create a Camera keyframe based on bookmark properties.
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.
IAnimationType	getAnimationType() The animation type.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
String	getName() The name of the 3D bookmark.
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) getSizeMax
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]).
void	interpolate(IScene pScene, 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() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if 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) load
void	readExternal(ObjectInput in)
void	refreshObject(IAGAnimationTrack pTrack, IAGAnimationContainer pContainer, Object pObject) Recreates the object after its properties have been interpolated.
void	refreshObject(IScene pScene, Object pObject) Recreates the object after its properties have been interpolated.
void	save(IStream pstm, int fClearDirty) save
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 3D bookmark.
void	setPropertyValue(int propIndex, 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).
void	writeExternal(ObjectOutput out)

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

Bookmark3D

public Bookmark3D()
           throws IOException,
                  UnknownHostException

Constructs a Bookmark3D using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

Bookmark3D

public Bookmark3D(Object obj)
           throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Bookmark3D theBookmark3D = (Bookmark3D) obj;

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.

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 3D bookmark.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IBookmark3D

Specified by:

getName in interface IKeyframe

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 3D bookmark.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IBookmark3D

Specified by:

setName in interface IKeyframe

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.

capture

public void capture(ICamera pCamera)
             throws IOException,
                    AutomationException

Copies bookmark properties from given camera.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

capture in interface IBookmark3D

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

apply

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

Applies bookmark to given viewer.

Product Availability

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

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:

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. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getActiveProperties in interface IKeyframe

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. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setActiveProperties in interface IKeyframe

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. Requires 3D Analyst Extension.

Specified by:

isActiveProperty in interface IKeyframe

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. Requires 3D Analyst Extension.

Specified by:

setIsActiveProperty in interface IKeyframe

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.

getPropertyValueInt

public int getPropertyValueInt(int propIndex)
                        throws IOException,
                               AutomationException

The value of an integer typed property.

Product Availability

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

Specified by:

getPropertyValueInt in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

Returns:

The pIntValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropertyValueLong

public int getPropertyValueLong(int propIndex)
                         throws IOException,
                                AutomationException

The value of a long integer typed property.

Product Availability

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

Specified by:

getPropertyValueLong in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

Returns:

The pLongValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropertyValueDouble

public double getPropertyValueDouble(int propIndex)
                              throws IOException,
                                     AutomationException

The value of a double-typed property.

Product Availability

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

Specified by:

getPropertyValueDouble in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

Returns:

The pDoubleValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPropertyValueBoolean

public boolean isPropertyValueBoolean(int propIndex)
                               throws IOException,
                                      AutomationException

Indicates if the property is TRUE.

Product Availability

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

Specified by:

isPropertyValueBoolean in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

Returns:

The pBoolValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropertyValuePoint

public IPoint getPropertyValuePoint(int propIndex)
                             throws IOException,
                                    AutomationException

The value of a Point-typed property.

Product Availability

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

Specified by:

getPropertyValuePoint in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropertyValueExtent

public IEnvelope getPropertyValueExtent(int propIndex)
                                 throws IOException,
                                        AutomationException

The value of an Extent-typed property.

Product Availability

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

Specified by:

getPropertyValueExtent in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropertyValueRGBColor

public IColor getPropertyValueRGBColor(int propIndex)
                                throws IOException,
                                       AutomationException

The value of an RGB Color-typed property.

Product Availability

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

Specified by:

getPropertyValueRGBColor in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPropertyValueInt

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

The value of an integer typed property.

Product Availability

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

Specified by:

setPropertyValueInt in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

pIntValue - The pIntValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPropertyValueLong

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

The value of a long integer typed property.

Product Availability

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

Specified by:

setPropertyValueLong in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

pLongValue - The pLongValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPropertyValueDouble

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

The value of a double-typed property.

Product Availability

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

Specified by:

setPropertyValueDouble in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

pDoubleValue - The pDoubleValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPropertyValueBoolean

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

Indicates if the property is TRUE.

Product Availability

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

Specified by:

setPropertyValueBoolean in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

pBoolValue - The pBoolValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPropertyValuePoint

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

The value of a Point-typed property.

Product Availability

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

Specified by:

setPropertyValuePoint in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPropertyValueExtent

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

The value of an Extent-typed property.

Product Availability

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

Specified by:

setPropertyValueExtent in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPropertyValueRGBColor

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

The value of an RGB Color-typed property.

Product Availability

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

Specified by:

setPropertyValueRGBColor in interface IKeyframe

Parameters:

propIndex - The propIndex (in)

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTimeStamp in interface IKeyframe

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. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTimeStamp in interface IKeyframe

Specified by:

getTimeStamp in interface IAGKeyframe

Returns:

The pTimeStamp

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAnimationType

public IAnimationType getAnimationType()
                                throws IOException,
                                       AutomationException

The animation type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAnimationType in interface IKeyframe

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

apply

public void apply(IScene pScene,
                  Object pObject)
           throws IOException,
                  AutomationException

Apply to the object the active properties of the keyframe.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

apply in interface IKeyframe

Parameters:

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

pObject - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

captureProperties

public void captureProperties(IScene pScene,
                              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. Requires 3D Analyst Extension.

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interpolate

public void interpolate(IScene pScene,
                        Object pObject,
                        int propertyIndex,
                        double time,
                        IKeyframe pNextKeyframe,
                        IKeyframe pPrevKeyframe,
                        IKeyframe 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. Requires 3D Analyst Extension.

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:

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. Requires 3D Analyst Extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isObjectNeedsRefresh in interface IKeyframe

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(IScene pScene,
                          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. Requires 3D Analyst Extension.

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:

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.

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.

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.

convertToKeyframe

public IKeyframe convertToKeyframe()
                            throws IOException,
                                   AutomationException

Create a Camera keyframe based on bookmark properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

convertToKeyframe in interface IBookmarkToKeyframe

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

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

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

Indicates if 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

Indicates if 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.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException