ButtonToggle.java

/**
 * File name:	ButtonToggle.java
 * Version:		1.0
 * Date:		@date 13:14:42
 * Author:		Sawan J. Kapai Harpalani
 * Copyright:	Copyright 200X Sawan J. Kapai Harpalani
 *
 *				This file is part of Math Attack.
 *
 *				Math Attack 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.
 *
 *				Math Attack 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 Math Attack. If not, see 
 *				http://www.gnu.org/licenses/.
 */

package com.sawan.mathattack.scene2d.ui;

import com.badlogic.gdx.graphics.g2d.BitmapFont;
import com.badlogic.gdx.graphics.g2d.SpriteBatch;
import com.badlogic.gdx.graphics.g2d.TextureRegion;
import com.badlogic.gdx.scenes.scene2d.Actor;
import com.badlogic.gdx.scenes.scene2d.utils.Drawable;

// TODO: Auto-generated Javadoc
/**
 * The Class ButtonToggle.
 */
public class ButtonToggle extends AbstractButton {
	// Toggle textures & condition
	/** The texture toggle on. */
	private TextureRegion textureToggleOn;
	
	/** The texture toggle off. */
	private TextureRegion textureToggleOff;
	
	/** The is toggle active. */
	private boolean isToggleActive = false;

	/**
	 * Instantiates a new button toggle.
	 *
	 * @param bitMapFont the bit map font
	 * @param up the up
	 * @param down the down
	 * @param toggleOn the toggle on
	 * @param toggleOff the toggle off
	 * @param isToggleActive the is toggle active
	 */
	public ButtonToggle(BitmapFont bitMapFont, Drawable up, Drawable down,
			TextureRegion toggleOn, TextureRegion toggleOff,
			boolean isToggleActive) {
		super(bitMapFont, up, down);
		//
		textureToggleOn = toggleOn;
		textureToggleOff = toggleOff;
		this.isToggleActive = isToggleActive;
	}

	/**
	 * Instantiates a new button toggle.
	 *
	 * @param bitMapFont the bit map font
	 * @param up the up
	 * @param down the down
	 * @param toggleOn the toggle on
	 * @param toggleOff the toggle off
	 * @param isToggleActive the is toggle active
	 * @param width the width
	 * @param height the height
	 * @param DIPActive the DIP active
	 */
	public ButtonToggle(BitmapFont bitMapFont, Drawable up, Drawable down,
			TextureRegion toggleOn, TextureRegion toggleOff,
			boolean isToggleActive, float width, float height, boolean DIPActive) {
		super(bitMapFont, up, down, width, height, DIPActive);
		//
		textureToggleOn = toggleOn;
		textureToggleOff = toggleOff;
		this.isToggleActive = isToggleActive;
	}

	/* (non-Javadoc)
	 * @see com.badlogic.gdx.scenes.scene2d.ui.Button#draw(com.badlogic.gdx.graphics.g2d.SpriteBatch, float)
	 */
	@Override
	public void draw(SpriteBatch batch, float parentAlpha) {
		// If button locked
		// ##################################################################
		if (isToggleActive && textureLocked != null) {
			drawLocked(batch);
		}

		// If text set and intented to be used
		// ##################################################################
		else if (text != "" && bitMapFont != null && isTextActive) {
			// super.draw(batch, parentAlpha);
			drawToggle(batch);
			drawText(batch);
			drawExternalTexture(batch);
		}

		// Draw default
		// ##################################################################
		else {
			// super.draw(batch, parentAlpha);
			drawToggle(batch);
			drawExternalTexture(batch);
		}
	}

	/* (non-Javadoc)
	 * @see com.sawan.mathattack.scene2d.ui.AbstractButton#hit(float, float, boolean)
	 */
	@Override
	public Actor hit(float x, float y, boolean t) {
		if (!isLockActive) {
			// If not locked detect the inputs

			// FIXME ButtonToggle requires manually switch each time, fix this
			// Otherwise hit method being called every frame so it swritches
			// every frame
			// setToggleSwith();
			return super.hit(x, y, t);
		} else {
			// If locked do not detect any hit by returning NULL
			return null;
		}
	}

	/**
	 * Draw toggle.
	 *
	 * @param batch the batch
	 */
	private void drawToggle(SpriteBatch batch) {
		if (isToggleActive) {
			batch.draw(textureToggleOn, getX(), getY(), getWidth(), getHeight());
		} else {
			batch.draw(textureToggleOff, getX(), getY(), getWidth(),
					getHeight());

		}
	}

	/**
	 * Draw external texture.
	 *
	 * @param batch the batch
	 */
	private void drawExternalTexture(SpriteBatch batch) {
		if (isExternalTextureActive && textureExternal != null) {
			batch.draw(textureExternal, getX() + externalTexturePosX, getY()
					+ externalTexturePosY, externalTextureSizeW,
					externalTextureSizeH);
		}
	}

	/**
	 * Draw locked.
	 *
	 * @param batch the batch
	 */
	private void drawLocked(SpriteBatch batch) {
		batch.draw(textureLocked, getX(), getY(), getWidth(), getHeight());
	}

	/**
	 * Draw text.
	 *
	 * @param batch the batch
	 */
	private void drawText(SpriteBatch batch) {
		bitMapFont.draw(batch, text, getX() + textPosX, getY() + textPosY);
	}

	/**
	 * Gets the texture toggle on.
	 *
	 * @return the texture toggle on
	 */
	public TextureRegion getTextureToggleOn() {
		return textureToggleOn;
	}

	/**
	 * Sets the texture toggle on.
	 *
	 * @param textureToggleOn the new texture toggle on
	 */
	public void setTextureToggleOn(TextureRegion textureToggleOn) {
		this.textureToggleOn = textureToggleOn;
	}

	/**
	 * Gets the texture toggle off.
	 *
	 * @return the texture toggle off
	 */
	public TextureRegion getTextureToggleOff() {
		return textureToggleOff;
	}

	/**
	 * Sets the texture toggle off.
	 *
	 * @param textureToggleOff the new texture toggle off
	 */
	public void setTextureToggleOff(TextureRegion textureToggleOff) {
		this.textureToggleOff = textureToggleOff;
	}

	/**
	 * Checks if is toggle active.
	 *
	 * @return true, if is toggle active
	 */
	public boolean isToggleActive() {
		return isToggleActive;
	}

	/**
	 * Sets the toggle active.
	 *
	 * @param isToggleActive the new toggle active
	 */
	public void setToggleActive(boolean isToggleActive) {
		this.isToggleActive = isToggleActive;
	}

	/**
	 * Sets the toggle switch.
	 */
	public void setToggleSwitch() {
		if (isToggleActive) {
			isToggleActive = false;
		} else {
			isToggleActive = true;
		}
	}
}