com.esri.arcgis.animation
Class AGImportPathOptions

java.lang.Object
  com.esri.arcgis.animation.AGImportPathOptions

All Implemented Interfaces:

IAGImportPathOptions, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class AGImportPathOptions
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAGImportPathOptions

Options of the 'import animation from path' functionality.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

AGImportPathOptions()
Constructs a AGImportPathOptions using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
void	getAngleCalculationMethods(int[] pAzimuthMethod, int[] pInclinationMethod, int[] pRollMethod) The options for angle calculation.
void	getAngleCalculationValues(double[] pAzimuthValue, double[] pInclinationValue, double[] pRollValue) The values for angle calculation (angles in degrees).
Object	getAnimatedObject() The object to be animated (if any).
IAGAnimationEnvironment	getAnimationEnvironment() The animation environment.
IAGAnimationTracks	getAnimationTracks() The animation track container.
IAGAnimationType	getAnimationType() The type of animation.
IBasicMap	getBasicMap() The basic map.
static String	getClsid() getClsid.
int	getConversionType() The type of import conversion.
double	getLookaheadFactor() The lookahead factor (0.0-1.0).
IGeometry	getPathGeometry() The original path geometry.
double	getRollFactor() The roll factor.
double	getSimplificationFactor() The path simplification factor (0.0-100.0).
String	getTrackName() The name of the track to be created.
double	getVerticalOffset() The vertical offset in meters to be applied to the path geometry.
int	hashCode() the hashcode for this object
boolean	isOverwriteExisting() Indicates whether to overwrite option.
boolean	isReversePath() Indicates whether to reverse the path.
void	putAngleCalculationMethods(int azimuthMethod, int inclinationMethod, int rollMethod) The options for angle calculation.
void	putAngleCalculationValues(double azimuthValue, double inclinationValue, double rollValue) The values for angle calculation (angles in degrees).
void	setAnimatedObjectByRef(Object ppAnimObj) The object to be animated (if any).
void	setAnimationEnvironmentByRef(IAGAnimationEnvironment ppEnvironment) The animation environment.
void	setAnimationTracksByRef(IAGAnimationTracks ppTracks) The animation track container.
void	setAnimationTypeByRef(IAGAnimationType ppAnimType) The type of animation.
void	setBasicMapByRef(IBasicMap ppMap) The basic map.
void	setConversionType(int pConversionType) The type of import conversion.
void	setLookaheadFactor(double pLookaheadFactor) The lookahead factor (0.0-1.0).
void	setOverwriteExisting(boolean pbOverwrite) Indicates whether to overwrite option.
void	setPathGeometry(IGeometry ppPathGeometry) The original path geometry.
void	setReversePath(boolean pbReverse) Indicates whether to reverse the path.
void	setRollFactor(double pRollFactor) The roll factor.
void	setSimplificationFactor(double pSimplFactor) The path simplification factor (0.0-100.0).
void	setTrackName(String pTrackName) The name of the track to be created.
void	setVerticalOffset(double pElevOffsetMeters) The vertical offset in meters to be applied to the path geometry.

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

AGImportPathOptions

public AGImportPathOptions()
                    throws IOException,
                           UnknownHostException

Constructs a AGImportPathOptions using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

AGImportPathOptions

public AGImportPathOptions(Object obj)
                    throws IOException

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

Construct a AGImportPathOptions using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AGImportPathOptions.

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

getBasicMap

public IBasicMap getBasicMap()
                      throws IOException,
                             AutomationException

The basic map.

Product Availability

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

Specified by:

getBasicMap in interface IAGImportPathOptions

Returns:

A reference to a com.esri.arcgis.carto.IBasicMap

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBasicMapByRef

public void setBasicMapByRef(IBasicMap ppMap)
                      throws IOException,
                             AutomationException

The basic map.

Product Availability

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

Specified by:

setBasicMapByRef in interface IAGImportPathOptions

Parameters:

ppMap - A reference to a com.esri.arcgis.carto.IBasicMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAnimationTracks

public IAGAnimationTracks getAnimationTracks()
                                      throws IOException,
                                             AutomationException

The animation track container.

Product Availability

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

Specified by:

getAnimationTracks in interface IAGImportPathOptions

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAnimationTracksByRef

public void setAnimationTracksByRef(IAGAnimationTracks ppTracks)
                             throws IOException,
                                    AutomationException

The animation track container.

Product Availability

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

Specified by:

setAnimationTracksByRef in interface IAGImportPathOptions

Parameters:

