jMonkeyEngine/jme3-examples/src/main/java/jme3test/renderer/TestBackgroundImage.java

/*
 * Copyright (c) 2021 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 jme3test.renderer;

import com.jme3.anim.util.AnimMigrationUtils;
import com.jme3.app.SimpleApplication;
import com.jme3.light.AmbientLight;
import com.jme3.light.DirectionalLight;
import com.jme3.material.Material;
import com.jme3.material.Materials;
import com.jme3.math.ColorRGBA;
import com.jme3.math.Vector3f;
import com.jme3.renderer.Camera;
import com.jme3.renderer.ViewPort;
import com.jme3.renderer.queue.RenderQueue;
import com.jme3.scene.Geometry;
import com.jme3.scene.Mesh;
import com.jme3.scene.Node;
import com.jme3.scene.Spatial;
import com.jme3.scene.shape.Quad;
import com.jme3.texture.Texture;
import java.util.List;

/**
 * Demonstrates how to render an non-moving background image using a pre
 * ViewPort.
 *
 * @author Stephen Gold [email protected]
 */
public class TestBackgroundImage extends SimpleApplication {

    private static ViewPort backgroundViewport;

    public static void main(String[] args) {
        new TestBackgroundImage().start();
    }

    @Override
    public void simpleInitApp() {
        /*
         * SimpleApplication creates 2 viewports:
         * 1. the default viewport (rendered first, after clearing all buffers)
         * 2. the GUI viewport (rendered last, without clearing any buffers)
         *
         * Create a 3rd ViewPort, named "background viewport",
         * to be rendered BEFORE the default viewport.
         */
        Camera backgroundCamera = guiViewPort.getCamera().clone();
        backgroundViewport = renderManager.createPreView(
                "background viewport", backgroundCamera);
        /*
         * Don't clear the color buffer before drawing the main viewport.
         * Clearing the color buffer would hide the background.
         */
        boolean clearColorBuffer = false;
        viewPort.setClearFlags(clearColorBuffer, true, true);
        /*
         * Create a quad to display the JMonkeyEngine logo,
         * assign it to the Gui bucket,
         * and attach it to the background viewport.
         */
        Texture quadTexture
                = assetManager.loadTexture("Interface/Logo/Monkey.png");
        Material quadMaterial = new Material(assetManager, Materials.UNSHADED);
        quadMaterial.setTexture("ColorMap", quadTexture);

        float quadHeight = backgroundCamera.getHeight();
        float quadWidth = backgroundCamera.getWidth();
        Mesh quadMesh = new Quad(quadWidth, quadHeight);

        Spatial quadGeometry = new Geometry("quad geometry", quadMesh);
        quadGeometry.setMaterial(quadMaterial);
        quadGeometry.setQueueBucket(RenderQueue.Bucket.Gui);
        backgroundViewport.attachScene(quadGeometry);
        /*
         * Add Jaime model and lighting to the default scene.
         */
        loadModel();
        setupLights();
        /*
         * Speed up camera motion for convenience.
         */
        flyCam.setMoveSpeed(8f);
    }

    @Override
    public void simpleUpdate(float timePerFrame) {
        /*
         * Since SimpleApplication is unaware of the background viewport,
         * the application must explictly update its scenes.
         */
        List<Spatial> scenes = backgroundViewport.getScenes();
        for (Spatial scene : scenes) {
            scene.updateLogicalState(timePerFrame);
            scene.updateGeometricState();
        }
    }

    private void loadModel() {
        Node jaime = (Node) assetManager.loadModel("Models/Jaime/Jaime.j3o");
        AnimMigrationUtils.migrate(jaime);
        jaime.scale(3f);
        rootNode.attachChild(jaime);
    }

    private void setupLights() {
        AmbientLight ambient = new AmbientLight();
        ambient.setColor(new ColorRGBA(0.2f, 0.2f, 0.2f, 1f));
        rootNode.addLight(ambient);

        DirectionalLight sun = new DirectionalLight();
        sun.setDirection(new Vector3f(0f, -1f, -1f).normalizeLocal());
        sun.setColor(ColorRGBA.White.mult(1.5f));
        rootNode.addLight(sun);
    }
}