summaryrefslogtreecommitdiff
path: root/libjava/classpath/java/awt/image/WritableRaster.java
blob: 68774f7850acc5f141ff8a7df927c9147e01077a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
/* Copyright (C) 2000, 2002, 2003, 2006,  Free Software Foundation

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */


package java.awt.image;

import java.awt.Point;
import java.awt.Rectangle;

/**
 * A raster with methods to support updating pixel values.
 *
 * @author Rolf W. Rasmussen (rolfwr@ii.uib.no)
 */
public class WritableRaster extends Raster
{
  /**
   * Creates a new <code>WritableRaster</code>.
   *
   * @param sampleModel  the sample model.
   * @param origin  the origin.
   */
  protected WritableRaster(SampleModel sampleModel, Point origin)
  {
    this(sampleModel, sampleModel.createDataBuffer(), origin);
  }

  /**
   * Creates a new <code>WritableRaster</code> instance.
   *
   * @param sampleModel  the sample model.
   * @param dataBuffer  the data buffer.
   * @param origin  the origin.
   */
  protected WritableRaster(SampleModel sampleModel, DataBuffer dataBuffer,
                           Point origin)
  {
    this(sampleModel, dataBuffer,
         new Rectangle(origin != null ? origin.x : 0,
                       origin != null ? origin.y : 0,
                       sampleModel.getWidth(), sampleModel.getHeight()),
         origin, null);
  }

  /**
   * Creates a new <code>WritableRaster</code> instance.
   *
   * @param sampleModel  the sample model.
   * @param dataBuffer  the data buffer.
   * @param aRegion  the raster's bounds.
   * @param sampleModelTranslate  the translation.
   * @param parent  the parent.
   */
  protected WritableRaster(SampleModel sampleModel,
                           DataBuffer dataBuffer,
                           Rectangle aRegion,
                           Point sampleModelTranslate,
                           WritableRaster parent)
  {
    super(sampleModel, dataBuffer, aRegion, sampleModelTranslate, parent);
  }

  /**
   * Returns the raster's parent, cast as a {@link WritableRaster}.
   *
   * @return The raster's parent.
   */
  public WritableRaster getWritableParent()
  {
    return (WritableRaster) getParent();
  }

  /**
   * @param childMinX
   * @param childMinY
   * @return
   */
  public WritableRaster createWritableTranslatedChild(int childMinX,
                                                      int childMinY)
  {
    return createWritableChild(minX, minY, width, height,
                               childMinX, childMinY, null);
  }

  /**
   *
   * @param parentX
   * @param parentY
   * @param w
   * @param h
   * @param childMinX
   * @param childMinY
   * @param bandList
   * @return
   */
  public WritableRaster createWritableChild(int parentX, int parentY,
      int w, int h, int childMinX, int childMinY, int[] bandList)
  {
    // This mirrors the code from the super class

    if (parentX < minX || parentX + w > minX + width
        || parentY < minY || parentY + h > minY + height)
      throw new RasterFormatException("Child raster extends beyond parent");

    SampleModel sm = (bandList == null) ?
      sampleModel :
      sampleModel.createSubsetSampleModel(bandList);

    return new WritableRaster(sm, getDataBuffer(),
                              new Rectangle(childMinX, childMinY, w, h),
                              new Point(sampleModelTranslateX + childMinX -
                                          parentX,
                                        sampleModelTranslateY + childMinY -
                                          parentY),
                              this);
  }

  public Raster createChild(int parentX, int parentY, int width,
                            int height, int childMinX, int childMinY,
                            int[] bandList)
  {
    if (parentX < minX || parentX + width > minX + this.width
        || parentY < minY || parentY + height > minY + this.height)
      throw new RasterFormatException("Child raster extends beyond parent");

    SampleModel sm = (bandList == null) ?
      sampleModel :
      sampleModel.createSubsetSampleModel(bandList);

    return new WritableRaster(sm, dataBuffer,
        new Rectangle(childMinX, childMinY, width, height),
        new Point(sampleModelTranslateX + childMinX - parentX,
                  sampleModelTranslateY + childMinY - parentY),
        this);
  }

  public void setDataElements(int x, int y, Object inData)
  {
    sampleModel.setDataElements(x - sampleModelTranslateX,
        y - sampleModelTranslateY, inData, dataBuffer);
  }

  public void setDataElements(int x, int y, Raster inRaster)
  {
    Object dataElements = getDataElements(0, 0, inRaster.getWidth(),
        inRaster.getHeight(), null);
    setDataElements(x, y, dataElements);
  }

  public void setDataElements(int x, int y, int w, int h, Object inData)
  {
    sampleModel.setDataElements(x - sampleModelTranslateX,
        y - sampleModelTranslateY, w, h, inData, dataBuffer);
  }

