com.esri.arcgis.carto
Interface IVectorFieldRenderer

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
IVectorFieldRendererProxy

public interface IVectorFieldRenderer
extends java.io.Serializable

COM Interface 'IVectorFieldRenderer'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to methods that control a raster based vector field renderer.' 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 IIDa884b814_d30a_47b3_bfd0_6b51279241d4
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 IRasterLayer getAuxiliaryLayer()
          The raster layer that will be used as one of the components to compute the vector.The auxiliary layer is useful when the magnitude and direction components of a vector are not part of the same dataset, but come from 2 different datasets.
 java.lang.String getCalculationMethod()
          The calculation method used for resampling data.The calculation method is used to determine how to calculate the magnitude and direction of the vector symbol.The following are the valid calculation methods:Vector Average: computes the average of U and V equiva???\?
 IClassBreaksRenderer getClassBreaksRenderer()
          The Class breaks renderer is used for rendering vector symbols.
 int getDirectionBandID()
          The direction band id.
 int getFromUnit()
          The unit of input data.
 int getMagnitudeBandID()
          The magnitude band id.
 int getMassFlowAngleRepresentation()
          The mass flow angle representation set on the renderer.
 double getMaximumMagnitude()
          The maximum magnitude value.
 double getMaximumSymbolSize()
          The maximum symbol size.
 double getMinimumMagnitude()
          The minimum magnitude value.
 double getMinimumSymbolSize()
          The minimum symbol size.
 int getReferenceSystem()
          The reference system currently set.
 java.lang.String getSymbologyName()
          The name of the symbology used for rendering vector dataThe symbology names should be one of the following:Simple ScalarSingle ArrowWind BarbBeaufort Wind (Knots)Beaufort Wind (MetersPerSecond)Ocean Current (Knots)Ocean Current (MetersPerSecond).
 double getSymbolTileSize()
          The tile size that is used to control the density of the symbols.
 int getSymbolTileSizeUnits()
          The units associated with the tile size.
 ISymbol getTemplateSymbol()
          Template symbol for rendering the vector field.
 int getToUnit()
          The unit of output data.
 boolean isAuxiliaryLayerIsMOrUComponent()
          Determines if the auxiliary layer is a Magnitude/U component of the vector symbol.
 boolean isUVComponents()
          Input is UV components.
 void setAuxiliaryLayerByRef(IRasterLayer ppRasterLayer)
          The raster layer that will be used as one of the components to compute the vector.The auxiliary layer is useful when the magnitude and direction components of a vector are not part of the same dataset, but come from 2 different datasets.
 void setAuxiliaryLayerIsMOrUComponent(boolean pIsMOrUComponent)
          Determines if the auxiliary layer is a Magnitude/U component of the vector symbol.
 void setCalculationMethod(java.lang.String pMethod)
          The calculation method used for resampling data.The calculation method is used to determine how to calculate the magnitude and direction of the vector symbol.The following are the valid calculation methods:Vector Average: computes the average of U and V equiva???\?
 void setClassBreaksRenderer(IClassBreaksRenderer ppClassBreaksRenderer)
          The Class breaks renderer is used for rendering vector symbols.
 void setDirectionBandID(int pBandID)
          The direction band id.
 void setFromUnit(int pValue)
          The unit of input data.
 void setIsUVComponents(boolean pIsUVComponents)
          Input is UV components.
 void setMagnitudeBandID(int pBandID)
          The magnitude band id.
 void setMassFlowAngleRepresentation(int pType)
          The mass flow angle representation set on the renderer.
 void setMaximumMagnitude(double pValue)
          The maximum magnitude value.
 void setMaximumSymbolSize(double pValue)
          The maximum symbol size.
 void setMinimumMagnitude(double pValue)
          The minimum magnitude value.
 void setMinimumSymbolSize(double pValue)
          The minimum symbol size.
 void setReferenceSystem(int pType)
          The reference system currently set.
 void setSymbologyName(java.lang.String pName)
          The name of the symbology used for rendering vector dataThe symbology names should be one of the following:Simple ScalarSingle ArrowWind BarbBeaufort Wind (Knots)Beaufort Wind (MetersPerSecond)Ocean Current (Knots)Ocean Current (MetersPerSecond).
 void setSymbolTileSize(double pSize)
          The tile size that is used to control the density of the symbols.
 void setSymbolTileSizeUnits(int pUnits)
          The units associated with the tile size.
 void setTemplateSymbolByRef(ISymbol ppSymbol)
          Template symbol for rendering the vector field.
 void setToUnit(int pValue)
          The unit of output data.
 

