Home > Articles > Programming > Java

This chapter is from the book

The Renderable Layer

We already described the RenderableImage interface in Chapter 10. Many JAI standard operators take RenderableImage as an input source. The RenderableOp class is the equivalent of RenderedOp for a renderable layer. In other words, RenderableOp represents a node in the renderable chain.

A rendering chain has a source and a sink. The first step in building a renderable chain is to create a renderable source—that is, a renderable image.

Even though the renderable image has no size and lacks many other physical attributes, a real image is needed as a source. To construct a renderable chain, a renderable image is derived from this image.

TABLE 11.5 Renderable Operator Parameters

Operator Name

Parameter

Type

Default Value

Description

Renderable

downSampler

RenderedOp

null

Rendered chain that supplies low-resolution images

maxLowResDim

float

64

 

minX

float

0.0f

 

minY

float

0.0f

 

height

int

1.0f

 

An image in Java can be loaded as an Image, BufferedImage, or PlanarImage object. There is no equivalent of PlanarImage for the renderable chain. Instead, JAI provides an operator named Renderable, which converts RenderedImage to RenderableImage. Table 11.5 shows the parameters for this operator.

Obviously the Renderable operator does not take the renderable image as a source. This operator creates a pyramid of low-resolution images. But normally you would want to create a single image. Listing 11.12 shows an example that uses the Renderable operator.

LISTING 11.12 Converting to a renderable node

public static RenderableOp convertToRenderable(PlanarImage image) {
  ParameterBlock pb = new ParameterBlock();
  pb.addSource(image);
  pb.add(null).add(null).add(null).add(null).add(null);
  return JAI.createRenderable("renderable", pb);
}

To apply standard operators to a renderable image, use the JAI.create Renderable() method, which returns a RenderableOp node.

Creating a Renderable Node

In the renderable chain, the RenderableOp class represents a renderable node. The RenderableOp class implements the RenderableImage interface. Recall from Chapter 10 that the RenderableImage interface has three different methods for creating a rendering: createDefaultRendering(), createScaledRendering(), and createRendering(). Each one returns a RenderedImage object.

To evaluate a renderable node, call one of the three rendering methods. While these methods are being executed, the size is assigned to the image. The RenderedImage object returned by these methods can be rendered through Graphics2D's drawRenderedImage() method. This means that the same components we developed for displaying planar images can be used for rendering a renderable node.

NOTE

The source code for RenderableImageCanvas is available on the book's Web page in the directory src/chapter11/simplerenderable.

However, the Graphics2D class has a method that directly renders a renderable image:

  • public abstract void drawRenderableImage(RenderableImage img,
                                             AffineTransform xform)

Let's use this method to display a renderable image. As stated earlier, a renderable image has no size. This means that it has no width or height properties. However, a renderable image does have an aspect ratio. Because the renderable image has no size, the image viewer will need to provide the input. The options are

  • To fit the viewport. Regardless of the size of a viewport, the size of the displayed image is increased or decreased to fit the viewport.

  • Scaled. The size of the image fits the viewport, but the aspect ratio is maintained.

  • Original size. The size matches the size of the source image from which the renderable image is generated.

Let's first build a canvas to display the renderable image. Listing 11.13 shows the class (RenderableImageCanvas) that can do this. It is similar to JAIImageCanvas, except for the paintComponent() method.

LISTING 11.13 The RenderableImageCanvas class

package com.vistech.jai.render;
import java.io.*;
import java.awt.*;
import java.awt.event.*;
import java.awt.image.*;
import javax.swing.*;
import java.awt.geom.*;
import java.awt.image.renderable.*;
import javax.media.jai.*;
import com.vistech.imageviewer.*;
public class RenderableImageCanvas extends JComponent implements ScrollController {
  public final static int TO_FIT =0;
  public final static int SCALED = 1;
  public final static int MAX_SIZE = 4;

