Inheritance diagram for g4p_controls.GValueControl:

[legend]

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 (float initValue, float start, float end)

void	setLimits (float start, float end)

void	setLimits (int initValue, int start, int end)

void	setLimits (int start, int end)

void	setNbrTicks (int noOfTicks)

void	setNumberFormat (int numberFormat)

void	setNumberFormat (int numberFormat, int precision)

void	setNumberFormat (int numberFormat, int precision, String unit)

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)

void	addControl (GAbstractControl c, float x, float y)

void	addControl (GAbstractControl c, float x, float y, float angle)

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

float	getRotation ()

PGraphics	getSnapshot ()

GToolTip	getTip ()

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

void	removeTip ()

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	setTip (GToolTip tt, float offset, float angle)

void	setTip (GToolTip tt, GAlign ax, GAlign ay, float gap)

void	setTip (String text, float offset, float angle)

void	setTip (String text, GAlign ax, GAlign ay, float gap)

void	setTipDisplayTime (long msecs)

void	setTipEnabled (boolean enable)

void	setTipHorz (boolean level)

void	setTipPos (float radius, float ang)

void	setTipPos (GAlign ax, GAlign ay, float gap)

void	setTipText (String text)

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	addControlImpl (GAbstractControl c, float x, float y, float angle)

void	addToParent (GAbstractControl p)

void	calcTransformedOrigin (float px, float py)

boolean	controlSupportsToolTips ()

void	createEventHandler (Object handlerObj, String methodName, Class[] param_classes, String[] param_names)

void	drawChildren ()

void	fireEvent (Object... objects)

int	focusObjectZ ()

PGraphics	getBuffer ()

int	getCurrHotSpot ()

AffineTransform	getTransform (AffineTransform aff)

void	hideTip ()

boolean	isAvailable ()

boolean	isDisplayable (int ascii)

boolean	isSuitableForGroupControl (GAbstractControl control)

void	loseFocus (GAbstractControl grabber)

void	makeBuffer ()

void	manageToolTip ()

void	resize (int w, int h)

void	resize (int w, int h, GControlMode mode)

void	setAvailable (boolean avail)

void	setZ (int parentZ)

void	showTip ()

void	takeFocus ()

void	updateBuffer ()

int	whichHotSpot (float px, float py)

Protected Attributes
float	easing = 1.0f

float	endLimit = 1

boolean	limitsInvalid = true

int	nbrTicks = 2

float	offset

float	parametricPos = 0.5f

float	parametricTarget = 0.5f

int	precision = 2

boolean	showLimits = false

boolean	showTicks = false

boolean	showValue = false

StyledString	ssEndLimit

StyledString	ssStartLimit

StyledString	ssValue

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
boolean	allowChildren = true

boolean	allowToolTips = true

int	alphaLevel = G4P.globalAlpha

boolean	available = true

PGraphicsJava2D	buffer = null

boolean	bufferInvalid = true

LinkedList< GAbstractControl >	children = null

int	currSpot = -1

int	cursorOver = HAND

float	cx

float	cy

boolean	dragging = false

boolean	enabled = true

Method	eventHandlerMethod = null

String	eventHandlerMethodName

Object	eventHandlerObject = null

float	halfHeight

float	halfWidth

float	height

HotSpot[]	hotspots = null

int	lastSpot = -1

int	localColorScheme = G4P.globalColorScheme

boolean	opaque = false

float	ox

float	oy

Color[]	palette = null

GAbstractControl	parent = null

int	registeredMethods = 0

float	rotAngle

double[]	temp = new double[2]

GToolTip	tip = null

boolean	visible = true

float	width

PApplet	winApp

float	x

float	y

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

TextAttribute	UNDERLINE = TextAttribute.UNDERLINE

int	UNDERLINE_OFF = Integer.valueOf(-1)

int	UNDERLINE_ON = TextAttribute.UNDERLINE_ON

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

Static Protected Attributes inherited from g4p_controls.GAbstractControl
static GAbstractControl	controlToTakeFocus = null

static GAbstractControl	cursorIsOver

static float	epsilon = 0.001f

static GAbstractControl	focusIsWith = null

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

◆ GValueControl()

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

Base class for sliders and knobs

Parameters

theApplet	the main sketch or GWindow control for this control
p0	x position based on control mode
p1	y position based on control mode
p2	x position or width based on control mode
p3	y position or height based on control mode

Member Function Documentation

◆ calcParametricTarget()

float g4p_controls.GValueControl.calcParametricTarget ( float pt )

protected

Calculate the correct value of the parametticTarget

Parameters

pt	the value to correct

Returns: the corrected value 0.0 - 1.0 incl

◆ findNearestTickValueTo()

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

◆ getEasing()

float g4p_controls.GValueControl.getEasing ( )

Get the current value used for easing.

Returns: the easing

◆ getEndLimit()

float g4p_controls.GValueControl.getEndLimit ( )

Returns: the endLimit

◆ getNbrTicks()

int g4p_controls.GValueControl.getNbrTicks ( )

Get the number of tick marks.

Returns: the nbrTicks

◆ getNumericDisplayString()

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