Field Detail

IIDa884b814_d30a_47b3_bfd0_6b51279241d4

static final int IIDa884b814_d30a_47b3_bfd0_6b51279241d4
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

getMagnitudeBandID

int getMagnitudeBandID()
                       throws java.io.IOException,
                              AutomationException
The magnitude band id.

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

setMagnitudeBandID

void setMagnitudeBandID(int pBandID)
                        throws java.io.IOException,
                               AutomationException
The magnitude band id.

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

getDirectionBandID

int getDirectionBandID()
                       throws java.io.IOException,
                              AutomationException
The direction band id.

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

setDirectionBandID

void setDirectionBandID(int pBandID)
                        throws java.io.IOException,
                               AutomationException
The direction band id.

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

isUVComponents

boolean isUVComponents()
                       throws java.io.IOException,
                              AutomationException
Input is UV components.

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

setIsUVComponents

void setIsUVComponents(boolean pIsUVComponents)
                       throws java.io.IOException,
                              AutomationException
Input is UV components.

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

getReferenceSystem

int getReferenceSystem()
                       throws java.io.IOException,
                              AutomationException
The reference system currently set.

Returns:
A com.esri.arcgis.carto.esriSymbolRotationType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReferenceSystem

void setReferenceSystem(int pType)
                        throws java.io.IOException,
                               AutomationException
The reference system currently set.

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

getMassFlowAngleRepresentation

int getMassFlowAngleRepresentation()
                                   throws java.io.IOException,
                                          AutomationException
The mass flow angle representation set on the renderer.

Returns:
A com.esri.arcgis.carto.esriMassFlowAngleRepresentation constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMassFlowAngleRepresentation

void setMassFlowAngleRepresentation(int pType)
                                    throws java.io.IOException,
                                           AutomationException
The mass flow angle representation set on the renderer.

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

getSymbolTileSize

double getSymbolTileSize()
                         throws java.io.IOException,
                                AutomationException
The tile size that is used to control the density of the symbols.

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

setSymbolTileSize

void setSymbolTileSize(double pSize)
                       throws java.io.IOException,
                              AutomationException
The tile size that is used to control the density of the symbols.

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

getSymbolTileSizeUnits

int getSymbolTileSizeUnits()
                           throws java.io.IOException,
                                  AutomationException
The units associated with the tile size.

Returns:
A com.esri.arcgis.carto.esriSymbolTileSizeUnits constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSymbolTileSizeUnits

void setSymbolTileSizeUnits(int pUnits)
                            throws java.io.IOException,
                                   AutomationException
The units associated with the tile size.

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

getCalculationMethod

java.lang.String getCalculationMethod()
                                      throws java.io.IOException,
                                             AutomationException
The calculation method used for resampling data.The calculation method is used to determine how to calculate the magnitude and direction of the vector symbol.The following are the valid calculation methods:Vector Average: computes the average of U and V equiva???\?

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

setCalculationMethod

void setCalculationMethod(java.lang.String pMethod)
                          throws java.io.IOException,
                                 AutomationException
The calculation method used for resampling data.The calculation method is used to determine how to calculate the magnitude and direction of the vector symbol.The following are the valid calculation methods:Vector Average: computes the average of U and V equiva???\?

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

getSymbologyName

java.lang.String getSymbologyName()
                                  throws java.io.IOException,
                                         AutomationException
The name of the symbology used for rendering vector dataThe symbology names should be one of the following:Simple ScalarSingle ArrowWind BarbBeaufort Wind (Knots)Beaufort Wind (MetersPerSecond)Ocean Current (Knots)Ocean Current (MetersPerSecond).

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

setSymbologyName

void setSymbologyName(java.lang.String pName)
                      throws java.io.IOException,
                             AutomationException
The name of the symbology used for rendering vector dataThe symbology names should be one of the following:Simple ScalarSingle ArrowWind BarbBeaufort Wind (Knots)Beaufort Wind (MetersPerSecond)Ocean Current (Knots)Ocean Current (MetersPerSecond).

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

getTemplateSymbol

ISymbol getTemplateSymbol()
                          throws java.io.IOException,
                                 AutomationException
Template symbol for rendering the vector field.

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

setTemplateSymbolByRef

void setTemplateSymbolByRef(ISymbol ppSymbol)
                            throws java.io.IOException,
                                   AutomationException
