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:
java.io.Serializable
All Known Implementing Classes:
AGImportPathOptions, IAGImportPathOptionsProxy
public interface IAGImportPathOptions
extends java.io.Serializable

COM Interface 'IAGImportPathOptions'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esriAnimation.olb'

Description: 'Provides access to options of the 'import animation from path' functionality.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDa5f484f6_9e72_4a6b_9464_e6f7be897b13
           
static int xxDummy
          Deprecated. Internal use only
 
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).
 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.
 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).
 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.
 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(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)
          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(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.
 

Field Detail

IIDa5f484f6_9e72_4a6b_9464_e6f7be897b13

static final int IIDa5f484f6_9e72_4a6b_9464_e6f7be897b13
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getBasicMap

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

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

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

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

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

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

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

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

getAnimationEnvironment

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

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

setAnimationEnvironmentByRef

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

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

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

Returns:
A reference to a com.esri.arcgis.animation.IAGAnimationType
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnimationTypeByRef

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

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

getPathGeometry

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

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

setPathGeometry

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

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

getVerticalOffset

double getVerticalOffset()
                         throws java.io.IOException,
                                AutomationException
The vertical offset in meters to be applied to the path geometry.

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

setVerticalOffset

void setVerticalOffset(double pElevOffsetMeters)
                       throws java.io.IOException,
                              AutomationException
The vertical offset in meters to be applied to the path geometry.

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

getAnimatedObject

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

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

void setAnimatedObjectByRef(java.lang.Object ppAnimObj)
                            throws java.io.IOException,
                                   AutomationException
The object to be animated (if any).

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

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

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

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

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

isReversePath

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

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

setReversePath

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

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

getSimplificationFactor

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

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

setSimplificationFactor

void setSimplificationFactor(double pSimplFactor)
                             throws java.io.IOException,
                                    AutomationException
The path simplification factor (0.0-100.0).

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

getLookaheadFactor

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

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

setLookaheadFactor

void setLookaheadFactor(double pLookaheadFactor)
                        throws java.io.IOException,
                               AutomationException
The lookahead factor (0.0-1.0).

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

getAngleCalculationMethods

void getAngleCalculationMethods(int[] pAzimuthMethod,
                                int[] pInclinationMethod,
                                int[] pRollMethod)
                                throws java.io.IOException,
                                       AutomationException
The options for angle calculation.

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

void putAngleCalculationMethods(int azimuthMethod,
                                int inclinationMethod,
                                int rollMethod)
                                throws java.io.IOException,
                                       AutomationException
The options for angle calculation.

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

getAngleCalculationValues

void getAngleCalculationValues(double[] pAzimuthValue,
                               double[] pInclinationValue,
                               double[] pRollValue)
                               throws java.io.IOException,
                                      AutomationException
The values for angle calculation (angles in degrees).

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

void putAngleCalculationValues(double azimuthValue,
                               double inclinationValue,
                               double rollValue)
                               throws java.io.IOException,
                                      AutomationException
The values for angle calculation (angles in degrees).

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

getRollFactor

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

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

setRollFactor

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

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

isOverwriteExisting

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

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

setOverwriteExisting

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

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

getTrackName

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

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

setTrackName

void setTrackName(java.lang.String pTrackName)
                  throws java.io.IOException,
                         AutomationException
The name of the track to be created.

Parameters:
pTrackName - The pTrackName (in)
Throws:
java.io.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