ScheduledTextureChanger.java

/**
 * Copyright (c) 2003-2009, Xith3D Project Group all rights reserved.
 * 
 * Portions based on the Java3D interface, Copyright by Sun Microsystems.
 * Many thanks to the developers of Java3D and Sun Microsystems for their
 * innovation and design.
 * 
 * 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 the 'Xith3D Project Group' 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) A
 * RISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE
 */
package org.xith3d.schedops.properties;

import org.xith3d.loop.UpdatingThread.TimingMode;
import org.xith3d.loop.opscheduler.OperationScheduler;
import org.xith3d.loop.opscheduler.ScheduledOperation;

import org.xith3d.scenegraph.Appearance;
import org.xith3d.scenegraph.Texture;

/**
 * Schedules a Texture change (thread safely).
 * 
 * @author Marvin Froehlich (aka Qudus)
 */
public class ScheduledTextureChanger implements ScheduledOperation
{
    private OperationScheduler opScheder;
    
    private Appearance app;
    private Texture texture;
    
    /**
     * If this operation is persistent, it remains scheduled after beeing
     * executed once.
     */
    public boolean isPersistent()
    {
        return ( false );
    }
    
    /**
     * Sets this Object alive or dead.
     * 
     * @param alive if false, the object will be removed from the scheduler
     *              next loop iteration
     */
    public void setAlive( boolean alive )
    {
    }
    
    /**
     * @return false, if the object will be removed from the scheduler next
     *         loop iteration
     */
    public boolean isAlive()
    {
        return ( true );
    }
    
    /**
     * {@inheritDoc}
     */
    public void update( long gameTime, long frameTime, TimingMode timingMode )
    {
        app.setTexture( texture );
    }
    
    /**
     * Creates a new TextureChanger.
     * 
     * @param texture the new Texture
     */
    public void setTexture( Texture texture )
    {
        this.texture = texture;
        
        opScheder.scheduleOperation( this );
    }
    
    /**
     * Creates a new TextureChanger.
     * 
     * @param opScheder the OperationScheduler to handle this operation
     * @param app the Appearance that holds the Texture
     */
    public ScheduledTextureChanger( OperationScheduler opScheder, Appearance app )
    {
        this.opScheder = opScheder;
        this.app = app;
    }
}