com.esri.arcgis.datasourcesraster

Interface IMosaicFunction2

All Superinterfaces:

IMosaicFunction, java.io.Serializable

All Known Subinterfaces:

IMosaicFunction3

All Known Implementing Classes:

IMosaicFunction2Proxy, IMosaicFunction3Proxy, MosaicFunction

public interface IMosaicFunction2
extends IMosaicFunction, java.io.Serializable

COM Interface 'IMosaicFunction2'. Generated 9/24/2024 11:01:30 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description: 'Provides access to members that control mosaic function.' 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

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID9beaef50_906f_4bb9_a693_92c9a63baabc
static int	xxDummy Deprecated. Internal use only

Fields inherited from interface com.esri.arcgis.datasourcesraster.IMosaicFunction

IID2e7a3bb4_76e1_4b84_a359_68233d60450a

Method Summary

Modifier and Type	Method and Description
IRaster	getBackgroundRaster() The background raster.
int	getBlendingWidth() The blending width for Blend mosaic operator.
boolean	isClipToBoundary() Indicates if the mosaic dataset will be clipped to its boundary.
boolean	isFootprintMayContainNoData() Indicates whether the footprint geometry associated with each raster may contain NoData pixels.
void	setBackgroundRasterByRef(IRaster ppRaster) The background raster.
void	setBlendingWidth(int pWidth) The blending width for Blend mosaic operator.
void	setClipToBoundary(boolean pClipping) Indicates if the mosaic dataset will be clipped to its boundary.
void	setFootprintMayContainNoData(boolean pbFootprintMayContainNoData) Indicates whether the footprint geometry associated with each raster may contain NoData pixels.

Methods inherited from interface com.esri.arcgis.datasourcesraster.IMosaicFunction

constructQueryExpression, getCatalog, getCellsizeFieldName, getDefinitionExpression, getDefinitionFIDs, getDefinitionGeometry, getFIDs, getFootprintSymbol, getLockRasterFieldName, getLockRasterID, getLODFieldName, getLODInfos, getMaxCellsizeFieldIndex, getMaxCellsizeFieldName, getMaximumVisibleCellsize, getMaxMosaicImageCount, getMinCellsizeFieldIndex, getMinCellsizeFieldName, getMosaicMethod, getMosaicOperator, getMosaicOperatorType, getOrderByBaseValue, getOrderByFieldName, getRasterFieldIndex, getRasterFieldName, getViewpoint, getWhereClause, isApplyColorCorrection, isAscending, isClipToFootprint, isDrawFootprint, isVisible, lockCellsize, search, setApplyColorCorrection, setAscending, setCellsizeFieldName, setClipToFootprint, setDefinitionExpression, setDefinitionFIDsByRef, setDefinitionGeometryByRef, setDrawFootprint, setFIDsByRef, setFootprintSymbolByRef, setLockRasterFieldName, setLockRasterID, setLODFieldName, setLODInfosByRef, setMaxCellsizeFieldName, setMaximumVisibleCellsize, setMaxMosaicImageCount, setMinCellsizeFieldName, setMosaicMethod, setMosaicOperatorByRef, setMosaicOperatorType, setOrderByBaseValue, setOrderByFieldName, setRasterFieldName, setViewpointByRef, setWhereClause, unlockCellsize

Field Detail

IID9beaef50_906f_4bb9_a693_92c9a63baabc

static final int IID9beaef50_906f_4bb9_a693_92c9a63baabc

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

isClipToBoundary

boolean isClipToBoundary()
                  throws java.io.IOException,
                         AutomationException

Indicates if the mosaic dataset will be clipped to its boundary.

Returns:

The pClipping

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClipToBoundary

void setClipToBoundary(boolean pClipping)
                throws java.io.IOException,
                       AutomationException

Indicates if the mosaic dataset will be clipped to its boundary.

Parameters:

pClipping - The pClipping (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackgroundRaster

IRaster getBackgroundRaster()
                     throws java.io.IOException,
                            AutomationException

The background raster.

Returns:

A reference to a com.esri.arcgis.geodatabase.IRaster

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundRasterByRef

void setBackgroundRasterByRef(IRaster ppRaster)
                       throws java.io.IOException,
                              AutomationException

The background raster.

Parameters:

ppRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBlendingWidth

int getBlendingWidth()
              throws java.io.IOException,
                     AutomationException

The blending width for Blend mosaic operator.

Returns:

The pWidth

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBlendingWidth

void setBlendingWidth(int pWidth)
               throws java.io.IOException,
                      AutomationException

The blending width for Blend mosaic operator.

Parameters:

pWidth - The pWidth (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFootprintMayContainNoData

boolean isFootprintMayContainNoData()
                             throws java.io.IOException,
                                    AutomationException

Indicates whether the footprint geometry associated with each raster may contain NoData pixels. Setting this property to false while clipping to fooptrint enables the system to assume that only valid pixels exist within a raster's footprint towards optimizing

Returns:

The pbFootprintMayContainNoData

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFootprintMayContainNoData

void setFootprintMayContainNoData(boolean pbFootprintMayContainNoData)
                           throws java.io.IOException,
                                  AutomationException

Indicates whether the footprint geometry associated with each raster may contain NoData pixels. Setting this property to false while clipping to fooptrint enables the system to assume that only valid pixels exist within a raster's footprint towards optimizing

Parameters:

pbFootprintMayContainNoData - The pbFootprintMayContainNoData (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.