◆ getPrecision()

int g4p_controls.GValueControl.getPrecision ( )

Precision used with floating point numbers

Returns: the precision

◆ getStartLimit()

float g4p_controls.GValueControl.getStartLimit ( )

Returns: the startLimit

◆ getUnit()

String g4p_controls.GValueControl.getUnit ( )

Returns: the unit

◆ getValueF()

float g4p_controls.GValueControl.getValueF ( )

Returns: the current value as a float

◆ getValueI()

int g4p_controls.GValueControl.getValueI ( )

Returns: the current value as an integer.
DECIMAL and EXPONENT value types will be rounded to the nearest integer.

◆ getValueS()

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

Reimplemented in g4p_controls.GLinearTrackControl.

◆ getValueType()

int g4p_controls.GValueControl.getValueType ( )

Returns: the valueType

◆ isShowLimits()

boolean g4p_controls.GValueControl.isShowLimits ( )

Are the limit values visible?

Returns: the showLimits

◆ isShowTicks()

boolean g4p_controls.GValueControl.isShowTicks ( )

Are the tick marks visible?

Returns: the showTicks

◆ isShowValue()

boolean g4p_controls.GValueControl.isShowValue ( )

Is the current value to be displayed?

Returns: the showValue

◆ isStickToTicks()

boolean g4p_controls.GValueControl.isStickToTicks ( )

Is the value constrained to the tick marks?

Returns: the stickToTicks true if values constrained else false

◆ pre()

void g4p_controls.GValueControl.pre ( )

Handle easing

Reimplemented from g4p_controls.GAbstractControl.

◆ setEasing()

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

easeBy the easing to set

◆ setEpsilon()

void g4p_controls.GValueControl.setEpsilon ( )

protected

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

◆ setLimits() [1/4]

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

initValue	the initial value
start	the start value of the range
end	the end value of the range

◆ setLimits() [2/4]

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

start	the start value of the range
end	the end value of the range

◆ setLimits() [3/4]

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

initValue	the initial value
start	the start value of the range
end	the end value of the range

◆ setLimits() [4/4]

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

start	the start value of the range
end	the end value of the range

◆ setNbrTicks()

void g4p_controls.GValueControl.setNbrTicks ( int noOfTicks )

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

Parameters

noOfTicks the nbrTicks to set

◆ setNumberFormat() [1/3]

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

numberFormat G4P.INTEGER, G4P.DECIMAL or G4P.EXPONENT

◆ setNumberFormat() [2/3]

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

numberFormat	G4P.INTEGER, G4P.DECIMAL or G4P.EXPONENT
precision	must be ≥ 1

◆ setNumberFormat() [3/3]

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

numberFormat	INTEGER, DECIMAL or EXPONENT
precision	must be ≥ 1
unit	for example kg, m, ($), fps

◆ setPrecision()

void g4p_controls.GValueControl.setPrecision ( int nd )

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

Parameters

nd	must be ≥ 1 otherwise will use 1

◆ setShowDecor()

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

opaque	show background
ticks	show tick marks
value	show current value
limits	show min and max values (limits)

◆ setShowLimits()

void g4p_controls.GValueControl.setShowLimits ( boolean showLimits )

Set whether the limits are to be displayed or not.

Parameters

showLimits the showLimits to set

◆ setShowTicks()

void g4p_controls.GValueControl.setShowTicks ( boolean showTicks )

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

Parameters

showTicks the showTicks to set

Reimplemented in g4p_controls.GLinearTrackControl.

◆ setShowValue()

void g4p_controls.GValueControl.setShowValue ( boolean showValue )

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

Parameters

showValue the showValue to set

◆ setStickToTicks()

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

stickToTicks true if you want to constrain the values else false

◆ setUnits()

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

units for example kg, m, ($), fps

◆ setValue()

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

v	the new value for this control

Reimplemented in g4p_controls.GKnob.

◆ updateDueToValueChanging()

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.

Reimplemented in g4p_controls.GCustomSlider, and g4p_controls.GSlider.

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GValueControl()

Member Function Documentation

◆ calcParametricTarget()

◆ findNearestTickValueTo()

◆ getEasing()

◆ getEndLimit()

◆ getNbrTicks()

◆ getNumericDisplayString()

◆ getPrecision()

◆ getStartLimit()

◆ getUnit()

◆ getValueF()

◆ getValueI()

◆ getValueS()

◆ getValueType()

◆ isShowLimits()

◆ isShowTicks()

◆ isShowValue()

◆ isStickToTicks()

◆ pre()

◆ setEasing()

◆ setEpsilon()

◆ setLimits() [1/4]

◆ setLimits() [2/4]

◆ setLimits() [3/4]

◆ setLimits() [4/4]

◆ setNbrTicks()

◆ setNumberFormat() [1/3]

◆ setNumberFormat() [2/3]

◆ setNumberFormat() [3/3]

◆ setPrecision()

◆ setShowDecor()

◆ setShowLimits()

◆ setShowTicks()

◆ setShowValue()

◆ setStickToTicks()

◆ setUnits()

◆ setValue()

◆ updateDueToValueChanging()