com.esri.arcgis.animation
Class AGImportPathOptions

java.lang.Object
  extended bycom.esri.arcgis.animation.AGImportPathOptions
All Implemented Interfaces:
IAGImportPathOptions, java.io.Serializable

public class AGImportPathOptions
extends java.lang.Object
implements 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(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
 
Method Summary
 boolean equals(java.lang.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).
 java.lang.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.
 IAGImportPathOptions getAsIAGImportPathOptions()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IBasicMap getBasicMap()
          The basic map.
static java.lang.String 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).
 java.lang.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()
          The overwriting option.
 boolean isReversePath()
          The option 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(java.lang.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)
          The overwriting option.
 void setPathGeometry(IGeometry ppPathGeometry)
          The original path geometry.
 void setReversePath(boolean pbReverse)
          The option 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(java.lang.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
 

Constructor Detail

AGImportPathOptions

public AGImportPathOptions()
                    throws java.io.IOException,
                           java.net.UnknownHostException
Constructs a AGImportPathOptions using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

AGImportPathOptions

public AGImportPathOptions(java.lang.Object obj)
                    throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

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.
AGImportPathOptions theAGImportPathOptions = (AGImportPathOptions) 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()

getAsIAGImportPathOptions

public IAGImportPathOptions getAsIAGImportPathOptions()
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


getBasicMap

public IBasicMap getBasicMap()
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IAGImportPathOptions
The basic map.

Specified by:
getBasicMap in interface IAGImportPathOptions
Returns:
A reference to a com.esri.arcgis.carto.IBasicMap
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBasicMapByRef

public void setBasicMapByRef(IBasicMap ppMap)
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IAGImportPathOptions
The basic map.

Specified by:
setBasicMapByRef in interface IAGImportPathOptions
Parameters:
ppMap - A reference to a com.esri.arcgis.carto.IBasicMap (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnimationTracks

public IAGAnimationTracks getAnimationTracks()
                                      throws java.io.IOException,
                                             AutomationException
Description copied from interface: IAGImportPathOptions
The animation track container.

Specified by:
getAnimationTracks in interface IAGImportPathOptions
Returns:
A reference to a com.esri.arcgis.animation.IAGAnimationTracks
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnimationTracksByRef

public void setAnimationTracksByRef(IAGAnimationTracks ppTracks)
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: IAGImportPathOptions
The animation track container.

Specified by:
setAnimationTracksByRef in interface IAGImportPathOptions
Parameters:
ppTracks - A reference to a com.esri.arcgis.animation.IAGAnimationTracks (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getAnimationEnvironment

public IAGAnimationEnvironment getAnimationEnvironment()
                                                throws java.io.IOException,
                                                       AutomationException
Description copied from interface: IAGImportPathOptions
The animation environment.

Specified by:
getAnimationEnvironment in interface IAGImportPathOptions
Returns:
A reference to a com.esri.arcgis.animation.IAGAnimationEnvironment
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setAnimationEnvironmentByRef

public void setAnimationEnvironmentByRef(IAGAnimationEnvironment ppEnvironment)
                                  throws java.io.IOException,
                                         AutomationException
Description copied from interface: IAGImportPathOptions
The animation environment.

Specified by:
setAnimationEnvironmentByRef in interface IAGImportPathOptions
Parameters:
ppEnvironment - A reference to a com.esri.arcgis.animation.IAGAnimationEnvironment (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnimationType

public IAGAnimationType getAnimationType()
                                  throws java.io.IOException,
                                         AutomationException
Description copied from interface: IAGImportPathOptions
The type of animation.

Specified by:
getAnimationType in interface IAGImportPathOptions
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.

setAnimationTypeByRef

public void setAnimationTypeByRef(IAGAnimationType ppAnimType)
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: IAGImportPathOptions
The type of animation.

Specified by:
setAnimationTypeByRef in interface IAGImportPathOptions
Parameters:
ppAnimType - A reference to a com.esri.arcgis.animation.IAGAnimationType (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getPathGeometry

public IGeometry getPathGeometry()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IAGImportPathOptions
The original path geometry.

Specified by:
getPathGeometry in interface IAGImportPathOptions
Returns:
A reference to a com.esri.arcgis.geometry.IGeometry
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setPathGeometry

public void setPathGeometry(IGeometry ppPathGeometry)
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: IAGImportPathOptions
The original path geometry.

Specified by:
setPathGeometry in interface IAGImportPathOptions
Parameters:
ppPathGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getVerticalOffset

public double getVerticalOffset()
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IAGImportPathOptions
The vertical offset in meters to be applied to the path geometry.

Specified by:
getVerticalOffset in interface IAGImportPathOptions
Returns:
The pElevOffsetMeters
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVerticalOffset

public void setVerticalOffset(double pElevOffsetMeters)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IAGImportPathOptions
The vertical offset in meters to be applied to the path geometry.

Specified by:
setVerticalOffset in interface IAGImportPathOptions
Parameters:
pElevOffsetMeters - The pElevOffsetMeters (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnimatedObject

public java.lang.Object getAnimatedObject()
                                   throws java.io.IOException,
                                          AutomationException
Description copied from interface: IAGImportPathOptions
The object to be animated (if any).

Specified by:
getAnimatedObject in interface IAGImportPathOptions
Returns:
A reference to another Object (IUnknown)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnimatedObjectByRef

public void setAnimatedObjectByRef(java.lang.Object ppAnimObj)
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: IAGImportPathOptions
The object to be animated (if any).

Specified by:
setAnimatedObjectByRef in interface IAGImportPathOptions
Parameters:
ppAnimObj - A reference to another Object (IUnknown) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getConversionType

public int getConversionType()
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IAGImportPathOptions
The type of import conversion.

Specified by:
getConversionType in interface IAGImportPathOptions
Returns:
A com.esri.arcgis.animation.esriFlyFromPathType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setConversionType

public void setConversionType(int pConversionType)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IAGImportPathOptions
The type of import conversion.

Specified by:
setConversionType in interface IAGImportPathOptions
Parameters:
pConversionType - A com.esri.arcgis.animation.esriFlyFromPathType constant (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isReversePath

public boolean isReversePath()
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IAGImportPathOptions
The option to reverse the path.

Specified by:
isReversePath in interface IAGImportPathOptions
Returns:
The pbReverse
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setReversePath

public void setReversePath(boolean pbReverse)
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: IAGImportPathOptions
The option to reverse the path.

Specified by:
setReversePath in interface IAGImportPathOptions
Parameters:
pbReverse - The pbReverse (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSimplificationFactor

public double getSimplificationFactor()
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: IAGImportPathOptions
The path simplification factor (0.0-100.0).

Specified by:
getSimplificationFactor in interface IAGImportPathOptions
Returns:
The pSimplFactor
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setSimplificationFactor

public void setSimplificationFactor(double pSimplFactor)
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: IAGImportPathOptions
The path simplification factor (0.0-100.0).

Specified by:
setSimplificationFactor in interface IAGImportPathOptions
Parameters:
pSimplFactor - The pSimplFactor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLookaheadFactor

public double getLookaheadFactor()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IAGImportPathOptions
The lookahead factor (0.0-1.0).

Specified by:
getLookaheadFactor in interface IAGImportPathOptions
Returns:
The pLookaheadFactor
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setLookaheadFactor

public void setLookaheadFactor(double pLookaheadFactor)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IAGImportPathOptions
The lookahead factor (0.0-1.0).

Specified by:
setLookaheadFactor in interface IAGImportPathOptions
Parameters:
pLookaheadFactor - The pLookaheadFactor (in)
Throws:
java.io.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 java.io.IOException,
                                       AutomationException
Description copied from interface: IAGImportPathOptions
The options for angle calculation.

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:
java.io.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 java.io.IOException,
                                       AutomationException
Description copied from interface: IAGImportPathOptions
The options for angle calculation.

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:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getAngleCalculationValues

public void getAngleCalculationValues(double[] pAzimuthValue,
                                      double[] pInclinationValue,
                                      double[] pRollValue)
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: IAGImportPathOptions
The values for angle calculation (angles in degrees).

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:
java.io.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 java.io.IOException,
                                      AutomationException
Description copied from interface: IAGImportPathOptions
The values for angle calculation (angles in degrees).

Specified by:
putAngleCalculationValues in interface IAGImportPathOptions
Parameters:
azimuthValue - The azimuthValue (in)
inclinationValue - The inclinationValue (in)
rollValue - The rollValue (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getRollFactor

public double getRollFactor()
                     throws java.io.IOException,
                            AutomationException
Description copied from interface: IAGImportPathOptions
The roll factor.

Specified by:
getRollFactor in interface IAGImportPathOptions
Returns:
The pRollFactor
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setRollFactor

public void setRollFactor(double pRollFactor)
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: IAGImportPathOptions
The roll factor.

Specified by:
setRollFactor in interface IAGImportPathOptions
Parameters:
pRollFactor - The pRollFactor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isOverwriteExisting

public boolean isOverwriteExisting()
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: IAGImportPathOptions
The overwriting option.

Specified by:
isOverwriteExisting in interface IAGImportPathOptions
Returns:
The pbOverwrite
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOverwriteExisting

public void setOverwriteExisting(boolean pbOverwrite)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IAGImportPathOptions
The overwriting option.

Specified by:
setOverwriteExisting in interface IAGImportPathOptions
Parameters:
pbOverwrite - The pbOverwrite (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getTrackName

public java.lang.String getTrackName()
                              throws java.io.IOException,
                                     AutomationException
Description copied from interface: IAGImportPathOptions
The name of the track to be created.

Specified by:
getTrackName in interface IAGImportPathOptions
Returns:
The pTrackName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTrackName

public void setTrackName(java.lang.String pTrackName)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IAGImportPathOptions
The name of the track to be created.

Specified by:
setTrackName in interface IAGImportPathOptions
Parameters:
pTrackName - The pTrackName (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.