/*
* Copyright (c) 2003-onwards Shaven Puppy Ltd
* 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 'Shaven Puppy' 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 net.puppygames.applet.widgets;
import net.puppygames.applet.Bounded;
import org.lwjgl.util.ReadablePoint;
import com.shavenpuppy.jglib.sprites.Sprite;
import com.shavenpuppy.jglib.sprites.SpriteAllocator;
/**
* Instances of the powerdisplay
*/
public interface PowerDisplay extends Bounded {
/**
* Set the number of used bars
*/
public void setUsed(int used);
/**
* Gets the bar under the absolute location (x, y). If no bar is under
* this point then -1 is returned.
* @param x
* @param y
* @return int
*/
public int getBarAt(int x, int y);
/**
* Get the location of a bar
* @param idx The bar index
* @return the bar's location
*/
public ReadablePoint getBarLocation(int idx);
/**
* @return the number of used bars
*/
public int getUsed();
/**
* @return the capacity (total number of bars)
*/
public int getMax();
/**
* Set the location of the powerbar
*/
public void setLocation(float x, float y);
/**
* Set the screen to use and initialise
* @param screen
*/
public void init(SpriteAllocator screen);
/**
* Cleanup and remove
*/
public void cleanup();
/**
* Set alpha
* @param alpha 0..255
*/
public void setAlpha(int alpha);
/**
* Set visibility
* @param visible
*/
public void setVisible(boolean visible);
public Sprite getSprite(int idx);
public boolean isVisible();
public PowerDisplayFeature getFeature();
public void onResized();
}