1. /*

  2.  * @(#)ImageConsumer.java	1.16 01/11/29

  3.  *

  4.  * Copyright 2002 Sun Microsystems, Inc. All rights reserved.

  5.  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.

  6.  */

  7. 

  8. package java.awt.image;

  9. 

  10. import java.util.Hashtable;

  11. 

  12. /**

  13.  * The interface for objects expressing interest in image data through

  14.  * the ImageProducer interfaces.  When a consumer is added to an image

  15.  * producer, the producer delivers all of the data about the image

  16.  * using the method calls defined in this interface.

  17.  *

  18.  * @see ImageProducer

  19.  *

  20.  * @version	1.16 11/29/01

  21.  * @author 	Jim Graham

  22.  */

  23. public interface ImageConsumer {

  24.     /**

  25.      * The dimensions of the source image are reported using the

  26.      * setDimensions method call.

  27.      */

  28.     void setDimensions(int width, int height);

  29. 

  30.     /**

  31.      * Sets the extensible list of properties associated with this image.

  32.      */

  33.     void setProperties(Hashtable props);

  34. 

  35.     /**

  36.      * The ColorModel object used for the majority of

  37.      * the pixels reported using the setPixels method

  38.      * calls.  Note that each set of pixels delivered using setPixels

  39.      * contains its own ColorModel object, so no assumption should

  40.      * be made that this model will be the only one used in delivering

  41.      * pixel values.  A notable case where multiple ColorModel objects

  42.      * may be seen is a filtered image when for each set of pixels

  43.      * that it filters, the filter

  44.      * determines  whether the

  45.      * pixels can be sent on untouched, using the original ColorModel,

  46.      * or whether the pixels should be modified (filtered) and passed

  47.      * on using a ColorModel more convenient for the filtering process.

  48.      * @see ColorModel

  49.      */

  50.     void setColorModel(ColorModel model);

  51. 

  52.     /**

  53.      * The ImageProducer can deliver the pixels in any order, but

  54.      * the ImageConsumer may be able to scale or convert the pixels

  55.      * to the destination ColorModel more efficiently or with higher

  56.      * quality if it knows some information about how the pixels will

  57.      * be delivered up front.  The setHints method should be called

  58.      * before any calls to any of the setPixels methods with a bit mask

  59.      * of hints about the manner in which the pixels will be delivered.

  60.      * If the ImageProducer does not follow the guidelines for the

  61.      * indicated hint, the results are undefined.

  62.      */

  63.     void setHints(int hintflags);

  64. 

  65.     /**

  66.      * The pixels will be delivered in a random order.  This tells the

  67.      * ImageConsumer not to use any optimizations that depend on the

  68.      * order of pixel delivery, which should be the default assumption

  69.      * in the absence of any call to the setHints method.

  70.      * @see #setHints

  71.      */

  72.     int RANDOMPIXELORDER = 1;

  73. 

  74.     /**

  75.      * The pixels will be delivered in top-down, left-to-right order.

  76.      * @see #setHints

  77.      */

  78.     int TOPDOWNLEFTRIGHT = 2;

  79. 

  80.     /**

  81.      * The pixels will be delivered in (multiples of) complete scanlines

  82.      * at a time.

  83.      * @see #setHints

  84.      */

  85.     int COMPLETESCANLINES = 4;

  86. 

  87.     /**

  88.      * The pixels will be delivered in a single pass.  Each pixel will

  89.      * appear in only one call to any of the setPixels methods.  An

  90.      * example of an image format which does not meet this criterion

  91.      * is a progressive JPEG image which defines pixels in multiple

  92.      * passes, each more refined than the previous.

  93.      * @see #setHints

  94.      */

  95.     int SINGLEPASS = 8;

  96. 

  97.     /**

  98.      * The image contain a single static image.  The pixels will be defined

  99.      * in calls to the setPixels methods and then the imageComplete method

  100.      * will be called with the STATICIMAGEDONE flag after which no more

  101.      * image data will be delivered.  An example of an image type which

  102.      * would not meet these criteria would be the output of a video feed,

  103.      * or the representation of a 3D rendering being manipulated

  104.      * by the user.  The end of each frame in those types of images will

  105.      * be indicated by calling imageComplete with the SINGLEFRAMEDONE flag.

  106.      * @see #setHints

  107.      * @see #imageComplete

  108.      */

  109.     int SINGLEFRAME = 16;

  110. 

  111.     /**

  112.      * The pixels of the image are delivered using one or more calls

  113.      * to the setPixels method.  Each call specifies the location and

  114.      * size of the rectangle of source pixels that are contained in

  115.      * the array of pixels.  The specified ColorModel object should

  116.      * be used to convert the pixels into their corresponding color

  117.      * and alpha components.  Pixel (m,n) is stored in the pixels array

  118.      * at index (n * scansize + m + off).  The pixels delivered using

  119.      * this method are all stored as bytes.

  120.      * @see ColorModel

  121.      */

  122.     void setPixels(int x, int y, int w, int h,

  123. 		   ColorModel model, byte pixels[], int off, int scansize);

  124. 

  125.     /**

  126.      * The pixels of the image are delivered using one or more calls

  127.      * to the setPixels method.  Each call specifies the location and

  128.      * size of the rectangle of source pixels that are contained in

  129.      * the array of pixels.  The specified ColorModel object should

  130.      * be used to convert the pixels into their corresponding color

  131.      * and alpha components.  Pixel (m,n) is stored in the pixels array

  132.      * at index (n * scansize + m + off).  The pixels delivered using

  133.      * this method are all stored as ints.

  134.      * @see ColorModel

  135.      */

  136.     void setPixels(int x, int y, int w, int h,

  137. 		   ColorModel model, int pixels[], int off, int scansize);

  138. 

  139.     /**

  140.      * The imageComplete method is called when the ImageProducer is

  141.      * finished delivering all of the pixels that the source image

  142.      * contains, or when a single frame of a multi-frame animation has

  143.      * been completed, or when an error in loading or producing the

  144.      * image has occured.  The ImageConsumer should remove itself from the

  145.      * list of consumers registered with the ImageProducer at this time,

  146.      * unless it is interested in successive frames.

  147.      * @see ImageProducer#removeConsumer

  148.      */

  149.     void imageComplete(int status);

  150. 

  151.     /**

  152.      * An error was encountered while producing the image.

  153.      * @see #imageComplete

  154.      */

  155.     int IMAGEERROR = 1;

  156. 

  157.     /**

  158.      * One frame of the image is complete but there are more frames

  159.      * to be delivered.

  160.      * @see #imageComplete

  161.      */

  162.     int SINGLEFRAMEDONE = 2;

  163. 

  164.     /**

  165.      * The image is complete and there are no more pixels or frames

  166.      * to be delivered.

  167.      * @see #imageComplete

  168.      */

  169.     int STATICIMAGEDONE = 3;

  170. 

  171.     /**

  172.      * The image creation process was deliberately aborted.

  173.      * @see #imageComplete

  174.      */

  175.     int IMAGEABORTED = 4;

  176. }