controlp5/src/controlP5/Slider2D.java

package controlP5;

/**
 * controlP5 is a processing gui library.
 * 
 * 2006-2015 by Andreas Schlegel
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General
 * Public License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307 USA
 * 
 * @author Andreas Schlegel (http://www.sojamo.de)
 * @modified ##date##
 * @version ##version##
 * 
 */

import processing.core.PApplet;
import processing.core.PGraphics;

/**
 * The Slider2D allows to control a handle within a 2D area. This controller returns an arrayValue
 * with the current xy position of its handle.
 * 
 * @author andreas schlegel
 * 
 * @example controllers/ControlP5slider2D
 * 
 */
public class Slider2D extends Controller< Slider2D > {

	protected int cursorWidth = 6 , cursorHeight = 6;
	protected float cursorX , cursorY;
	protected float _myMinX , _myMinY;
	protected float _myMaxX , _myMaxY;
	public boolean isCrosshairs = true;

	private String _myValueLabelSeparator = ",";

	/**
	 * Convenience constructor to extend Slider2D.
	 * 
	 * @example use/ControlP5extendController
	 * @param theControlP5
	 * @param theName
	 */
	public Slider2D( ControlP5 theControlP5 , String theName ) {
		this( theControlP5 , theControlP5.getDefaultTab( ) , theName , 0 , 0 , 99 , 9 );
		theControlP5.register( theControlP5.papplet , theName , this );
	}

	protected Slider2D( ControlP5 theControlP5 , ControllerGroup< ? > theParent , String theName , int theX , int theY , int theWidth , int theHeight ) {
		super( theControlP5 , theParent , theName , theX , theY , theWidth , theHeight );
		_myArrayValue = new float[] { 0.0f , 0.0f };
		_myMinX = 0;
		_myMinY = 0;
		_myMaxX = theWidth;
		_myMaxY = theHeight;
		getCaptionLabel( ).setPadding( 0 , Label.paddingY ).align( LEFT , BOTTOM_OUTSIDE );
		getValueLabel( ).setPadding( 0 , Label.paddingY ).align( RIGHT , BOTTOM_OUTSIDE );
	}

	/* (non-Javadoc)
	 * 
	 * @see controlP5.Controller#updateInternalEvents(processing.core.PApplet) */
	@ControlP5.Invisible public Slider2D updateInternalEvents( PApplet theApplet ) {
		if ( isInside( ) ) {
			if ( !cp5.isAltDown( ) ) {
				float tX = PApplet.constrain( _myControlWindow.mouseX - ( x( _myParent.getAbsolutePosition( ) ) + x( position ) ) , 0 , getWidth( ) - cursorWidth );
				float tY = PApplet.constrain( _myControlWindow.mouseY - ( y( _myParent.getAbsolutePosition( ) ) + y( position ) ) , 0 , getHeight( ) - cursorHeight );
				if ( isMousePressed ) {
					cursorX = tX;
					cursorY = tY;
					updateValue( );
				}
			}
		}
		return this;
	}

	Slider2D updateValue( ) {
		return setValue( 0 );
	}

	public Slider2D setMinMax( float theMinX , float theMinY , float theMaxX , float theMaxY ) {
		_myMinX = theMinX;
		_myMinY = theMinY;
		_myMaxX = theMaxX;
		_myMaxY = theMaxY;
		return setValue( _myArrayValue[ 0 ] , _myArrayValue[ 1 ] );
	}

	/**
	 * sets the minimum value for the x-axis
	 * 
	 * @param theMinX
	 * @return Slider2D
	 */
	public Slider2D setMinX( float theMinX ) {
		_myMinX = theMinX;
		return updateValue( );
	}

	/**
	 * sets the minimum value for the y-axis
	 * 
	 * @param theMinY
	 * @return Slider2D
	 */
	public Slider2D setMinY( float theMinY ) {
		_myMinY = theMinY;
		return updateValue( );
	}

	/**
	 * sets the maximum value for the x-axis
	 * 
	 * @param theMaxX
	 * @return Slider2D
	 */
	public Slider2D setMaxX( float theMaxX ) {
		_myMaxX = theMaxX;
		return updateValue( );
	}

	/**
	 * sets the maximum value for the y-axis
	 * 
	 * @param theMaxY
	 * @return Slider2D
	 */
	public Slider2D setMaxY( float theMaxY ) {
		_myMaxY = theMaxY;
		return updateValue( );
	}

	public float getMinX( ) {
		return _myMinX;
	}

	public float getMinY( ) {
		return _myMinY;
	}

	public float getMaxX( ) {
		return _myMaxX;
	}

	public float getMaxY( ) {
		return _myMaxY;
	}

	public float getCursorX( ) {
		return cursorX;
	}

	public float getCursorY( ) {
		return cursorY;
	}

	public float getCursorWidth( ) {
		return cursorWidth;
	}