  protected RenderableImage sourceImage;
  protected AffineTransform atx = new AffineTransform();
  protected boolean imageDrawn = false;
  protected int panX =0, panY =0;
  private Point scrollAnchor = new Point(0,0);
  protected boolean scrollOn = true;
  protected int viewerWidth = 480, viewerHeight = 400;
  protected Point panOffset = new Point(0,0);
  protected int displayMode = SCALED;
  protected int interpolationMode = Interpolation.INTERP_BILINEAR;
  protected float sourceImageHeight = 1.0f;
  protected float sourceImageWidth = 1.0f;
  protected int maxHeight =1024, maxWidth = 1024;

  public RenderableImageCanvas() {}

  public RenderableImageCanvas(RenderableImage img){
   atx = new AffineTransform();
   setImage(img);
  }

  public boolean isImageDrawn(){ return imageDrawn;}

  public void setDisplayMode(int dispMode) {
   displayMode = dispMode;
   createScalingTransform();
  }
  public int getDisplayMode(){ return displayMode;}

  public void setOrigImageSize(Dimension size){
   maxWidth = size.width;
   maxHeight = size.height;
  }

  public void setImage(RenderableImage rImg){
   sourceImage = rImg;
   panX =0; panY =0;
   sourceImageHeight = sourceImage.getHeight();
   sourceImageWidth = sourceImage.getWidth();
   createScalingTransform();
   imageDrawn = false;
   repaint();
  }


  protected void createScalingTransform(){
   int wid = viewerWidth, ht = viewerHeight;
   double aspectRatio = sourceImageWidth/sourceImageHeight;
   switch (displayMode) {
    case SCALED:
      if(aspectRatio > 1.00) ht = (int)(viewerHeight/aspectRatio);
      else wid = (int)(viewerWidth/aspectRatio);
      atx.setToScale(wid/(double)sourceImageWidth,ht*sourceImageHeight);
      break;
     case MAX_SIZE:
      wid = maxWidth; ht = maxHeight;
      atx.setToScale(maxWidth/(double)sourceImageWidth,             maxHeight*sourceImageHeight);
      break;
     case TO_FIT:
      atx.setToScale(viewerWidth/(double)sourceImageWidth,
             sourceImageHeight*viewerHeight);
      break;
   }
    repaint();
  }

  public void paintComponent(Graphics gc){
   Graphics2D g = (Graphics2D)gc;
   Rectangle rect = this.getBounds();
   if((viewerWidth != rect.width) || (viewerHeight != rect.height)){
     viewerWidth =rect.width;
     viewerHeight = rect.height;
     createScalingTransform();
   }
   g.setColor(Color.black);
   g.fillRect(0, 0, viewerWidth, viewerHeight);
   if(sourceImage == null) return;
   try {
    Point2D dest = null;
    dest = atx.inverseTransform(new Point(panX,panY), dest);
    atx.translate(dest.getX(), dest.getY());
    g.drawRenderableImage(sourceImage, atx);
   }catch (Exception e) {}
   imageDrawn = true;
  }

  public void setPanOffset(Point panOffset){
   firePropertyChange("PanOffset",this.panOffset,panOffset);
   this.panOffset = panOffset;
   panX = panOffset.x; panY = panOffset.y;
  }

  public Point getPanOffset(){ return panOffset;}

  public void setScrollOn(boolean onOff){
   scrollOn = onOff;
   panX =0; panY =0;
  }

  public boolean getScrollOn(){ return scrollOn;}

  public void startScroll(int x, int y){
   scrollAnchor.x = x- panX;
   scrollAnchor.y = y- panY;
   repaint();
  }

  public void scroll(int x, int y){
   if((x <0 )|| (y<0)) return;
   panX = x-scrollAnchor.x;
   panY = y-scrollAnchor.y;
   repaint();
  }

  public void stopScroll(){ setCursor(Cursor.getDefaultCursor());}

  public void reset(){
   atx = new AffineTransform();
   panX =0; panY =0;
  }
}