Template symbol for rendering the vector field.

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

getClassBreaksRenderer

IClassBreaksRenderer getClassBreaksRenderer()
                                            throws java.io.IOException,
                                                   AutomationException
The Class breaks renderer is used for rendering vector symbols.

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

setClassBreaksRenderer

void setClassBreaksRenderer(IClassBreaksRenderer ppClassBreaksRenderer)
                            throws java.io.IOException,
                                   AutomationException
The Class breaks renderer is used for rendering vector symbols.

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

getAuxiliaryLayer

IRasterLayer getAuxiliaryLayer()
                               throws java.io.IOException,
                                      AutomationException
The raster layer that will be used as one of the components to compute the vector.The auxiliary layer is useful when the magnitude and direction components of a vector are not part of the same dataset, but come from 2 different datasets.

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

setAuxiliaryLayerByRef

void setAuxiliaryLayerByRef(IRasterLayer ppRasterLayer)
                            throws java.io.IOException,
                                   AutomationException
The raster layer that will be used as one of the components to compute the vector.The auxiliary layer is useful when the magnitude and direction components of a vector are not part of the same dataset, but come from 2 different datasets.

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

isAuxiliaryLayerIsMOrUComponent

boolean isAuxiliaryLayerIsMOrUComponent()
                                        throws java.io.IOException,
                                               AutomationException
Determines if the auxiliary layer is a Magnitude/U component of the vector symbol.

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

setAuxiliaryLayerIsMOrUComponent

void setAuxiliaryLayerIsMOrUComponent(boolean pIsMOrUComponent)
                                      throws java.io.IOException,
                                             AutomationException
Determines if the auxiliary layer is a Magnitude/U component of the vector symbol.

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

getMinimumMagnitude

double getMinimumMagnitude()
                           throws java.io.IOException,
                                  AutomationException
The minimum magnitude value. By default, this value is calculated from the input. You may want to modify the minimum magnitude if the input does not have statistics calculated, or the input is U and V components. Tiles with magnitude less than or equal to this???\?

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

setMinimumMagnitude

void setMinimumMagnitude(double pValue)
                         throws java.io.IOException,
                                AutomationException
The minimum magnitude value. By default, this value is calculated from the input. You may want to modify the minimum magnitude if the input does not have statistics calculated, or the input is U and V components. Tiles with magnitude less than or equal to this???\?

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

getMaximumMagnitude

double getMaximumMagnitude()
                           throws java.io.IOException,
                                  AutomationException
The maximum magnitude value. By default, this value is calculated from the input. You may want to modify the maximum magnitude if the input does not have statistics calculated, or the input is U and V components. Tiles with magnitude greater than or equal to t???\?

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

setMaximumMagnitude

void setMaximumMagnitude(double pValue)
                         throws java.io.IOException,
                                AutomationException
The maximum magnitude value. By default, this value is calculated from the input. You may want to modify the maximum magnitude if the input does not have statistics calculated, or the input is U and V components. Tiles with magnitude greater than or equal to t???\?

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

getMinimumSymbolSize

double getMinimumSymbolSize()
                            throws java.io.IOException,
                                   AutomationException
The minimum symbol size. It is specified as a percentage of the tile.

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

setMinimumSymbolSize

void setMinimumSymbolSize(double pValue)
                          throws java.io.IOException,
                                 AutomationException
The minimum symbol size. It is specified as a percentage of the tile.

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

getMaximumSymbolSize

double getMaximumSymbolSize()
                            throws java.io.IOException,
                                   AutomationException
The maximum symbol size. It is specified as a percentage of the tile.

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

setMaximumSymbolSize

void setMaximumSymbolSize(double pValue)
                          throws java.io.IOException,
                                 AutomationException
The maximum symbol size. It is specified as a percentage of the tile.

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

getFromUnit

int getFromUnit()
                throws java.io.IOException,
                       AutomationException
The unit of input data.

Returns:
A com.esri.arcgis.system.esriSpeedUnits constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFromUnit

void setFromUnit(int pValue)
                 throws java.io.IOException,
                        AutomationException
The unit of input data.

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

getToUnit

int getToUnit()
              throws java.io.IOException,
                     AutomationException
The unit of output data.

Returns:
A com.esri.arcgis.system.esriSpeedUnits constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setToUnit

void setToUnit(int pValue)
               throws java.io.IOException,
                      AutomationException
The unit of output data.

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