RgbPaperType.RgbPaper (Starjava TTOOLS API)

java.lang.Object
- uk.ac.starlink.ttools.plot2.paper.RgbPaperType.RgbPaper

All Implemented Interfaces:

Paper

Direct Known Subclasses:

RgbPaperType2D.RgbPaper2D, RgbPaperType3D.RgbPaper3D

Enclosing class:

RgbPaperType
```
protected abstract static class RgbPaperType.RgbPaper
extends java.lang.Object
implements Paper
```
Paper for use by this type.

Constructor Summary

Constructors
Constructor and Description

RgbPaper(PaperType paperType, java.awt.Rectangle bounds)
Constructor.

Constructors
Constructor and Description
`RgbPaper(PaperType paperType, java.awt.Rectangle bounds)` Constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`flush()` Called after all drawings have been drawn.
`java.awt.Rectangle`	`getBounds()` Returns the plot bounds.
`PaperType`	`getPaperType()` Returns the PaperType which generated and can write to this paper.
`protected int`	`getPixelIndex(int xoff, int yoff, Pixer pixer)` Returns the index into the RGB image buffer corresponding to the current state of a pixel iterator and an X/Y offset.
`RgbImage`	`getRgbImage()` Returns the RGB image that stores the state of this paper.
`void`	`placeDecal(Decal decal)` Does the work for placing a decal.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RgbPaper
```
public RgbPaper(PaperType paperType,
                java.awt.Rectangle bounds)
```
    Constructor.
    
    Parameters:
    
    paperType - paper type instance creating this paper
    
    bounds - plot bounds
- Method Detail
  - getPaperType
```
public PaperType getPaperType()
```
    Description copied from interface: Paper
    
    Returns the PaperType which generated and can write to this paper. This method is not essential, but could be useful for assertions.
    
    Specified by:
    
    getPaperType in interface Paper
    
    Returns:
    
    paper type
  - getRgbImage
```
public RgbImage getRgbImage()
```
    Returns the RGB image that stores the state of this paper.
    
    Returns:
    
    rgb image
  - getBounds
```
public java.awt.Rectangle getBounds()
```
    Returns the plot bounds.
    
    Returns:
    
    plot bounds
  - placeDecal
```
public void placeDecal(Decal decal)
```
    Does the work for placing a decal. Invoked by RgbPaperType.placeDecal(uk.ac.starlink.ttools.plot2.paper.Paper, uk.ac.starlink.ttools.plot2.Decal).
    
    Parameters:
    
    decal - graphic to paint
  - getPixelIndex
```
protected int getPixelIndex(int xoff,
                            int yoff,
                            Pixer pixer)
```
    Returns the index into the RGB image buffer corresponding to the current state of a pixel iterator and an X/Y offset.
    
    Parameters:
    
    xoff - offset in X
    
    yoff - offset in Y
    
    pixer - pixel iterator
    
    Returns:
    
    buffer offset for current position of pixer
  - flush
```
public abstract void flush()
```
    Called after all drawings have been drawn.

Class RgbPaperType.RgbPaper

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RgbPaper

Method Detail

getPaperType

getRgbImage

getBounds

placeDecal

getPixelIndex

flush