com.esri.arcgis.geodatabase
Class IPixelBlockProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.geodatabase.IPixelBlockProxy
All Implemented Interfaces:
IPixelBlock, Externalizable, Serializable

public class IPixelBlockProxy
extends com.esri.arcgis.interop.Dispatch
implements IPixelBlock, Serializable

Provides access to members that control a PixelBlock.

Remarks

The Height and Width properties return the number of rows and columns in the PixelBlock.

The Planes argument returns the number of bands in the PixelBlock.

The PixelType property specifies the data type and bit depth of the pixels in the specified band.The SafeArray property specifies the variant SafeArray for the specified band. At ArcGIS 9.0, this property returns SafeArray by value, not by reference like it does in ArcGIS 8.x. Your application, if only reads pixel values from SafeArray, will not be affected by this change. However, if your application involves modifying and writing pixel block to the band, you might experience a different behavior. The recommended fix is to use IPixelBlock3::PixelDataByRef method.

The GetVal method returns an individual value for the pixel specified by the band and pixel location input.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IPixelBlockProxy()
           
  IPixelBlockProxy(Object obj)
           
protected IPixelBlockProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 int getBytesPerPixel()
          The number of bytes per pixel for the PixelBlock.
 int getHeight()
          The height of the PixelBlock in pixels.
 int getPixelType(int plane)
          The pixel type of the PixelBlock.
 int getPlanes()
          The number of pixel arrays contained in the PixelBlock.
 Object getSafeArray(int plane)
          A variant SafeArray of pixels for a specified plane.
 Object getVal(int plane, int x, int y)
          The value for a specified pixel.
 int getWidth()
          The width of the PixelBlock in pixels.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void setPixelType(int plane, int val)
          The pixel type of the PixelBlock.
 void setSafeArray(int plane, Object val)
          A variant SafeArray of pixels for a specified plane.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IPixelBlockProxy

public IPixelBlockProxy()

IPixelBlockProxy

public IPixelBlockProxy(Object obj)
                 throws IOException
Throws:
IOException

IPixelBlockProxy

protected IPixelBlockProxy(Object obj,
                           String iid)
                    throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

getPlanes

public int getPlanes()
              throws IOException,
                     AutomationException
The number of pixel arrays contained in the PixelBlock.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPlanes in interface IPixelBlock
Returns:
The val
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWidth

public int getWidth()
             throws IOException,
                    AutomationException
The width of the PixelBlock in pixels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getWidth in interface IPixelBlock
Returns:
The val
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHeight

public int getHeight()
              throws IOException,
                     AutomationException
The height of the PixelBlock in pixels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getHeight in interface IPixelBlock
Returns:
The val
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPixelType

public int getPixelType(int plane)
                 throws IOException,
                        AutomationException
The pixel type of the PixelBlock.

Product Availability

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

Specified by:
getPixelType in interface IPixelBlock
Parameters:
plane - The plane (in)
Returns:
A com.esri.arcgis.geodatabase.rstPixelType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPixelType

public void setPixelType(int plane,
                         int val)
                  throws IOException,
                         AutomationException
The pixel type of the PixelBlock.

Product Availability

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

Specified by:
setPixelType in interface IPixelBlock
Parameters:
plane - The plane (in)
val - A com.esri.arcgis.geodatabase.rstPixelType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBytesPerPixel

public int getBytesPerPixel()
                     throws IOException,
                            AutomationException
The number of bytes per pixel for the PixelBlock.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBytesPerPixel in interface IPixelBlock
Returns:
The val
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSafeArray

public Object getSafeArray(int plane)
                    throws IOException,
                           AutomationException
A variant SafeArray of pixels for a specified plane.

Product Availability

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

Specified by:
getSafeArray in interface IPixelBlock
Parameters:
plane - The plane (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSafeArray

public void setSafeArray(int plane,
                         Object val)
                  throws IOException,
                         AutomationException
A variant SafeArray of pixels for a specified plane.

Product Availability

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

Specified by:
setSafeArray in interface IPixelBlock
Parameters:
plane - The plane (in)
val - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVal

public Object getVal(int plane,
                     int x,
                     int y)
              throws IOException,
                     AutomationException
The value for a specified pixel.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getVal in interface IPixelBlock
Parameters:
plane - The plane (in)
x - The x (in)
y - The y (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException