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

Public Member Functions

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 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

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.GAbstractControl
static float epsilon = 0.001f
 

Detailed Description

Base class for all slider and knob type controls.

This class enables the creation of tick marks and constraining values to the tick mark values.

It also controls how the values are to be displayed INTEGER, DECIMAL or EXPONENT

Author
Peter Lager

Constructor & Destructor Documentation

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

Base class for sliders and knobs

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

Member Function Documentation

float g4p_controls.GValueControl.calcParametricTarget ( float  pt)
protected

Calculate the correct value of the parametticTarget

Parameters
ptthe value to correct
Returns
the corrected value 0.0 - 1.0 incl
float g4p_controls.GValueControl.findNearestTickValueTo ( float  p)
protected

These are normalised values i.e. between 0.0 and 1.0 inclusive

Parameters
p
Returns
the parametric value of the nearest tick
float g4p_controls.GValueControl.getEasing ( )

Get the current value used for easing.

Returns
the easing
float g4p_controls.GValueControl.getEndLimit ( )
Returns
the endLimit
int g4p_controls.GValueControl.getNbrTicks ( )

Get the number of tick marks.

Returns
the nbrTicks
String g4p_controls.GValueControl.getNumericDisplayString ( float  number)
protected

Used to format the number into a string for display.

Parameters
number
Returns
a string representing the number
int g4p_controls.GValueControl.getPrecision ( )

Precision used with floating point numbers

Returns
the precision
float g4p_controls.GValueControl.getStartLimit ( )
Returns
the startLimit
String g4p_controls.GValueControl.getUnit ( )
Returns
the unit
float g4p_controls.GValueControl.getValueF ( )
Returns
the current value as a float
int g4p_controls.GValueControl.getValueI ( )
Returns
the current value as an integer.
DECIMAL and EXPONENT value types will be rounded to the nearest integer.
String g4p_controls.GValueControl.getValueS ( )

If we are using labels then this will get the label text associated with the current value.
If labels have not been set then return null

Returns
the value as text
int g4p_controls.GValueControl.getValueType ( )
Returns
the valueType
boolean g4p_controls.GValueControl.isShowLimits ( )

Are the limit values visible?

Returns
the showLimits
boolean g4p_controls.GValueControl.isShowTicks ( )

Are the tick marks visible?

Returns
the showTicks
boolean g4p_controls.GValueControl.isShowValue ( )

Is the current value to be displayed?

Returns
the showValue
boolean g4p_controls.GValueControl.isStickToTicks ( )

Is the value constrained to the tick marks?

Returns
the stickToTicks true if values constrained else false
void g4p_controls.GValueControl.pre ( )

Handle easing

void g4p_controls.GValueControl.setEasing ( float  easeBy)

Set the amount of easing to be used when a value is changing. The default value is 1 (no easing) values > 1 will cause the value to rush from its starting value and decelerate towards its final values. In other words it smoothes the movement of the slider thumb or knob rotation.

Parameters
easeBythe easing to set
void g4p_controls.GValueControl.setEpsilon ( )
protected

Make epsilon to match the value of 1 pixel or the precision which ever is the smaller

void g4p_controls.GValueControl.setLimits ( int  start,
int  end 
)

Sets the range of values to be returned. This method will assume that you want to set the valueType to INTEGER

Parameters
startthe start value of the range
endthe end value of the range
void g4p_controls.GValueControl.setLimits ( int  initValue,
int  start,
int  end 
)

Sets the initial value and the range of values to be returned. This method will assume that you want to set the valueType to INTEGER.

Parameters
initValuethe initial value
startthe start value of the range
endthe end value of the range
void g4p_controls.GValueControl.setLimits ( float  start,
float  end 
)

Sets the range of values to be returned. This method will assume that you want to set the valueType to DECIMAL

Parameters
startthe start value of the range
endthe end value of the range
void g4p_controls.GValueControl.setLimits ( float  initValue,
float  start,
float  end 
)

Sets the initial value and the range of values to be returned. This method will assume that you want to set the valueType to DECIMAL.

Parameters
initValuethe initial value
startthe start value of the range
endthe end value of the range
void g4p_controls.GValueControl.setNbrTicks ( int  noOfTicks)

The number of ticks must be ≥2 since 2 are required for the slider limits.

Parameters
noOfTicksthe nbrTicks to set
void g4p_controls.GValueControl.setNumberFormat ( int  numberFormat,
int  precision,
String  unit 
)

Set the numberFormat, precision and units in one go.
Valid number formats are INTEGER, DECIMAL, EXPONENT
Precision must be ≥ 1 and is ignored for INTEGER.

Parameters
numberFormatINTEGER, DECIMAL or EXPONENT
precisionmust be ≥ 1
unitfor example kg, m, ($), fps
void g4p_controls.GValueControl.setNumberFormat ( int  numberFormat,
int  precision 
)

Set the numberFormat and precision in one go.
Valid number formats are INTEGER, DECIMAL, EXPONENT
Precision must be ≥ 1 and is ignored for INTEGER.

Parameters
numberFormatG4P.INTEGER, G4P.DECIMAL orG4P. EXPONENT
precisionmust be ≥ 1
void g4p_controls.GValueControl.setNumberFormat ( int  numberFormat)

Set the numberFormat and precision in one go.
Valid number formats are INTEGER, DECIMAL, EXPONENT
Precision must be ≥ 1 and is ignored for INTEGER.

Parameters
numberFormatG4P.INTEGER, G4P.DECIMAL or G4P.EXPONENT
void g4p_controls.GValueControl.setPrecision ( int  nd)

For DECIMAL values this sets the number of decimal places to be displayed.

Parameters
ndmust be ≥ 1 otherwise will use 1
void g4p_controls.GValueControl.setShowDecor ( boolean  opaque,
boolean  ticks,
boolean  value,
boolean  limits 
)

Convenience method to set what is to be drawn to the screen.

Parameters
opaqueshow background
ticksshow tick marks
valueshow current value
limitsshow min and max values (limits)
void g4p_controls.GValueControl.setShowLimits ( boolean  showLimits)

Set whether the limits are to be displayed or not.

Parameters
showLimitsthe showLimits to set
void g4p_controls.GValueControl.setShowTicks ( boolean  showTicks)

Set whether the tick marks are to be displayed or not.

Parameters
showTicksthe showTicks to set
void g4p_controls.GValueControl.setShowValue ( boolean  showValue)

Set whether the current value is to be displayed or not.

Parameters
showValuethe showValue to set
void g4p_controls.GValueControl.setStickToTicks ( boolean  stickToTicks)

Specify whether the values are to be constrained to the tick marks or not. It will automatically display tick marks if set true.

Parameters
stickToTickstrue if you want to constrain the values else false
void g4p_controls.GValueControl.setUnits ( String  units)

The units to be displayed with the current and limit values e.g. kg, m, ($), fps etc.
Do not use long labels such as 'miles per hour' as these take a lot of space and can look messy.

Parameters
unitsfor example kg, m, ($), fps
void g4p_controls.GValueControl.setValue ( float  v)

Set the value for the slider.
The user must ensure that the value is valid for the slider range.

Parameters
vthe new value for this control
void g4p_controls.GValueControl.updateDueToValueChanging ( )
protected

This should be overridden in child classes so they can perform any class specific actions when the value changes. Override this in GSlider to change the hotshot position.