Just like the JAIImageCanvas class, RenderableImageCanvas implements ScrollController, which allows you to scroll the displayed image. To display a renderable image, the client object calls the setImage() method. This method first obtains the width and height of the renderable image. The height of a renderable image always equals 1.0f, and the width is given by 1/aspect ratio. This means that the rendering operations are performed on an image that is 1 pixel high and (1/aspect ratio) wide.

The setImage() method then sets the scaling factor by calling the createScalingTransform() method, which determines the scaling factor on the basis of the user's choice and sets the atx instance variable. Users have three choices:

  1. SCALED

  2. TO_FIT

  3. ORIG_SIZE

The original size of the RenderableImage cannot be determined from the RenderedImage class, so setOrigImageSize() sets this variable.

The paintComponent() method uses atx (AffineTransform) to

  • Compute the translation parameters in the RenderableImage space by inverse-transforming the panX and panY variables. This computation is a must because the renderable image is very small compared to the viewport.

  • Concatenate this translation.

  • Perform drawRenderable().

Every time the paintComponent() method is called to paint the scrolled image, a lot of computation is involved. You will notice this if you try to scroll a large image.

Next let's build an image viewer using the RenderableImageViewer class, which is shown in Listing 11.14.

LISTING 11.14 The RenderableImageViewer class

public class RenderableImageViewer extends JAIImageViewer{
  RenderableImageCanvas viewer;
  public static void main(String[] args){
   RenderableImageViewer ip = new RenderableImageViewer();
   if(args.length <1) {
     ip.createUI();
   }else ip.loadAndDisplay(args[0]);
  }
  public void displayImage(PlanarImage img) {
   int wid = img.getWidth();
   int ht = img.getHeight();
   ParameterBlock pb = new ParameterBlock();
   pb.addSource(img);
   pb.add(null).add(null).add(null).add(null).add(null);
   RenderableOp op = JAI.createRenderable("renderable", pb);
   viewer.setImage(op);
   viewer.setOrigImageSize(new Dimension(wid, ht));
   saver.setImage(img);
   viewer.repaint();
  }

  public void createUI() {
   Dimension dim= Toolkit.getDefaultToolkit().getScreenSize();
   int width = (int)(dim.width *3/4.0);
   int height = (int)(dim.height*3/4.0);

   setTitle("Renderable Image Viewer");
   viewer = new RenderableImageCanvas();
   Dimension d = getViewerSize(width/(double)height);
   viewer.setPreferredSize(new Dimension(d.width, d.height));
   createImageLoaderAndSaver();
   loader.addPlanarImageLoadedListener(
     new PlanarImageLoadedListener() {
       public void imageLoaded(PlanarImageLoadedEvent e) {
        PlanarImage image = e.getImage();
        if(image == null) return;
        SwingUtilities.invokeLater(new ImagePaint(image));
       }
     }
   );
   // Layout code not shown.
 }

 // DisplayModePanel code not shown.
 }

  class ImagePaint implements Runnable {
   PlanarImage image;
   boolean firstTime = true;
   public ImagePaint(PlanarImage image){this.image = image;}
   public void run() {
     if(firstTime) {
      try {
       setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
       displayImage(image);
       firstTime = false;
       SwingUtilities.invokeLater(this);
      } catch(Exception e){SwingUtilities.invokeLater(this);}
     }
     else {
      if(!viewer.isImageDrawn()) SwingUtilities.invokeLater(this);
      else{
        setCursor(Cursor.getDefaultCursor());
      }
     }
   }
  }

NOTE

The source code for TiledRenderableImageCanvas is available on the book's Web page in the directory src/chapter11/renderable.

The RenderableImageViewer class is a subclass of JAIImageViewer (see Listing 10.3). As in JAIImageViewer, the image is painted in a thread. The ImagePaint thread is invoked when an image is loaded. The run() method of ImagePaint calls the displayImage() method. The displayImage() method first converts PlanarImage to RenderableImage using the Renderable operator and then sends it to Renderable ImageCanvas. Figure 11.9 shows a screen shot of the renderable-image viewer application with a large image scaled to fit the viewport size.