  /**
   *
   * @param srcRaster
   */
  public void setRect(Raster srcRaster)
  {
    setRect(0, 0, srcRaster);
  }

  /**
   *
   * @param dx
   * @param dy
   * @param srcRaster
   */
  public void setRect(int dx, int dy, Raster srcRaster)
  {
    Rectangle targetUnclipped = new Rectangle(srcRaster.getMinX() + dx,
        srcRaster.getMinY() + dy, srcRaster.getWidth(), srcRaster.getHeight());

    Rectangle target = getBounds().intersection(targetUnclipped);

    if (target.isEmpty()) return;

    int sx = target.x - dx;
    int sy = target.y - dy;

    // FIXME: Do tests on rasters and use get/set data instead.

    /* The JDK documentation seems to imply this implementation.
       (the trucation of higher bits), but an implementation using
       get/setDataElements would be more efficient. None of the
       implementations would do anything sensible when the sample
       models don't match.

       But this is probably not the place to consider such
       optimizations.*/

    int[] pixels = srcRaster.getPixels(sx, sy, target.width, target.height,
                                       (int[]) null);

    setPixels(target.x, target.y, target.width, target.height, pixels);
  }

  /**
   * Sets the samples for the pixel at (x, y) in the raster to the specified
   * values.
   *
   * @param x  the x-coordinate of the pixel.
   * @param y  the y-coordinate of the pixel.
   * @param iArray  the sample values (<code>null</code> not permitted).
   *
   * @throws NullPointerException if <code>iArray</code> is <code>null</code>.
   */
  public void setPixel(int x, int y, int[] iArray)
  {
    sampleModel.setPixel(x - sampleModelTranslateX, y - sampleModelTranslateY,
                         iArray, dataBuffer);
  }

  /**
   * Sets the samples for the pixel at (x, y) in the raster to the specified
   * values.
   *
   * @param x  the x-coordinate of the pixel.
   * @param y  the y-coordinate of the pixel.
   * @param fArray  the sample values (<code>null</code> not permitted).
   *
   * @throws NullPointerException if <code>fArray</code> is <code>null</code>.
   */
  public void setPixel(int x, int y, float[] fArray)
  {
    sampleModel.setPixel(x - sampleModelTranslateX, y - sampleModelTranslateY,
                         fArray, dataBuffer);
  }

  /**
   * Sets the samples for the pixel at (x, y) in the raster to the specified
   * values.
   *
   * @param x  the x-coordinate of the pixel.
   * @param y  the y-coordinate of the pixel.
   * @param dArray  the sample values (<code>null</code> not permitted).
   *
   * @throws NullPointerException if <code>dArray</code> is <code>null</code>.
   */
  public void setPixel(int x, int y, double[] dArray)
  {
    sampleModel.setPixel(x - sampleModelTranslateX, y - sampleModelTranslateY,
                         dArray, dataBuffer);
  }

  /**
   * Sets the sample values for the pixels in the region specified by
   * (x, y, w, h) in the raster.  The array is ordered by pixels (that is, all
   * the samples for the first pixel are grouped together, followed by all the
   * samples for the second pixel, and so on).
   *
   * @param x  the x-coordinate of the top-left pixel.
   * @param y  the y-coordinate of the top-left pixel.
   * @param w  the width of the region of pixels.
   * @param h  the height of the region of pixels.
   * @param iArray  the pixel sample values (<code>null</code> not permitted).
   *
   * @throws NullPointerException if <code>iArray</code> is <code>null</code>.
   */
  public void setPixels(int x, int y, int w, int h, int[] iArray)
  {
    sampleModel.setPixels(x - sampleModelTranslateX, y - sampleModelTranslateY,
                          w, h, iArray, dataBuffer);
  }

  /**
   * Sets the sample values for the pixels in the region specified by
   * (x, y, w, h) in the raster.  The array is ordered by pixels (that is, all
   * the samples for the first pixel are grouped together, followed by all the
   * samples for the second pixel, and so on).
   *
   * @param x  the x-coordinate of the top-left pixel.
   * @param y  the y-coordinate of the top-left pixel.
   * @param w  the width of the region of pixels.
   * @param h  the height of the region of pixels.
   * @param fArray  the pixel sample values (<code>null</code> not permitted).
   *
   * @throws NullPointerException if <code>fArray</code> is <code>null</code>.
   */
  public void setPixels(int x, int y, int w, int h, float[] fArray)
  {
    sampleModel.setPixels(x - sampleModelTranslateX, y - sampleModelTranslateY,
                          w, h, fArray, dataBuffer);
  }

