159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta/* 259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Copyright (c) 2009-2010 jMonkeyEngine 359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * All rights reserved. 459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Redistribution and use in source and binary forms, with or without 659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * modification, are permitted provided that the following conditions are 759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * met: 859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Redistributions of source code must retain the above copyright 1059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * notice, this list of conditions and the following disclaimer. 1159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 1259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Redistributions in binary form must reproduce the above copyright 1359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * notice, this list of conditions and the following disclaimer in the 1459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * documentation and/or other materials provided with the distribution. 1559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 1659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * * Neither the name of 'jMonkeyEngine' nor the names of its contributors 1759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * may be used to endorse or promote products derived from this software 1859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * without specific prior written permission. 1959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 2059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 2259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 2359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 2459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 2559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 2659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 2759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 2859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 2959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 3059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 3259b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapackage com.jme3.scene.control; 3359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 3459b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.app.AppTask; 3559b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.renderer.RenderManager; 3659b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.renderer.ViewPort; 3759b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport com.jme3.scene.Spatial; 3859b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport java.util.concurrent.Callable; 3959b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport java.util.concurrent.ConcurrentLinkedQueue; 4059b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartaimport java.util.concurrent.Future; 4159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 4259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta/** 4359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Allows for enqueueing tasks onto the update loop / rendering thread. 4459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 4559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Usage: 4659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * mySpatial.addControl(new UpdateControl()); // add it once 4759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * mySpatial.getControl(UpdateControl.class).enqueue(new Callable() { 4859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * public Object call() throws Exception { 4959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * // do stuff here 5059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * return null; 5159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * } 5259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * }); 5359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * 5459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * @author Brent Owens 5559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 5659b2e6871c65f58fdad78cd7229c292f6a177578Scott Bartapublic class UpdateControl extends AbstractControl { 5759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 5859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta private final ConcurrentLinkedQueue<AppTask<?>> taskQueue = new ConcurrentLinkedQueue<AppTask<?>>(); 5959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 6059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta /** 6159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * Enqueues a task/callable object to execute in the jME3 6259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta * rendering thread. 6359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta */ 6459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public <V> Future<V> enqueue(Callable<V> callable) { 6559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta AppTask<V> task = new AppTask<V>(callable); 6659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta taskQueue.add(task); 6759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return task; 6859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 6959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 7059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 7159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta protected void controlUpdate(float tpf) { 7259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta AppTask<?> task = taskQueue.poll(); 7359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta toploop: do { 7459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (task == null) break; 7559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta while (task.isCancelled()) { 7659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta task = taskQueue.poll(); 7759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta if (task == null) break toploop; 7859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 7959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta task.invoke(); 8059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } while (((task = taskQueue.poll()) != null)); 8159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 8259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 8359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta @Override 8459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta protected void controlRender(RenderManager rm, ViewPort vp) { 8559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 8659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 8759b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 8859b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta public Control cloneForSpatial(Spatial newSpatial) { 8959b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta UpdateControl control = new UpdateControl(); 9059b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta control.setSpatial(newSpatial); 9159b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta control.setEnabled(isEnabled()); 9259b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta control.taskQueue.addAll(taskQueue); 9359b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta return control; 9459b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta } 9559b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta 9659b2e6871c65f58fdad78cd7229c292f6a177578Scott Barta} 97