com.esri.arcgis.datasourcesraster

Interface IPixelBlock3

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IPixelBlock3Proxy, PixelBlock

public interface IPixelBlock3
extends java.io.Serializable

COM Interface 'IPixelBlock3'. Generated 9/21/2023 10:01:48 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description: 'Provides access to members that control a PixelBlock.' 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	IID0ed55c8f_1ec2_4b40_a5d9_f3da548f1f40
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
void	clear(int plane) Clears a given plane (sets to NoData).
int	getBytesPerPixel() The number of bytes per pixel for the PixelBlock.
int	getHeight() The height of the PixelBlock in pixels.
java.lang.Object	getNoDataMask(int plane) The NoData mask for a specified plane.
java.lang.Object	getNoDataMaskByRef(int plane) The NoData mask for a specified plane.
java.lang.Object	getNoDataMaskVal(int plane, int x, int y) Gets the NoData mask value for a specified pixel.
java.lang.Object	getPixelData(int plane) An array of pixels for a specified plane.
java.lang.Object	getPixelDataByRef(int plane) A pointer to an array of pixels for a specified plane.
int	getPixelType(int plane) The pixel type of the PixelBlock.
int	getPlanes() The number of pixel arrays contained in the PixelBlock.
java.lang.Object	getVal(int plane, int x, int y) The value for a specified pixel.
int	getWidth() The width of the PixelBlock in pixels.
boolean	hasNoData(int plane) Checks if this PixelBlock contains NoData.
void	mask(java.lang.Object noData) Generates NoData Mask using a given NoData value.
void	setNoDataMask(int plane, java.lang.Object pVal) The NoData mask for a specified plane.
void	setPixelData(int plane, java.lang.Object pVal) An array of pixels for a specified plane.
void	setPixelType(int plane, int pVal) The pixel type of the PixelBlock.

Field Detail

IID0ed55c8f_1ec2_4b40_a5d9_f3da548f1f40

static final int IID0ed55c8f_1ec2_4b40_a5d9_f3da548f1f40

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

getPlanes

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

The number of pixel arrays contained in the PixelBlock.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWidth

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

The width of the PixelBlock in pixels.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHeight

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

The height of the PixelBlock in pixels.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPixelType

int getPixelType(int plane)
          throws java.io.IOException,
                 AutomationException

The pixel type of the PixelBlock.

Parameters:

plane - The plane (in)

Returns:

A com.esri.arcgis.geodatabase.rstPixelType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPixelType

void setPixelType(int plane,
                  int pVal)
           throws java.io.IOException,
                  AutomationException

The pixel type of the PixelBlock.

Parameters:

plane - The plane (in)

pVal - A com.esri.arcgis.geodatabase.rstPixelType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBytesPerPixel

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

The number of bytes per pixel for the PixelBlock.

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPixelData

java.lang.Object getPixelData(int plane)
                       throws java.io.IOException,
                              AutomationException

An array of pixels for a specified plane.

Parameters:

plane - The plane (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPixelData

void setPixelData(int plane,
                  java.lang.Object pVal)
           throws java.io.IOException,
                  AutomationException

An array of pixels for a specified plane.

Parameters:

plane - The plane (in)

pVal - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPixelDataByRef

java.lang.Object getPixelDataByRef(int plane)
                            throws java.io.IOException,
                                   AutomationException

A pointer to an array of pixels for a specified plane.

Parameters:

plane - The plane (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVal

java.lang.Object getVal(int plane,
                        int x,
                        int y)
                 throws java.io.IOException,
                        AutomationException

The value for a specified pixel.

Parameters:

plane - The plane (in)

x - The x (in)

y - The y (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNoDataMask

void setNoDataMask(int plane,
                   java.lang.Object pVal)
            throws java.io.IOException,
                   AutomationException

The NoData mask for a specified plane.

Parameters:

plane - The plane (in)

pVal - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNoDataMask

java.lang.Object getNoDataMask(int plane)
                        throws java.io.IOException,
                               AutomationException

The NoData mask for a specified plane.

Parameters:

plane - The plane (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNoDataMaskByRef

java.lang.Object getNoDataMaskByRef(int plane)
                             throws java.io.IOException,
                                    AutomationException

The NoData mask for a specified plane.

Parameters:

plane - The plane (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNoDataMaskVal

java.lang.Object getNoDataMaskVal(int plane,
                                  int x,
                                  int y)
                           throws java.io.IOException,
                                  AutomationException

Gets the NoData mask value for a specified pixel.

Parameters:

plane - The plane (in)

x - The x (in)

y - The y (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hasNoData

boolean hasNoData(int plane)
           throws java.io.IOException,
                  AutomationException

Checks if this PixelBlock contains NoData.

Parameters:

plane - The plane (in)

Returns:

The hasNoData

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clear

void clear(int plane)
    throws java.io.IOException,
           AutomationException

Clears a given plane (sets to NoData).

Parameters:

plane - The plane (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

mask

void mask(java.lang.Object noData)
   throws java.io.IOException,
          AutomationException

Generates NoData Mask using a given NoData value.

Parameters:

noData - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.