  /**
   * Sets the sample values for the pixels in the region specified by
   * (x, y, w, h) in the raster.  The array is ordered by pixels (that is, all
   * the samples for the first pixel are grouped together, followed by all the
   * samples for the second pixel, and so on).
   *
   * @param x  the x-coordinate of the top-left pixel.
   * @param y  the y-coordinate of the top-left pixel.
   * @param w  the width of the region of pixels.
   * @param h  the height of the region of pixels.
   * @param dArray  the pixel sample values (<code>null</code> not permitted).
   *
   * @throws NullPointerException if <code>dArray</code> is <code>null</code>.
   */
  public void setPixels(int x, int y, int w, int h, double[] dArray)
  {
    sampleModel.setPixels(x - sampleModelTranslateX, y - sampleModelTranslateY,
                          w, h, dArray, dataBuffer);
  }

  /**
   * Sets the sample value for a band for the pixel at (x, y) in the raster.
   *
   * @param x  the x-coordinate of the pixel.
   * @param y  the y-coordinate of the pixel.
   * @param b  the band (in the range <code>0</code> to
   *     <code>getNumBands() - 1</code>).
   * @param s  the sample value.
   */
  public void setSample(int x, int y, int b, int s)
  {
    sampleModel.setSample(x - sampleModelTranslateX, y - sampleModelTranslateY,
                          b, s, dataBuffer);
  }

  /**
   * Sets the sample value for a band for the pixel at (x, y) in the raster.
   *
   * @param x  the x-coordinate of the pixel.
   * @param y  the y-coordinate of the pixel.
   * @param b  the band (in the range <code>0</code> to
   *     <code>getNumBands() - 1</code>).
   * @param s  the sample value.
   */
  public void setSample(int x, int y, int b, float s)
  {
    sampleModel.setSample(x - sampleModelTranslateX, y - sampleModelTranslateY,
                          b, s, dataBuffer);
  }

  /**
   * Sets the sample value for a band for the pixel at (x, y) in the raster.
   *
   * @param x  the x-coordinate of the pixel.
   * @param y  the y-coordinate of the pixel.
   * @param b  the band (in the range <code>0</code> to
   *     <code>getNumBands() - 1</code>).
   * @param s  the sample value.
   */
  public void setSample(int x, int y, int b, double s)
  {
    sampleModel.setSample(x - sampleModelTranslateX, y - sampleModelTranslateY,
                          b, s, dataBuffer);
  }

  /**
   * Sets the sample values for one band for the pixels in the region
   * specified by (x, y, w, h) in the raster.
   *
   * @param x  the x-coordinate of the top-left pixel.
   * @param y  the y-coordinate of the top-left pixel.
   * @param w  the width of the region of pixels.
   * @param h  the height of the region of pixels.
   * @param b  the band (in the range <code>0</code> to
   *     </code>getNumBands() - 1</code>).
   * @param iArray  the sample values (<code>null</code> not permitted).
   *
   * @throws NullPointerException if <code>iArray</code> is <code>null</code>.
   */
  public void setSamples(int x, int y, int w, int h, int b,
                         int[] iArray)
  {
    sampleModel.setSamples(x - sampleModelTranslateX, y - sampleModelTranslateY,
                           w, h, b, iArray, dataBuffer);
  }

  /**
   * Sets the sample values for one band for the pixels in the region
   * specified by (x, y, w, h) in the raster.
   *
   * @param x  the x-coordinate of the top-left pixel.
   * @param y  the y-coordinate of the top-left pixel.
   * @param w  the width of the region of pixels.
   * @param h  the height of the region of pixels.
   * @param b  the band (in the range <code>0</code> to
   *     </code>getNumBands() - 1</code>).
   * @param fArray  the sample values (<code>null</code> not permitted).
   *
   * @throws NullPointerException if <code>fArray</code> is <code>null</code>.
   */
  public void setSamples(int x, int y, int w, int h, int b,
                         float[] fArray)
  {
    sampleModel.setSamples(x - sampleModelTranslateX, y - sampleModelTranslateY,
                           w, h, b, fArray, dataBuffer);
  }

  /**
   * Sets the sample values for one band for the pixels in the region
   * specified by (x, y, w, h) in the raster.
   *
   * @param x  the x-coordinate of the top-left pixel.
   * @param y  the y-coordinate of the top-left pixel.
   * @param w  the width of the region of pixels.
   * @param h  the height of the region of pixels.
   * @param b  the band (in the range <code>0</code> to
   *     </code>getNumBands() - 1</code>).
   * @param dArray  the sample values (<code>null</code> not permitted).
   *
   * @throws NullPointerException if <code>dArray</code> is <code>null</code>.
   */
  public void setSamples(int x, int y, int w, int h, int b,
                         double[] dArray)
  {
    sampleModel.setSamples(x - sampleModelTranslateX, y - sampleModelTranslateY,
                           w, h, b, dArray, dataBuffer);
  }
}