com.jme3.system.AWTContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jme3-desktop Show documentation
jMonkeyEngine is a 3-D game engine for adventurous Java developers
There is a newer version: 3.7.0-stable
/*
 * Copyright (c) 2009-2023 jMonkeyEngine
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 *
 * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
 *   may be used to endorse or promote products derived from this software
 *   without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.jme3.system;


import com.jme3.input.AWTKeyInput;
import com.jme3.input.AWTMouseInput;
import com.jme3.input.JoyInput;
import com.jme3.input.TouchInput;
import com.jme3.opencl.Context;
import com.jme3.renderer.Renderer;

/**
 * A JMonkey {@link JmeContext context} that is dedicated to AWT component rendering.
 * 
 * This class is based on the JavaFX original code provided by Alexander Brui (see JME3-FX)
 * 
 * @author Julien Seinturier - COMEX SA - http://www.seinturier.fr
 * @author Alexander Brui (JavaSaBr)
 */
public class AWTContext implements JmeContext {

  /**
   * The settings.
   */
  protected final AppSettings settings;

  /**
   * The key input.
   */
  protected final AWTKeyInput keyInput;

  /**
   * The mouse input.
   */
  protected final AWTMouseInput mouseInput;

  /**
   * The current width.
   */
  private volatile int width;

  /**
   * The current height.
   */
  private volatile int height;

  /**
   * The background context.
   */
  protected JmeContext backgroundContext;

  public AWTContext() {
      this.keyInput = new AWTKeyInput(this);
      this.mouseInput = new AWTMouseInput(this);
      this.settings = createSettings();
      this.backgroundContext = createBackgroundContext();
      this.height = 1;
      this.width = 1;
  }

  /**
   * @return the current height.
   */
  public int getHeight() {
      return height;
  }

  /**
   * @param height the current height.
   */
  public void setHeight(final int height) {
      this.height = height;
  }

  /**
   * @return the current width.
   */
  public int getWidth() {
      return width;
  }

  /**
   * @param width the current width.
   */
  public void setWidth(final int width) {
      this.width = width;
  }

  /**
   * @return new settings.
   */
  protected AppSettings createSettings() {
      final AppSettings settings = new AppSettings(true);
      settings.setRenderer(AppSettings.LWJGL_OPENGL32);
      return settings;
  }

  /**
   * @return new context/
   */
  protected JmeContext createBackgroundContext() {
      return JmeSystem.newContext(settings, Type.OffscreenSurface);
  }

  @Override
  public Type getType() {
      return Type.OffscreenSurface;
  }

  @Override
  public void setSettings(AppSettings settings) {
      this.settings.copyFrom(settings);
      this.settings.setRenderer(AppSettings.LWJGL_OPENGL32);
      this.backgroundContext.setSettings(settings);
  }

    /**
     * Accesses the listener that receives events related to this context.
    *
     * @return the pre-existing instance
     */
    @Override
    public SystemListener getSystemListener() {
        return backgroundContext.getSystemListener();
    }

  @Override
  public void setSystemListener(final SystemListener listener) {
      backgroundContext.setSystemListener(listener);
  }

  @Override
  public AppSettings getSettings() {
      return settings;
  }

  @Override
  public Renderer getRenderer() {
      return backgroundContext.getRenderer();
  }

  @Override
  public Context getOpenCLContext() {
      return null;
  }

  @Override
  public AWTMouseInput getMouseInput() {
      return mouseInput;
  }

  @Override
  public AWTKeyInput getKeyInput() {
      return keyInput;
  }

  @Override
  public JoyInput getJoyInput() {
      return null;
  }

  @Override
  public TouchInput getTouchInput() {
      return null;
  }

  @Override
  public Timer getTimer() {
      return backgroundContext.getTimer();
  }

  @Override
  public void setTitle(final String title) {
  }

  @Override
  public boolean isCreated() {
      return backgroundContext != null && backgroundContext.isCreated();
  }

  @Override
  public boolean isRenderable() {
      return backgroundContext != null && backgroundContext.isRenderable();
  }

  @Override
  public void setAutoFlushFrames(final boolean enabled) {
      // TODO Auto-generated method stub
  }

  @Override
  public void create(final boolean waitFor) {
        String render = System.getProperty("awt.background.render", AppSettings.LWJGL_OPENGL33);
        backgroundContext.getSettings().setRenderer(render);
        backgroundContext.create(waitFor);
  }

  @Override
  public void restart() {
  }

  @Override
  public void destroy(final boolean waitFor) {
      if (backgroundContext == null) throw new IllegalStateException("Not created");
      // destroy wrapped context
      backgroundContext.destroy(waitFor);
}

    /**
     * Returns the height of the framebuffer.
     *
     * @return the height (in pixels)
     */
    @Override
    public int getFramebufferHeight() {
        return height;
    }

    /**
     * Returns the width of the framebuffer.
     *
     * @return the width (in pixels)
     */
    @Override
    public int getFramebufferWidth() {
        return width;
    }

    /**
     * Returns the screen X coordinate of the left edge of the content area.
     *
     * @throws UnsupportedOperationException
     */
    @Override
    public int getWindowXPosition() {
        throw new UnsupportedOperationException("not implemented yet");
    }

    /**
     * Returns the screen Y coordinate of the top edge of the content area.
     *
     * @throws UnsupportedOperationException
     */
    @Override
    public int getWindowYPosition() {
        throw new UnsupportedOperationException("not implemented yet");
    }
}