HUDTextureUtils.java

/**
 * Copyright (c) 2003-2008, 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.ui.hud.utils;

import org.jagatoo.opengl.enums.TextureFormat;
import org.xith3d.loaders.texture.TextureLoader;
import org.xith3d.loaders.texture.TextureLoader.FlipMode;
import org.xith3d.scenegraph.Texture2D;
import org.xith3d.scenegraph.TextureImage2D;
import org.xith3d.scenegraph.Texture.MipmapMode;

/**
 * Insert type comment here.
 * 
 * @author Marvin Froehlich (aka Qudus)
 */
public class HUDTextureUtils
{
    public static final int getTextureWidth( TextureImage2D texture, boolean isDrawTexture )
    {
        if ( isDrawTexture )
            return ( texture.getOriginalWidth() );
        
        return ( texture.getWidth() );
    }
    
    public static final int getTextureHeight( TextureImage2D texture, boolean isDrawTexture )
    {
        if ( isDrawTexture )
            return ( texture.getOriginalHeight() );
        
        return ( texture.getHeight() );
    }
    
    public static final int getTextureWidth( Texture2D texture )
    {
        return ( getTextureWidth( texture.getImage0(), texture.isDrawTexture() ) );
    }
    
    public static final int getTextureHeight( Texture2D texture )
    {
        return ( getTextureHeight( texture.getImage0(), texture.isDrawTexture() ) );
    }
    
    public static final Texture2D getTexture( String textureName, boolean useCache )
    {
        if ( textureName == null )
            return ( null );
        
        return ( TextureLoader.getInstance().getTexture( textureName, (FlipMode)null, (TextureFormat)null, MipmapMode.BASE_LEVEL, false, useCache, true ) );
    }
    
    public static final Texture2D getTexture( String textureName )
    {
        return ( getTexture( textureName, true ) );
    }
    
    public static final Texture2D getTextureOrNull( String textureName, boolean useCache )
    {
        Texture2D texture = getTexture( textureName, useCache );
        
        if ( TextureLoader.isFallbackTexture( texture ) )
            return ( null );
        
        return ( texture );
    }
    
    public static final Texture2D getTextureOrNull( String textureName )
    {
        return ( getTextureOrNull( textureName, true ) );
    }
}