All Downloads are FREE. Search and download functionalities are using the official Maven repository.

processing.core.PSurfaceNone Maven / Gradle / Ivy

The newest version!
/* -*- mode: java; c-basic-offset: 2; indent-tabs-mode: nil -*- */

/*
  Part of the Processing project - http://processing.org

  Copyright (c) 2015 The Processing Foundation

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation, version 2.1.

  This library 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General
  Public License along with this library; if not, write to the
  Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  Boston, MA  02111-1307  USA
*/

package processing.core;

import java.io.File;

import processing.awt.ShimAWT;

/**
 * Surface that's not really visible. Used for PDF and friends, or as a base
 * class for other drawing surfaces. It includes the standard rendering loop.
 */
public class PSurfaceNone implements PSurface {
  protected PApplet sketch;
  protected PGraphics graphics;

  protected Thread thread;
  protected boolean paused;
  protected Object pauseObject = new Object();

  protected float frameRateTarget = 60;
  protected long frameRatePeriod = 1000000000L / 60L;


  public PSurfaceNone(PGraphics graphics) {
    this.graphics = graphics;
  }


  public int displayDensity() {
    return 1;
  }


  public int displayDensity(int display) {
    return 1;
  }


  public PImage loadImage(String path, Object... args) {
    return ShimAWT.loadImage(sketch, path, args);
  }


  public void selectInput(String prompt, String callback, File file,
                          Object callbackObject) {
  }


  public void selectOutput(String prompt, String callback, File file,
                           Object callbackObject) {
  }


  public void selectFolder(String prompt, String callback, File file,
                           Object callbackObject) {
  }


  @Override
  public void initOffscreen(PApplet sketch) {
    this.sketch = sketch;

    setSize(sketch.sketchWidth(), sketch.sketchHeight());
  }


//  public Component initComponent(PApplet sketch) {
//    return null;
//  }


  @Override
  public void initFrame(PApplet sketch) {
    throw new IllegalStateException("initFrame() not available with " +
                                    getClass().getSimpleName());
  }


  public Object getNative() {
    return null;
  }


  /** Set the window (and dock, or whatever necessary) title. */
  @Override
  public void setTitle(String title) {
    // You're in a utopian PSurface implementation where titles don't exist.
  }


  @Override
  public void setIcon(PImage image) {
    // I ain't visible, man.
  }


  /** Show or hide the window. */
  @Override
  public void setVisible(boolean visible) {
    // I'm always invisible. You can't catch me.
  }


  /** Set true if we want to resize things (default is not resizable) */
  @Override
  public void setResizable(boolean resizable) {
    // I don't need size to know my worth.
  }


  @Override
  public void placeWindow(int[] location, int[] editorLocation) { }


  @Override
  public void placePresent(int stopColor) { }


  /*
  @Override
  public void setupExternalMessages() { }
  */


  @Override
  public void setAlwaysOnTop(boolean always) { }


  //


  @Override
  public void setLocation(int x, int y) {
    // I'm everywhere, because I'm nowhere.
  }


  @Override
  public void setSize(int wide, int high) {
    if (PApplet.DEBUG) {
      //System.out.format("frame visible %b, setSize(%d, %d) %n", frame.isVisible(), wide, high);
      new Exception(String.format("setSize(%d, %d)", wide, high)).printStackTrace(System.out);
    }

    //if (wide == sketchWidth && high == sketchHeight) {  // doesn't work on launch
    if (wide == sketch.width && high == sketch.height) {
      if (PApplet.DEBUG) {
        new Exception("w/h unchanged " + wide + " " + high).printStackTrace(System.out);
      }
      return;  // unchanged, don't rebuild everything
    }

    //throw new RuntimeException("implement me, see readme.md");
    sketch.width = wide;
    sketch.height = high;

    // set PGraphics variables for width/height/pixelWidth/pixelHeight
    graphics.setSize(wide, high);
  }


//  public void initImage(PGraphics graphics) {
//    // TODO Auto-generated method stub
//
//  }

//  public Component getComponent() {
//    return null;
//  }


//  public void setSmooth(int level) {
//    // TODO Auto-generated method stub
//  }

//  void requestFocus() {
//  }

//  public void blit() {
//    // TODO Auto-generated method stub
//  }

  public void setCursor(int kind) { }

  public void setCursor(PImage image, int hotspotX, int hotspotY) { }

  public void showCursor() { }

  public void hideCursor() { }


  //


  public boolean openLink(String url) {
    return false;
  }


  //


  public Thread createThread() {
    return new AnimationThread();
  }


  public void startThread() {
    if (thread == null) {
      thread = createThread();
      thread.start();
    } else {
      throw new IllegalStateException("Thread already started in " +
                                      getClass().getSimpleName());
    }
  }


  public boolean stopThread() {
    if (thread == null) {
      return false;
    }
    thread = null;
    return true;
  }