	public float getCursorHeight( ) {
		return cursorHeight;
	}

	public Slider2D disableCrosshair( ) {
		isCrosshairs = false;
		return this;
	}

	public Slider2D enableCrosshair( ) {
		isCrosshairs = true;
		return this;
	}

	/* (non-Javadoc) TODO see https://forum.processing.org/topic/controlp5-slider2d-questions
	 * 
	 * @see controlP5.Controller#setArrayValue(float[]) */
	@Override public Slider2D setArrayValue( float[] theArray ) {
		_myArrayValue = theArray;
		float rX = ( getWidth( ) - cursorWidth ) / ( float ) ( _myMaxX - _myMinX );
		float rY = ( getHeight( ) - cursorHeight ) / ( float ) ( _myMaxY - _myMinY );
		cursorX = PApplet.constrain( theArray[ 0 ] * rX , 0 , getWidth( ) - cursorWidth );
		cursorY = PApplet.constrain( theArray[ 1 ] * rY , 0 , getHeight( ) - cursorHeight );
		return updateValue( );
	}

	public float[] getArrayValue( ) {
		return _myArrayValue;
	}

	public Slider2D setCursorX( float theValue ) {
		return setArrayValue( new float[] { theValue , getArrayValue( )[ 1 ] } );
	}

	public Slider2D setCursorY( float theValue ) {
		return setArrayValue( new float[] { getArrayValue( )[ 0 ] , theValue } );
	}

	/* (non-Javadoc)
	 * 
	 * @see controlP5.Controller#setValue(float) */
	public Slider2D setValue( float theValue ) {
		_myArrayValue[ 0 ] = cursorX / ( ( float ) ( getWidth( ) - cursorWidth ) / ( float ) getWidth( ) );
		_myArrayValue[ 1 ] = cursorY / ( ( float ) ( getHeight( ) - cursorHeight ) / ( float ) getHeight( ) );
		_myArrayValue[ 0 ] = PApplet.map( _myArrayValue[ 0 ] , 0 , getWidth( ) , _myMinX , _myMaxX );
		_myArrayValue[ 1 ] = PApplet.map( _myArrayValue[ 1 ] , 0 , getHeight( ) , _myMinY , _myMaxY );
		_myValueLabel.set( adjustValue( _myArrayValue[ 0 ] , 0 ) + _myValueLabelSeparator + adjustValue( _myArrayValue[ 1 ] , 0 ) );
		broadcast( FLOAT );
		return this;
	}

	public Slider2D setValue( float theValue1 , float theValue2 ) {
		cursorX = PApplet.map( theValue1 , _myMinX , _myMaxX , 0 , getWidth( ) - cursorWidth );
		cursorY = PApplet.map( theValue2 , _myMinY , _myMaxY , 0 , getHeight( ) - cursorHeight );
		return setValue( 0 );
	}

	/**
	 * assigns a random value to the controller.
	 */
	public Slider2D shuffle( ) {
		float rX = ( float ) Math.random( );
		float rY = ( float ) Math.random( );
		_myArrayValue[ 0 ] = rX * getWidth( );
		_myArrayValue[ 0 ] = rY * getHeight( );
		return setValue( 0 );
	}

	public void setValueLabelSeparator( String theSeparator ) {
		_myValueLabelSeparator = theSeparator;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override @ControlP5.Invisible public Slider2D updateDisplayMode( int theMode ) {
		_myDisplayMode = theMode;
		switch ( theMode ) {
		case ( DEFAULT ):
			_myControllerView = new Slider2DView( );
			break;
		case ( IMAGE ):
		case ( SPRITE ):
		case ( CUSTOM ):
		default:
			break;
		}
		return this;
	}

	class Slider2DView implements ControllerView< Slider2D > {

		public void display( PGraphics theGraphics , Slider2D theController ) {

			theGraphics.noStroke( );

			theGraphics.fill( theController.getColor( ).getBackground( ) );
			theGraphics.rect( 0 , 0 , getWidth( ) , getHeight( ) );

			theGraphics.fill( theController.isInside ? theController.getColor( ).getActive( ) : theController.getColor( ).getForeground( ) );
			theGraphics.rect( ( int ) getCursorX( ) , ( int ) getCursorY( ) , ( int ) getCursorWidth( ) , ( int ) getCursorHeight( ) );

			if ( isCrosshairs ) {
				theGraphics.rect( 0 , ( int ) ( getCursorY( ) + getCursorHeight( ) / 2 ) , ( int ) getWidth( ) , 1 );
				theGraphics.rect( ( int ) ( getCursorX( ) + getCursorWidth( ) / 2 ) , 0 , 1 , ( int ) getHeight( ) );
			}

			getCaptionLabel( ).draw( theGraphics , 0 , 0 , theController );
			getValueLabel( ).draw( theGraphics , 0 , 0 , theController );
		}

	}
}