ppTracks - A reference to a com.esri.arcgis.animation.IAGAnimationTracks (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAnimationEnvironment

public IAGAnimationEnvironment getAnimationEnvironment()
                                                throws IOException,
                                                       AutomationException

The animation environment.

Product Availability

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

Specified by:

getAnimationEnvironment in interface IAGImportPathOptions

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAnimationEnvironmentByRef

public void setAnimationEnvironmentByRef(IAGAnimationEnvironment ppEnvironment)
                                  throws IOException,
                                         AutomationException

The animation environment.

Product Availability

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

Specified by:

setAnimationEnvironmentByRef in interface IAGImportPathOptions

Parameters:

ppEnvironment - A reference to a com.esri.arcgis.animation.IAGAnimationEnvironment (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAnimationType

public IAGAnimationType getAnimationType()
                                  throws IOException,
                                         AutomationException

The type of animation.

Product Availability

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

Specified by:

getAnimationType in interface IAGImportPathOptions

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.

setAnimationTypeByRef

public void setAnimationTypeByRef(IAGAnimationType ppAnimType)
                           throws IOException,
                                  AutomationException

The type of animation.

Product Availability

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

Specified by:

setAnimationTypeByRef in interface IAGImportPathOptions

Parameters:

ppAnimType - A reference to a com.esri.arcgis.animation.IAGAnimationType (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPathGeometry

public IGeometry getPathGeometry()
                          throws IOException,
                                 AutomationException

The original path geometry.

Product Availability

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

Specified by:

getPathGeometry in interface IAGImportPathOptions

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPathGeometry

public void setPathGeometry(IGeometry ppPathGeometry)
                     throws IOException,
                            AutomationException

The original path geometry.

Product Availability

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

Specified by:

setPathGeometry in interface IAGImportPathOptions

Parameters:

ppPathGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVerticalOffset

public double getVerticalOffset()
                         throws IOException,
                                AutomationException

The vertical offset in meters to be applied to the path geometry.

Product Availability

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

Specified by:

getVerticalOffset in interface IAGImportPathOptions

Returns:

The pElevOffsetMeters

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVerticalOffset

public void setVerticalOffset(double pElevOffsetMeters)
                       throws IOException,
                              AutomationException

The vertical offset in meters to be applied to the path geometry.

Product Availability

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

Specified by:

setVerticalOffset in interface IAGImportPathOptions

Parameters:

pElevOffsetMeters - The pElevOffsetMeters (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAnimatedObject

public Object getAnimatedObject()
                         throws IOException,
                                AutomationException

The object to be animated (if any).

Product Availability

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

Specified by:

getAnimatedObject in interface IAGImportPathOptions

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAnimatedObjectByRef

public void setAnimatedObjectByRef(Object ppAnimObj)
                            throws IOException,
                                   AutomationException

The object to be animated (if any).

Product Availability

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

Specified by:

setAnimatedObjectByRef in interface IAGImportPathOptions

Parameters:

ppAnimObj - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConversionType

public int getConversionType()
                      throws IOException,
                             AutomationException

The type of import conversion.

Product Availability

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

Specified by:

getConversionType in interface IAGImportPathOptions

Returns:

A com.esri.arcgis.animation.esriFlyFromPathType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConversionType

public void setConversionType(int pConversionType)
                       throws IOException,
                              AutomationException

The type of import conversion.

Product Availability

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

Specified by:

setConversionType in interface IAGImportPathOptions

Parameters:

pConversionType - A com.esri.arcgis.animation.esriFlyFromPathType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReversePath

public boolean isReversePath()
                      throws IOException,
                             AutomationException

Indicates whether to reverse the path.

Product Availability

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

Specified by:

isReversePath in interface IAGImportPathOptions

Returns:

The pbReverse

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReversePath

public void setReversePath(boolean pbReverse)
                    throws IOException,
                           AutomationException

Indicates whether to reverse the path.

Product Availability

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

Specified by:

setReversePath in interface IAGImportPathOptions

Parameters:

pbReverse - The pbReverse (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSimplificationFactor

public double getSimplificationFactor()
                               throws IOException,
                                      AutomationException

The path simplification factor (0.0-100.0).

Product Availability

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

Specified by:

getSimplificationFactor in interface IAGImportPathOptions

Returns:

The pSimplFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSimplificationFactor

public void setSimplificationFactor(double pSimplFactor)
                             throws IOException,
                                    AutomationException

The path simplification factor (0.0-100.0).

Product Availability

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

Specified by:

setSimplificationFactor in interface IAGImportPathOptions

Parameters:

pSimplFactor - The pSimplFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLookaheadFactor

public double getLookaheadFactor()
                          throws IOException,
                                 AutomationException

The lookahead factor (0.0-1.0).

Product Availability

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

Specified by:

getLookaheadFactor in interface IAGImportPathOptions

Returns:

The pLookaheadFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLookaheadFactor

public void setLookaheadFactor(double pLookaheadFactor)
                        throws IOException,
                               AutomationException

The lookahead factor (0.0-1.0).

Product Availability

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

Specified by:

setLookaheadFactor in interface IAGImportPathOptions

Parameters:

pLookaheadFactor - The pLookaheadFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAngleCalculationMethods

public void getAngleCalculationMethods(int[] pAzimuthMethod,
                                       int[] pInclinationMethod,
                                       int[] pRollMethod)
                                throws IOException,
                                       AutomationException

The options for angle calculation.

Product Availability

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

Specified by:

getAngleCalculationMethods in interface IAGImportPathOptions

Parameters:

pAzimuthMethod - A com.esri.arcgis.animation.esriPathAngleCalculation constant (out: use single element array)

pInclinationMethod - A com.esri.arcgis.animation.esriPathAngleCalculation constant (out: use single element array)

pRollMethod - A com.esri.arcgis.animation.esriPathAngleCalculation constant (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putAngleCalculationMethods

public void putAngleCalculationMethods(int azimuthMethod,
                                       int inclinationMethod,
                                       int rollMethod)
                                throws IOException,
                                       AutomationException

The options for angle calculation.

Product Availability

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

Specified by:

putAngleCalculationMethods in interface IAGImportPathOptions

Parameters:

azimuthMethod - A com.esri.arcgis.animation.esriPathAngleCalculation constant (in)

inclinationMethod - A com.esri.arcgis.animation.esriPathAngleCalculation constant (in)

rollMethod - A com.esri.arcgis.animation.esriPathAngleCalculation constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAngleCalculationValues

public void getAngleCalculationValues(double[] pAzimuthValue,
                                      double[] pInclinationValue,
                                      double[] pRollValue)
                               throws IOException,
                                      AutomationException

The values for angle calculation (angles in degrees).

Product Availability

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

Specified by:

getAngleCalculationValues in interface IAGImportPathOptions

Parameters:

pAzimuthValue - The pAzimuthValue (out: use single element array)

pInclinationValue - The pInclinationValue (out: use single element array)

pRollValue - The pRollValue (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putAngleCalculationValues

public void putAngleCalculationValues(double azimuthValue,
                                      double inclinationValue,
                                      double rollValue)
                               throws IOException,
                                      AutomationException

The values for angle calculation (angles in degrees).

Product Availability

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

Specified by:

putAngleCalculationValues in interface IAGImportPathOptions

Parameters:

azimuthValue - The azimuthValue (in)

inclinationValue - The inclinationValue (in)

rollValue - The rollValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRollFactor

public double getRollFactor()
                     throws IOException,
                            AutomationException

The roll factor.

Product Availability

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

Specified by:

getRollFactor in interface IAGImportPathOptions

Returns:

The pRollFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRollFactor

public void setRollFactor(double pRollFactor)
                   throws IOException,
                          AutomationException

The roll factor.

Product Availability

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

Specified by:

setRollFactor in interface IAGImportPathOptions

Parameters:

pRollFactor - The pRollFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOverwriteExisting

public boolean isOverwriteExisting()
                            throws IOException,
                                   AutomationException

Indicates whether to overwrite option.

Product Availability

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

Specified by:

isOverwriteExisting in interface IAGImportPathOptions

Returns:

The pbOverwrite

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOverwriteExisting

public void setOverwriteExisting(boolean pbOverwrite)
                          throws IOException,
                                 AutomationException

Indicates whether to overwrite option.

Product Availability

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

Specified by:

setOverwriteExisting in interface IAGImportPathOptions

Parameters:

pbOverwrite - The pbOverwrite (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTrackName

public String getTrackName()
                    throws IOException,
                           AutomationException

The name of the track to be created.

Product Availability

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

Specified by:

getTrackName in interface IAGImportPathOptions

Returns:

The pTrackName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTrackName

public void setTrackName(String pTrackName)
                  throws IOException,
                         AutomationException

The name of the track to be created.

Product Availability

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

Specified by:

setTrackName in interface IAGImportPathOptions

Parameters:

pTrackName - The pTrackName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.