  public boolean isStopped() {
    return thread == null || !thread.isAlive();
  }


  // sets a flag to pause the thread when ready
  public void pauseThread() {
    PApplet.debug("PApplet.run() paused, calling object wait...");
    paused = true;
  }


  // halts the animation thread if the pause flag is set
  protected void checkPause() {
    if (paused) {
      synchronized (pauseObject) {
        try {
          pauseObject.wait();
//          PApplet.debug("out of wait");
        } catch (InterruptedException e) {
          // waiting for this interrupt on a start() (resume) call
        }
      }
    }
//    PApplet.debug("done with pause");
  }


  public void resumeThread() {
    paused = false;
    synchronized (pauseObject) {
      pauseObject.notifyAll();  // wake up the animation thread
    }
  }


  public void setFrameRate(float fps) {
    frameRateTarget = fps;
    frameRatePeriod = (long) (1000000000.0 / frameRateTarget);
    //g.setFrameRate(fps);
  }


  public class AnimationThread extends Thread {

    public AnimationThread() {
      super("Animation Thread");
    }

    // broken out so it can be overridden by Danger et al
    public void callDraw() {
      sketch.handleDraw();
    }

    /**
     * Main method for the primary animation thread.
     * Painting in AWT and Swing
     */
    @Override
    public void run() {  // not good to make this synchronized, locks things up
      long beforeTime = System.nanoTime();
      long overSleepTime = 0L;

      int noDelays = 0;
      // Number of frames with a delay of 0 ms before the
      // animation thread yields to other running threads.
      final int NO_DELAYS_PER_YIELD = 15;

      /*
      // If size un-initialized, might be a Canvas. Call setSize() here since
      // we now have a parent object that this Canvas can use as a peer.
      if (graphics.image == null) {
//        System.out.format("it's null, sketchW/H already set to %d %d%n", sketchWidth, sketchHeight);
        try {
          EventQueue.invokeAndWait(new Runnable() {
            public void run() {
              setSize(sketchWidth, sketchHeight);
            }
          });
        } catch (InterruptedException ie) {
          ie.printStackTrace();
        } catch (InvocationTargetException ite) {
          ite.printStackTrace();
        }
//        System.out.format("  but now, sketchW/H changed to %d %d%n", sketchWidth, sketchHeight);
      }
      */

      // un-pause the sketch and get rolling
      sketch.start();

      while ((Thread.currentThread() == thread) && !sketch.finished) {
        checkPause();

        // Don't resize the renderer from the EDT (i.e. from a ComponentEvent),
        // otherwise it may attempt a resize mid-render.
//        Dimension currentSize = canvas.getSize();
//        if (currentSize.width != sketchWidth || currentSize.height != sketchHeight) {
//          System.err.format("need to resize from %s to %d, %d%n", currentSize, sketchWidth, sketchHeight);
//        }

        // render a single frame
//        try {
//          EventQueue.invokeAndWait(new Runnable() {
//            public void run() {
//        System.out.println("calling draw, finished = " + sketch.finished);
        //System.out.println("calling draw, looping = " + sketch.looping + ", frameCount = " + sketch.frameCount);
        callDraw();

//        EventQueue.invokeLater(new Runnable() {
//          public void run() {
//        if (sketch.frameCount == 1) {
//          requestFocus();
//        }
//          }
//        });

//            }
//          });
//        } catch (InterruptedException ie) {
//          ie.printStackTrace();
//        } catch (InvocationTargetException ite) {
//          ite.getTargetException().printStackTrace();
//        }

        // wait for update & paint to happen before drawing next frame
        // this is necessary since the drawing is sometimes in a
        // separate thread, meaning that the next frame will start
        // before the update/paint is completed

        long afterTime = System.nanoTime();
        long timeDiff = afterTime - beforeTime;
        //System.out.println("time diff is " + timeDiff);
        long sleepTime = (frameRatePeriod - timeDiff) - overSleepTime;

        if (sleepTime > 0) {  // some time left in this cycle
          try {
            Thread.sleep(sleepTime / 1000000L, (int) (sleepTime % 1000000L));
            noDelays = 0;  // Got some sleep, not delaying anymore
          } catch (InterruptedException ex) { }

          overSleepTime = (System.nanoTime() - afterTime) - sleepTime;

        } else {    // sleepTime <= 0; the frame took longer than the period
          overSleepTime = 0L;
          noDelays++;

          if (noDelays > NO_DELAYS_PER_YIELD) {
            Thread.yield();   // give another thread a chance to run
            noDelays = 0;
          }
        }

        beforeTime = System.nanoTime();
      }

      sketch.dispose();  // call to shutdown libs?

      // If the user called the exit() function, the window should close,
      // rather than the sketch just halting.
      if (sketch.exitCalled) {
        sketch.exitActual();
      }
    }
  }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy