opsu-dance/src/itdelatrisu/opsu/GUIMenuButton.java

/*
 * opsu! - an open-source osu! client
 * Copyright (C) 2014 Jeffrey Han
 *
 * opsu! is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * opsu! is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with opsu!.  If not, see <http://www.gnu.org/licenses/>.
 */

package itdelatrisu.opsu;

import org.newdawn.slick.Animation;
import org.newdawn.slick.Color;
import org.newdawn.slick.Image;

/**
 * A convenience class for menu buttons.
 * Consists of an image or animation and coordinates.
 * Multi-part images and animations currently do not support hover updates.
 */
public class GUIMenuButton {
	/**
	 * The image associated with the button.
	 */
	private Image img;

	/**
	 * The left and right parts of the button (optional).
	 */
	private Image imgL, imgR;

	/**
	 * The animation associated with the button.
	 */
	private Animation anim;

	/**
	 * The center coordinates.
	 */
	private float x, y;

	/**
	 * The x and y radius of the button (scaled).
	 */
	private float xRadius, yRadius;

	/**
	 * The current and max scale of the button (for hovering).
	 */
	private float scale, hoverScale = 1.25f;

	/**
	 * The scaled expansion direction for the botton (for hovering).
	 */
	private Expand dir = Expand.CENTER;

	/**
	 * Scaled expansion directions (for hovering).
	 */
	public enum Expand {
		CENTER, UP_RIGHT, UP_LEFT, DOWN_RIGHT, DOWN_LEFT;
	}

	/**
	 * Creates a new button from an Image.
	 */
	public GUIMenuButton(Image img, float x, float y) {
		this.img = img;
		this.x = x;
		this.y = y;
		this.xRadius = img.getWidth() / 2f;
		this.yRadius = img.getHeight() / 2f;
		this.scale = 1f;
	}

	/**
	 * Creates a new button from a 3-part Image.
	 */
	public GUIMenuButton(Image imgCenter, Image imgLeft, Image imgRight,
			float x, float y) {
		this.img  = imgCenter;
		this.imgL = imgLeft;
		this.imgR = imgRight;
		this.x  = x;
		this.y  = y;
		this.xRadius = (img.getWidth() + imgL.getWidth() + imgR.getWidth()) / 2f;
		this.yRadius = img.getHeight() / 2f;
		this.scale = 1f;
	}

	/**
	 * Creates a new button from an Animation.
	 */
	public GUIMenuButton(Animation anim, float x, float y) {
		this.anim = anim;
		this.x = x;
		this.y = y;
		this.xRadius = anim.getWidth() / 2f;
		this.yRadius = anim.getHeight() / 2f;
		this.scale = 1f;
	}

	/**
	 * Sets/returns new center coordinates.
	 */
	public void setX(float x) { this.x = x; }
	public void setY(float y) { this.y = y; }
	public float getX() { return x; }
	public float getY() { return y; }

	/**
	 * Returns the associated image or animation.
	 */
	public Image getImage() { return img; }
	public Animation getAnimation() { return anim; }

	/**
	 * Draws the button.
	 */
	public void draw() {
		if (img != null) {
			if (imgL == null) {
				Image imgScaled = img.getScaledCopy(scale);
				imgScaled.setAlpha(img.getAlpha());
				imgScaled.draw(x - xRadius, y - yRadius);
			} else {
				img.draw(x - xRadius + imgL.getWidth(), y - yRadius);
				imgL.draw(x - xRadius, y - yRadius);
				imgR.draw(x + xRadius - imgR.getWidth(), y - yRadius);
			}
		} else
			anim.draw(x - xRadius, y - yRadius);
	}

	/**
	 * Draw the button with a color filter.
	 * @param filter the color to filter with when drawing
	 */
	public void draw(Color filter) {
		if (img != null) {
			if (imgL == null)
				img.getScaledCopy(scale).draw(x - xRadius, y - yRadius, filter);
			else {
				img.draw(x - xRadius + imgL.getWidth(), y - yRadius, filter);
				imgL.draw(x - xRadius, y - yRadius, filter);
				imgR.draw(x + xRadius - imgR.getWidth(), y - yRadius, filter);
			}
		} else
			anim.draw(x - xRadius, y - yRadius, filter);
	}

	/**
	 * Returns true if the coordinates are within the button bounds.
	 * @param cx the x coordinate
	 * @param cy the y coordinate
	 */
	public boolean contains(float cx, float cy) {
		return ((cx > x - xRadius && cx < x + xRadius) &&
				(cy > y - yRadius && cy < y + yRadius));
	}

	/**
	 * Sets the current button scale (for hovering).
	 * @param scale the new scale (default 1.0f)
	 */
	public void setScale(float scale) {
		this.scale = scale;
		setHoverRadius();
	}

	/**
	 * Sets the maximum scale factor for the button (for hovering).
	 * @param scale the maximum scale factor (default 1.25f)
	 */
	public void setHoverScale(float scale) {
		this.hoverScale = scale;
	}

	/**
	 * Sets the expansion direction when hovering over the button.
	 * @param dir the direction
	 */
	public void setHoverDir(Expand dir) {
		this.dir = dir;
	}

	/**
	 * Updates the scale of the button depending on whether or not the cursor
	 * is hovering over the button.
	 * @param delta the delta interval
	 * @param cx the x coordinate
	 * @param cy the y coordinate
	 */
	public void hoverUpdate(int delta, float cx, float cy) {
		boolean isHover = contains(cx, cy);
		if (isHover && scale < hoverScale) {
			scale += (hoverScale - 1f) * delta / 100f;
			if (scale > hoverScale)
				scale = hoverScale;
			setHoverRadius();
		} else if (!isHover && scale > 1f) {
			scale -= (hoverScale - 1f) * delta / 100f;
			if (scale < 1f)
				scale = 1f;
			setHoverRadius();
		}
	}

	/**
	 * Set x and y radius of the button based on current scale factor
	 * and expansion direction.
	 */
	private void setHoverRadius() {
		int xOffset = 0, yOffset = 0;
		if (dir != Expand.CENTER) {
			// offset by difference between normal/scaled image dimensions
			xOffset = (int) ((scale - 1f) * img.getWidth());
			yOffset = (int) ((scale - 1f) * img.getHeight());
			if (dir == Expand.DOWN_RIGHT || dir == Expand.UP_RIGHT)
				xOffset *= -1;  // flip x for right
			if (dir == Expand.DOWN_LEFT || dir == Expand.DOWN_RIGHT)
				yOffset *= -1;  // flip y for down
		}
		this.xRadius = ((img.getWidth() * scale) + xOffset) / 2f;
		this.yRadius = ((img.getHeight() * scale) + yOffset) / 2f;
	}
}