Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.animation
Interface IAGImportPathOptions

All Superinterfaces:
Serializable
All Known Implementing Classes:
AGImportPathOptions
public interface IAGImportPathOptions
extends Serializable

Provides access to options of the 'import animation from path' functionality.

Remarks

An AGImportPathOptions object must be specified when creating a fly-by-from-path animation. The IAGImportPathOptions interface provides access to the options in creating a fly-by-from-path animation.

Product Availability

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

Method Summary
 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.
 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.
 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.
 

Method Detail

getBasicMap

IBasicMap getBasicMap()
                      throws IOException,
                             AutomationException
The basic map.

Product Availability

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

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

void setBasicMapByRef(IBasicMap ppMap)
                      throws IOException,
                             AutomationException
The basic map.

Product Availability

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

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

IAGAnimationTracks getAnimationTracks()
                                      throws IOException,
                                             AutomationException
The animation track container.

Product Availability

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

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

void setAnimationTracksByRef(IAGAnimationTracks ppTracks)
                             throws IOException,
                                    AutomationException
The animation track container.

Product Availability

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

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

IAGAnimationEnvironment getAnimationEnvironment()
                                                throws IOException,
                                                       AutomationException
The animation environment.

Product Availability

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

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

void setAnimationEnvironmentByRef(IAGAnimationEnvironment ppEnvironment)
                                  throws IOException,
                                         AutomationException
The animation environment.

Product Availability

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

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

IAGAnimationType getAnimationType()
                                  throws IOException,
                                         AutomationException
The type of animation.

Product Availability

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

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

void setAnimationTypeByRef(IAGAnimationType ppAnimType)
                           throws IOException,
                                  AutomationException
The type of animation.

Product Availability

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

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

IGeometry getPathGeometry()
                          throws IOException,
                                 AutomationException
The original path geometry.

Product Availability

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

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

void setPathGeometry(IGeometry ppPathGeometry)
                     throws IOException,
                            AutomationException
The original path geometry.

Product Availability

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

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

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.

Returns:
The pElevOffsetMeters
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVerticalOffset

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.

Parameters:
pElevOffsetMeters - The pElevOffsetMeters (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnimatedObject

Object getAnimatedObject()
                         throws IOException,
                                AutomationException
The object to be animated (if any).

Product Availability

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

Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnimatedObjectByRef

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.

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

int getConversionType()
                      throws IOException,
                             AutomationException
The type of import conversion.

Product Availability

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

Returns:
A com.esri.arcgis.animation.esriFlyFromPathType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setConversionType

void setConversionType(int pConversionType)
                       throws IOException,
                              AutomationException
The type of import conversion.

Product Availability

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

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

boolean isReversePath()
                      throws IOException,
                             AutomationException
Indicates whether to reverse the path.

Product Availability

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

Returns:
The pbReverse
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReversePath

void setReversePath(boolean pbReverse)
                    throws IOException,
                           AutomationException
Indicates whether to reverse the path.

Product Availability

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

Parameters:
pbReverse - The pbReverse (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSimplificationFactor

double getSimplificationFactor()
                               throws IOException,
                                      AutomationException
The path simplification factor (0.0-100.0).

Product Availability

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

Returns:
The pSimplFactor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSimplificationFactor

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.

Parameters:
pSimplFactor - The pSimplFactor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLookaheadFactor

double getLookaheadFactor()
                          throws IOException,
                                 AutomationException
The lookahead factor (0.0-1.0).

Product Availability

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

Returns:
The pLookaheadFactor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLookaheadFactor

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.

Parameters:
pLookaheadFactor - The pLookaheadFactor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAngleCalculationMethods

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.

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

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.

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

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.

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

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.

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

double getRollFactor()
                     throws IOException,
                            AutomationException
The roll factor.

Product Availability

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

Returns:
The pRollFactor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRollFactor

void setRollFactor(double pRollFactor)
                   throws IOException,
                          AutomationException
The roll factor.

Product Availability

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

Parameters:
pRollFactor - The pRollFactor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isOverwriteExisting

boolean isOverwriteExisting()
                            throws IOException,
                                   AutomationException
Indicates whether to overwrite option.

Product Availability

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

Returns:
The pbOverwrite
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOverwriteExisting

void setOverwriteExisting(boolean pbOverwrite)
                          throws IOException,
                                 AutomationException
Indicates whether to overwrite option.

Product Availability

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

Parameters:
pbOverwrite - The pbOverwrite (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTrackName

String getTrackName()
                    throws IOException,
                           AutomationException
The name of the track to be created.

Product Availability

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

Returns:
The pTrackName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTrackName

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.

Parameters:
pTrackName - The pTrackName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD