G4P (GUI for Processing)  4.3.8
A set of GUI controls for your Processing sketch.
 All Classes Functions Variables Pages
g4p_controls.GCustomSlider Class Reference
Inheritance diagram for g4p_controls.GCustomSlider:

Public Member Functions

 GCustomSlider (PApplet theApplet, float p0, float p1, float p2, float p3)
 
 GCustomSlider (PApplet theApplet, float p0, float p1, float p2, float p3, String skin)
 
void setStyle (String skin)
 
- Public Member Functions inherited from g4p_controls.GLinearTrackControl
void draw ()
 
float getTrackOffset ()
 
String getValueS ()
 
 GLinearTrackControl (PApplet theApplet, float p0, float p1, float p2, float p3)
 
void mouseEvent (MouseEvent event)
 
void setShowTicks (boolean showTicks)
 
void setTextOrientation (int orient)
 
void setTickLabels (String[] tickLabels)
 
void setTrackOffset (float offset)
 
- Public Member Functions inherited from g4p_controls.GValueControl
float getEasing ()
 
float getEndLimit ()
 
int getNbrTicks ()
 
int getPrecision ()
 
float getStartLimit ()
 
String getUnit ()
 
float getValueF ()
 
int getValueI ()
 
String getValueS ()
 
int getValueType ()
 
 GValueControl (PApplet theApplet, float p0, float p1, float p2, float p3)
 
boolean isShowLimits ()
 
boolean isShowTicks ()
 
boolean isShowValue ()
 
boolean isStickToTicks ()
 
void pre ()
 
void setEasing (float easeBy)
 
void setLimits (int start, int end)
 
void setLimits (int initValue, int start, int end)
 
void setLimits (float start, float end)
 
void setLimits (float initValue, float start, float end)
 
void setNbrTicks (int noOfTicks)
 
void setNumberFormat (int numberFormat, int precision, String unit)
 
void setNumberFormat (int numberFormat, int precision)
 
void setNumberFormat (int numberFormat)
 
void setPrecision (int nd)
 
void setShowDecor (boolean opaque, boolean ticks, boolean value, boolean limits)
 
void setShowLimits (boolean showLimits)
 
void setShowTicks (boolean showTicks)
 
void setShowValue (boolean showValue)
 
void setStickToTicks (boolean stickToTicks)
 
void setUnits (String units)
 
void setValue (float v)
 
- Public Member Functions inherited from g4p_controls.GAbstractControl
void addControl (GAbstractControl c, float x, float y, float angle)
 
void addControl (GAbstractControl c, float x, float y)
 
void addControl (GAbstractControl c)
 
void addControls (GAbstractControl...controls)
 
void addEventHandler (Object obj, String methodName)
 
void dispose ()
 
void draw ()
 
void forceBufferUpdate ()
 
 GAbstractControl (PApplet theApplet)
 
 GAbstractControl (PApplet theApplet, float p0, float p1)
 
 GAbstractControl (PApplet theApplet, float p0, float p1, float p2, float p3)
 
int getAlpha ()
 
int getCursorOver ()
 
float getCX ()
 
float getCY ()
 
float getHeight ()
 
int getLocalColorScheme ()
 
PApplet getPApplet ()
 
GAbstractControl getParent ()
 
PGraphics getSnapshot ()
 
float getWidth ()
 
float getX ()
 
float getY ()
 
boolean hasFocus ()
 
boolean isDragging ()
 
boolean isEnabled ()
 
boolean isOpaque ()
 
boolean isVisible ()
 
void keyEvent (KeyEvent e)
 
void mouseEvent (MouseEvent event)
 
void moveTo (float px, float py)
 
void moveTo (float px, float py, GControlMode mode)
 
void post ()
 
void pre ()
 
boolean saveSnapshot ()
 
boolean saveSnapshot (String filename)
 
void setAlpha (int alpha)
 
void setAlpha (int alpha, boolean includeChildren)
 
void setCursorOver (int cursorOver)
 
void setEnabled (boolean enable)
 
void setFocus (boolean focus)
 
void setLocalColor (int colorNo, int color)
 
void setLocalColorScheme (int cs)
 
void setLocalColorScheme (int cs, boolean includeChildren)
 
void setOpaque (boolean opaque)
 
void setRotation (float angle)
 
void setRotation (float angle, GControlMode mode)
 
void setVisible (boolean visible)
 
String toString ()
 

Protected Member Functions

float calcTrackOffset ()
 
void updateBuffer ()
 
void updateDueToValueChanging ()
 
- Protected Member Functions inherited from g4p_controls.GLinearTrackControl
float calcTrackOffset ()
 
void drawLabels (Graphics2D g2d)
 
void drawLimits (Graphics2D g2d)
 
void drawValue (Graphics2D g2d)
 
- Protected Member Functions inherited from g4p_controls.GValueControl
float calcParametricTarget (float pt)
 
float findNearestTickValueTo (float p)
 
String getNumericDisplayString (float number)
 
void setEpsilon ()
 
void updateDueToValueChanging ()
 
- Protected Member Functions inherited from g4p_controls.GAbstractControl
void addToParent (GAbstractControl p)
 
void calcTransformedOrigin (float px, float py)
 
void createEventHandler (Object handlerObj, String methodName, Class[] param_classes, String[] param_names)
 
void fireEvent (Object...objects)
 
int focusObjectZ ()
 
PGraphics getBuffer ()
 
int getCurrHotSpot ()
 
AffineTransform getTransform (AffineTransform aff)
 
boolean isAvailable ()
 
boolean isDisplayable (int ascii)
 
boolean isSuitableForGroupControl (GAbstractControl control)
 
void loseFocus (GAbstractControl grabber)
 
void makeBuffer ()
 
void resize (int w, int h)
 
void setAvailable (boolean avail)
 
void setTextRenderingHints (Graphics2D g2d, int hint)
 
void setZ (int parentZ)
 
void takeFocus ()
 
void updateBuffer ()
 
int whichHotSpot (float px, float py)
 

Protected Attributes

PImage centre
 
PImage leftEnd
 
PImage rightEnd
 
PImage thumb
 
PImage thumb_mouseover
 
- Protected Attributes inherited from g4p_controls.GLinearTrackControl
int downHotSpot = -1
 
StyledString[] labels
 
boolean labelsInvalid = true
 
Font localFont = G4P.sliderFont
 
int status = OFF_CONTROL
 
int textOrientation = ORIENT_TRACK
 
float trackOffset
 
float trackWidth
 
- Protected Attributes inherited from g4p_controls.GValueControl
float easing = 1.0f
 
boolean limitsInvalid = true
 
int nbrTicks = 2
 
float offset
 
float parametricPos = 0.5f
 
int precision = 2
 
boolean showLimits = false
 
boolean showTicks = false
 
boolean showValue = false
 
StyledString ssStartLimit
 
float startLimit = 0
 
boolean stickToTicks = false
 
String unit = ""
 
boolean valueInvalid = true
 
int valueType = DECIMAL
 
float wheelDelta = WHEEL_DELTA
 
- Protected Attributes inherited from g4p_controls.GAbstractControl
int alphaLevel = G4P.globalAlpha
 
PGraphicsJava2D buffer = null
 
boolean bufferInvalid = true
 
LinkedList< GAbstractControlchildren = null
 
int currSpot = -1
 
int cursorOver = HAND
 
float cx
 
boolean dragging = false
 
Method eventHandlerMethod = null
 
String eventHandlerMethodName
 
Object eventHandlerObject = null
 
float halfWidth
 
HotSpot[] hotspots = null
 
int localColorScheme = G4P.globalColorScheme
 
boolean opaque = false
 
float ox
 
Color[] palette = null
 
GAbstractControl parent = null
 
int registeredMethods = 0
 
float rotAngle
 
double[] temp = new double[2]
 
float width
 
PApplet winApp
 
float x
 
int z = Z_STICKY
 

Additional Inherited Members

- Public Attributes inherited from g4p_controls.GAbstractControl
String tag = ""
 
int tagNo
 
- Public Attributes inherited from g4p_controls.GConstants
int ALPHA_BLOCK = 128
 
int ALPHA_PICK = 48
 
TextAttribute BACKGROUND = TextAttribute.BACKGROUND
 
int BLUE_SCHEME = 6
 
int BOLD = Font.BOLD
 
int CANCEL = JOptionPane.CANCEL_OPTION
 
int CLOSE_WINDOW = 0x00000f02
 
int CLOSED = JOptionPane.CLOSED_OPTION
 
int CTRL_ANGULAR = 0x00000501
 
int CTRL_HORIZONTAL = 0x00000502
 
int CTRL_VERTICAL = 0x00000503
 
int CYAN_SCHEME = 5
 
int DECIMAL = 1
 
char END = java.awt.event.KeyEvent.VK_END
 
int ERROR_MESSAGE = JOptionPane.ERROR_MESSAGE
 
int EXIT_APP = 0x00000f01
 
int EXPONENT = 2
 
TextAttribute FAMILY = TextAttribute.FAMILY
 
TextAttribute FOREGROUND = TextAttribute.FOREGROUND
 
int FORWARD = 1
 
int GOLD_SCHEME = 7
 
int GREEN_SCHEME = 1
 
int HIDE_WINDOW = 0x00000f04
 
char HOME = java.awt.event.KeyEvent.VK_HOME
 
int INFO_MESSAGE = JOptionPane.INFORMATION_MESSAGE
 
int INTEGER = 0
 
int ITALIC = Font.ITALIC
 
int KEEP_OPEN = 0x00000f03
 
int NO = JOptionPane.NO_OPTION
 
int OK = JOptionPane.OK_OPTION
 
int OK_CANCEL = JOptionPane.OK_CANCEL_OPTION
 
int ORANGE_SCHEME = 4
 
int ORIENT_LEFT = -1
 
int ORIENT_RIGHT = 1
 
int ORIENT_TRACK = 0
 
int PLAIN = Font.PLAIN
 
int PLAIN_MESSAGE = JOptionPane.PLAIN_MESSAGE
 
TextAttribute POSTURE = TextAttribute.POSTURE
 
Float POSTURE_OBLIQUE = new Float(0.20f)
 
Float POSTURE_REGULAR = new Float(0.0f)
 
int PURPLE_SCHEME = 3
 
int QUERY_MESSAGE = JOptionPane.QUESTION_MESSAGE
 
int RED_SCHEME = 0
 
int REVERSE = -1
 
int SCHEME_10 = 10
 
int SCHEME_11 = 11
 
int SCHEME_12 = 12
 
int SCHEME_13 = 13
 
int SCHEME_14 = 14
 
int SCHEME_15 = 15
 
int SCHEME_8 = 8
 
int SCHEME_9 = 9
 
int SCROLLBARS_AUTOHIDE = 0x1000
 
int SCROLLBARS_BOTH = 0x0003
 
int SCROLLBARS_HORIZONTAL_ONLY = 0x0002
 
int SCROLLBARS_NONE = 0x0000
 
int SCROLLBARS_VERTICAL_ONLY = 0x0001
 
TextAttribute SIZE = TextAttribute.SIZE
 
TextAttribute STRIKETHROUGH = TextAttribute.STRIKETHROUGH
 
Boolean STRIKETHROUGH_OFF = new Boolean(false)
 
Boolean STRIKETHROUGH_ON = new Boolean(true)
 
TextAttribute SUPERSCRIPT = TextAttribute.SUPERSCRIPT
 
Integer SUPERSCRIPT_OFF = new Integer(0)
 
Integer SUPERSCRIPT_SUB = new Integer(-1)
 
Integer SUPERSCRIPT_SUPER = new Integer(1)
 
int UNDEFINED = Integer.MAX_VALUE
 
int USER_COL_SCHEME = 0x00010102
 
int WARN_MESSAGE = JOptionPane.WARNING_MESSAGE
 
TextAttribute WEIGHT = TextAttribute.WEIGHT
 
Float WEIGHT_BOLD = new Float(2.0f)
 
Float WEIGHT_DEMIBOLD = new Float(1.75f)
 
Float WEIGHT_DEMILIGHT = new Float(0.875f)
 
Float WEIGHT_EXTRA_LIGHT = new Float(0.5f)
 
Float WEIGHT_EXTRABOLD = new Float(2.5f)
 
Float WEIGHT_HEAVY = new Float(2.25f)
 
Float WEIGHT_LIGHT = new Float(0.75f)
 
Float WEIGHT_MEDIUM = new Float(1.5f)
 
Float WEIGHT_REGULAR = new Float(1.0f)
 
Float WEIGHT_SEMIBOLD = new Float(1.25f)
 
Float WEIGHT_ULTRABOLD = new Float(2.75f)
 
TextAttribute WIDTH = TextAttribute.WIDTH
 
Float WIDTH_CONDENSED = new Float(0.75f)
 
Float WIDTH_EXTENDED = new Float(1.5f)
 
Float WIDTH_REGULAR = new Float(1.0f)
 
Float WIDTH_SEMI_CONDENSED = new Float(0.875f)
 
Float WIDTH_SEMI_EXTENDED = new Float(1.25f)
 
int X4 = 1
 
int X8 = 2
 
int YELLOW_SCHEME = 2
 
int YES = JOptionPane.YES_OPTION
 
int YES_NO = JOptionPane.YES_NO_OPTION
 
int YES_NO_CANCEL = JOptionPane.YES_NO_CANCEL_OPTION
 
- Public Attributes inherited from g4p_controls.GConstantsInternal
int ALL_METHOD = 0x0000001f
 
int CLIP_RUN = 512
 
int COMBI_MODES = 768
 
String DEFAULT_SLIDER_STYLE = "grey_blue"
 
int DRAG_CONTROL = 3
 
int DRAW_METHOD = 0x00000001
 
char EOL = '\n'
 
int EXCP_IN_HANDLER = 0xff000005
 
int[][] grid
 
int GROUP_CONTROL_METHOD = DRAW_METHOD | MOUSE_METHOD | KEY_METHOD
 
int I_CL = 4
 
int I_COVERED = 32
 
int I_CR = 8
 
int I_INSIDE = 16
 
int I_MODES = 63
 
int I_NONE = 0
 
int I_TL = 1
 
int I_TR = 2
 
int INVALID_PAPPLET = 0xff000004
 
int INVALID_TYPE = 0xff000003
 
int KEY_METHOD = 0x00000008
 
int MERGE_RUNS = 256
 
int MISSING = 0xff000001
 
int MOUSE_METHOD = 0x00000002
 
int NONEXISTANT = 0xff000002
 
int OFF_CONTROL = 0
 
int OVER_CONTROL = 1
 
BasicStroke pen_1_0 = new BasicStroke(1, BasicStroke.CAP_ROUND, BasicStroke.JOIN_ROUND)
 
BasicStroke pen_2_0 = new BasicStroke(2, BasicStroke.CAP_ROUND, BasicStroke.JOIN_ROUND)
 
BasicStroke pen_3_0 = new BasicStroke(3, BasicStroke.CAP_ROUND, BasicStroke.JOIN_ROUND)
 
BasicStroke pen_4_0 = new BasicStroke(4, BasicStroke.CAP_ROUND, BasicStroke.JOIN_ROUND)
 
int POST_METHOD = 0x00000010
 
int PRE_METHOD = 0x00000004
 
int PRESS_CONTROL = 2
 
int SCROLLBAR_HORIZONTAL = GConstants.SCROLLBARS_HORIZONTAL_ONLY
 
int SCROLLBAR_VERTICAL = GConstants.SCROLLBARS_VERTICAL_ONLY
 
String SLIDER_STYLES = "|grey_blue|blue18px|green_red20px|purple18px|red_yellow18px|"
 
int TINT_FOR_ALPHA = 255
 
int TPAD2 = 2
 
int TPAD4 = 4
 
int TPAD6 = 6
 
int TPAD8 = 8
 
float WHEEL_DELTA = 0.01f
 
float WHEEL_STICK_FACTOR = 0.51f
 
int Z_PANEL = 1024
 
int Z_SLIPPY = 24
 
int Z_SLIPPY_EXPANDS = 48
 
int Z_STICKY = 0
 
- Static Protected Attributes inherited from g4p_controls.GLinearTrackControl
static int THUMB_SPOT = 1
 
static float TINSET = 2
 
static int TRACK_SPOT = 2
 
- Static Protected Attributes inherited from g4p_controls.GAbstractControl
static float epsilon = 0.001f
 

Detailed Description

Slider that can be customised with user provided graphics.

This class replaces the GWSlider provided in pre v3 editions of this library.

The main difference to the GSlider class is the ability to skin the slider with user provided graphics. The library provides a number of skins ready for use. You specify the skin to use when the slider is created and if the library is unable to load the skin it will print a warning and load the default skin instead.

Library skins available

  • grey_blue (default skin)
  • green_red20px
  • red_yellow18px
  • blue18px
  • purple18px

A skin requires 5 image files for different parts of the slider which must be stored in their own folder (the folder name is also used as the skin name) and this folder should be place inside the sketch's data folder.

The image files have specific names.

  • Left end cap of the slider(end_left.???)
  • Right end cap of the slider(end_right.???)
  • An extendible centre segment(centre.???)
  • Draggable thumb (handle.??? and handle_mouseover.???)

Where ??? is the image type file extension. The image type can be any that Processing can handle, the most common types will be png, jpg or gif but tga is also permitted

There are very few restrictions about the images you use but when designing the images you should consider the following facts:

  • the slider will be created to fit the control size (specified in the constructor)
  • the horizontal space allocated for the end-caps will be the same for each end (uses the width or the larger end cap image)
  • the track width will be the height of the centre image
  • the centre image will be tiled along the track length
  • the track will be placed in the horizontal and vertical centre of the control.
  • the end cap images will be placed in the vertical centre of the control and butted against the track.
Author
Peter Lager

Constructor & Destructor Documentation

g4p_controls.GCustomSlider.GCustomSlider ( PApplet  theApplet,
float  p0,
float  p1,
float  p2,
float  p3 
)

Create a custom slider using the default skin.

Parameters
theAppletthe main sketch or GWindow control for this control
p0x position based on control mode
p1y position based on control mode
p2x position or width based on control mode
p3y position or height based on control mode
g4p_controls.GCustomSlider.GCustomSlider ( PApplet  theApplet,
float  p0,
float  p1,
float  p2,
float  p3,
String  skin 
)

Create a custom slider using the skin specified.

Parameters
theAppletthe main sketch or GWindow control for this control
p0x position based on control mode
p1y position based on control mode
p2x position or width based on control mode
p3y position or height based on control mode
skinthe name of the skin (this is also the name of the folder holding the images)

Member Function Documentation

float g4p_controls.GCustomSlider.calcTrackOffset ( )
protected

Calculates the amount of offset for the labels

void g4p_controls.GCustomSlider.setStyle ( String  skin)

Change the skin used for the slider.

Parameters
skinthe name of the folder holding the graphics for this slider