CanvasFPSListener.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.loop;

import org.xith3d.render.Canvas3D;

/**
 * This FPSListener prints the cought FPS to the Canvas3D's title.
 * This is of course only visible in windowed mode.
 * 
 * @author Marvin Froehlich (aka Qudus)
 */
public class CanvasFPSListener extends TitleFPSListener
{
    private final Canvas3D canvas;
    
    /**
     * {@inheritDoc}
     */
    @Override
    protected final void onDetachedFromRenderLoop()
    {
        canvas.setTitle( getBaseTitle() );
    }
    
    /**
     * {@inheritDoc}
     */
    @Override
    protected boolean isLimited()
    {
        boolean result = super.isLimited();
        
        if ( result )
            return ( true );
        
        return ( canvas.getPeer().isVSyncEnabled() );
    }
    
    /**
     * {@inheritDoc}
     */
    @Override
    protected String getLimitedString()
    {
        if ( canvas.getPeer().isVSyncEnabled() )
        {
            if ( super.isLimited() )
                return ( " (limited, v-sync)" );
            
            return ( " (v-sync)" );
        }
        
        if ( super.isLimited() )
            return ( super.getLimitedString() );
        
        return ( "" );
    }
    
    /**
     * {@inheritDoc}
     */
    @Override
    protected void setTitle( String title )
    {
        canvas.setTitle( title );
    }
    
    public CanvasFPSListener( Canvas3D canvas )
    {
        super( canvas.getTitle() );
        
        this.canvas = canvas;
    }
}