FIGURE 11.9 Scaling a large image to the viewport size

To speed up image manipulation, we can compute tiles and paint only those needed in the paintComponent() method. We did this already in the RenderedImageCanvas class. So to display a renderable image, let's create a canvas that is a subclass of RenderedImageCanvas. We'll call this class TiledRenderable ImageCanvas. There is no need to override the paintComponent() method because we can create a rendered image by calling RenderableOp's createRendering() method. Listing 11.15 shows the code for TiledRenderable ImageCanvas.

LISTING 11.15 The TiledRenderableImageCanvas class

package com.vistech.jai.render;
import java.awt.*;
import java.awt.event.*;
import java.awt.image.*;
import java.io.*;
import javax.swing.*;
import javax.swing.event.*;
import java.awt.geom.*;
import java.awt.image.renderable.*;
import javax.media.jai.*;

public class TiledRenderableImageCanvas extends RenderedImageCanvas {
  public final static int TO_FIT =0;
  public final static int SCALED = 1;
  public final static int ORIG_SIZE = 4;

  protected RenderableImage sourceImage;
  protected int interpolationMode = Interpolation.INTERP_BILINEAR;

  protected int displayMode = ORIG_SIZE;
  protected float sourceImageHeight = 1.0f;
  protected float sourceImageWidth = 1.0f;
  protected int maxHeight =1024, maxWidth = 1024;

  public TiledRenderableImageCanvas() {}

  public TiledRenderableImageCanvas(RenderableImage img){
   atx = new AffineTransform();
   setImage(img);
  }

  public void setImage(RenderableImage pixelLessImg){
   PlanarImage img = createPlanarImage(pixelLessImg);
   displayImage = makeTiledImage(img);
   sampleModel = displayImage.getSampleModel();
   colorModel = displayImage.getColorModel();
   getTileInfo(displayImage);
   imageDrawn = false;
   repaint();
  }

  public void setDisplayMode(int dispMode) {
   displayMode = dispMode;
   setImage(sourceImage);
  }
  public int getDisplayMode(){ return displayMode;}

  public void setOrigImageSize(Dimension size){
   maxWidth = size.width;
   maxHeight = size.height;
  }
  public void setInterpolationMode(int interpMode) { interpolationMode = interpMode;}
  public int getInterpolationMode(){ return interpolationMode;}

  protected PlanarImage createPlanarImage(RenderableImage pixelLessImg){
   panX =0; panY =0;
   sourceImage = pixelLessImg;
   sourceImageHeight = sourceImage.getHeight();
   sourceImageWidth = sourceImage.getWidth();
   return createPixelImage(pixelLessImg);
  }

  protected PlanarImage createPixelImage(RenderableImage pixelLessImg){
   RenderingHints hints = new RenderingHints(JAI.KEY_INTERPOLATION,
          Interpolation.getInstance(interpolationMode));
   int wid = viewerWidth, ht = viewerHeight;
   double aspectRatio = sourceImageWidth/sourceImageHeight;
   switch (displayMode) {
     case SCALED:
      if(aspectRatio > 1.00) ht = (int)(viewerHeight/aspectRatio);
      else wid = (int)(viewerWidth*aspectRatio);
      break;
     case ORIG_SIZE:
      ht = maxHeight; wid = maxWidth;
      break;
     case TO_FIT:
   }
   if(sourceImage == null) return null;
   return (PlanarImage) sourceImage.createScaledRendering(wid, ht, hints);
  }

  public void setTileWidth(int tw){
   tileWidth = tw;
   setImage(sourceImage);
   repaint();
  }
  public void setTileHeight(int th){
   tileHeight = th;
   setImage(sourceImage);
   repaint();
  }
}

The TiledRenderableImageViewer application uses TiledRenderableImage Canvas to display images. We won't show the source code for this application because it is similar to the source code for the RenderableImageViewer application shown in Listing 11.14. Figure 11.10 shows a screen shot of the TiledRenderable ImageViewer application.

FIGURE 11.10 The tiled renderable-image viewer

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020