g4p_controls

Class GKnob

java.lang.Object

g4p_controls.GAbstractControl

g4p_controls.GValueControl

g4p_controls.GKnob

All Implemented Interfaces:

GConstants, processing.core.PConstants

public class GKnob
extends GValueControl

The provides an extremely configurable GUI knob controller. GKnob inherits from GValueControl so you should read the documentation for that class as it also applies to GKnob.

Configurable options
Knob size but it must be circular
Start and end of rotation arc.
Bezel width with tick marks
User defined value limits (i.e. the range of values returned

Range of values associated with rotating the knob
Rotation is controlled by mouse movement - 3 modes available
(a) angular - drag round knob center
(b) horizontal - drag left or right
(c) vertical - drag up or down
User can specify mouse sensitivity for modes (b) and (c) Use can specify easing to give smoother rotation Note: Angles are measured clockwise starting in the positive x direction i.e.

         270
          |
    180 --+-- 0
          |
          90
 

Author:

Peter Lager

Nested Class Summary

Nested classes/interfaces inherited from class g4p_controls.GAbstractControl

GAbstractControl.Z_Order

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL_METHOD
static int	CLIP_RUN
static int	COMBI_MODES
static java.lang.String	DEFAULT_SLIDER_STYLE
static int	DRAG_CONTROL
static int	DRAW_METHOD
static char	EOL
static int	EXCP_IN_HANDLER
static int[][]	grid
static int	GROUP_CONTROL_METHOD
static int	I_CL
static int	I_COVERED
static int	I_CR
static int	I_INSIDE
static int	I_MODES
static int	I_NONE
static int	I_TL
static int	I_TR
static int	INVALID_PAPPLET
static int	INVALID_TYPE
static int	KEY_METHOD
static int	MERGE_RUNS
static int	MISSING
static int	MOUSE_METHOD
static int	NONEXISTANT
static int	OFF_CONTROL
static int	OVER_CONTROL
static java.awt.BasicStroke	pen_1_0
static java.awt.BasicStroke	pen_2_0
static java.awt.BasicStroke	pen_3_0
static java.awt.BasicStroke	pen_4_0
static int	POST_METHOD
static int	PRE_METHOD
static int	PRESS_CONTROL
static int	SCROLLBAR_HORIZONTAL
static int	SCROLLBAR_VERTICAL
static java.lang.String	SLIDER_STYLES
static int	TINT_FOR_ALPHA
static int	TPAD2
static int	TPAD4
static int	TPAD6
static int	TPAD8
static float	WHEEL_DELTA
static float	WHEEL_STICK_FACTOR
static int	Z_PANEL
static int	Z_SLIPPY
static int	Z_SLIPPY_EXPANDS
static int	Z_STICKY

Fields inherited from class g4p_controls.GAbstractControl

tag, tagNo

Fields inherited from interface processing.core.PConstants

ADD, ALPHA, ALT, AMBIENT, ARC, ARGB, ARROW, BACKSPACE, BASELINE, BEVEL, BEZIER_VERTEX, BLEND, BLUR, BOTTOM, BOX, BREAK, BURN, CENTER, CHATTER, CHORD, CLAMP, CLOSE, CODED, COMPLAINT, CONTROL, CORNER, CORNERS, CROSS, CURVE_VERTEX, CUSTOM, DARKEST, DEG_TO_RAD, DELETE, DIAMETER, DIFFERENCE, DILATE, DIRECTIONAL, DISABLE_ASYNC_SAVEFRAME, DISABLE_BUFFER_READING, DISABLE_DEPTH_MASK, DISABLE_DEPTH_SORT, DISABLE_DEPTH_TEST, DISABLE_KEY_REPEAT, DISABLE_NATIVE_FONTS, DISABLE_OPENGL_ERRORS, DISABLE_OPTIMIZED_STROKE, DISABLE_STROKE_PERSPECTIVE, DISABLE_STROKE_PURE, DISABLE_TEXTURE_MIPMAPS, DODGE, DOWN, DXF, ELLIPSE, ENABLE_ASYNC_SAVEFRAME, ENABLE_BUFFER_READING, ENABLE_DEPTH_MASK, ENABLE_DEPTH_SORT, ENABLE_DEPTH_TEST, ENABLE_KEY_REPEAT, ENABLE_NATIVE_FONTS, ENABLE_OPENGL_ERRORS, ENABLE_OPTIMIZED_STROKE, ENABLE_STROKE_PERSPECTIVE, ENABLE_STROKE_PURE, ENABLE_TEXTURE_MIPMAPS, ENTER, EPSILON, ERODE, ESC, EXCLUSION, FX2D, GIF, GRAY, GROUP, HALF_PI, HAND, HARD_LIGHT, HINT_COUNT, HSB, IMAGE, INVERT, JAVA2D, JPEG, LANDSCAPE, LEFT, LIGHTEST, LINE, LINE_LOOP, LINE_STRIP, LINES, LINUX, MACOSX, MAX_FLOAT, MAX_INT, MIN_FLOAT, MIN_INT, MITER, MODEL, MODELVIEW, MOVE, MULTIPLY, NORMAL, OPAQUE, OPEN, OPENGL, ORTHOGRAPHIC, OTHER, OVERLAY, P2D, P3D, PATH, PDF, PERSPECTIVE, PI, PIE, platformNames, POINT, POINTS, POLYGON, PORTRAIT, POSTERIZE, PROBLEM, PROJECT, PROJECTION, QUAD, QUAD_BEZIER_VERTEX, QUAD_STRIP, QUADRATIC_VERTEX, QUADS, QUARTER_PI, RAD_TO_DEG, RADIUS, RECT, REPEAT, REPLACE, RETURN, RGB, RIGHT, ROUND, SCREEN, SHAPE, SHIFT, SOFT_LIGHT, SPAN, SPHERE, SPOT, SQUARE, SUBTRACT, SVG, TAB, TARGA, TAU, TEXT, THIRD_PI, THRESHOLD, TIFF, TOP, TRIANGLE, TRIANGLE_FAN, TRIANGLE_STRIP, TRIANGLES, TWO_PI, UP, VERTEX, WAIT, WHITESPACE, WINDOWS, X, Y, Z

Fields inherited from interface g4p_controls.GConstants

ALPHA_BLOCK, ALPHA_PICK, BACKGROUND, BLUE_SCHEME, CANCEL, CLOSE_WINDOW, CLOSED, CTRL_ANGULAR, CTRL_HORIZONTAL, CTRL_VERTICAL, CYAN_SCHEME, DECIMAL, END, ERROR, EXIT_APP, EXPONENT, FAMILY, FOREGROUND, FORWARD, GOLD_SCHEME, GREEN_SCHEME, HOME, INFO, INTEGER, KEEP_OPEN, NO, OK, OK_CANCEL, ORANGE_SCHEME, ORIENT_LEFT, ORIENT_RIGHT, ORIENT_TRACK, PLAIN, POSTURE, POSTURE_OBLIQUE, POSTURE_REGULAR, PURPLE_SCHEME, QUERY, RED_SCHEME, REVERSE, SCHEME_10, SCHEME_11, SCHEME_12, SCHEME_13, SCHEME_14, SCHEME_15, SCHEME_8, SCHEME_9, SCROLLBARS_AUTOHIDE, SCROLLBARS_BOTH, SCROLLBARS_HORIZONTAL_ONLY, SCROLLBARS_NONE, SCROLLBARS_VERTICAL_ONLY, SIZE, STRIKETHROUGH, STRIKETHROUGH_OFF, STRIKETHROUGH_ON, SUPERSCRIPT, SUPERSCRIPT_OFF, SUPERSCRIPT_SUB, SUPERSCRIPT_SUPER, USER_COL_SCHEME, WARNING, WEIGHT, WEIGHT_BOLD, WEIGHT_DEMIBOLD, WEIGHT_DEMILIGHT, WEIGHT_EXTRA_LIGHT, WEIGHT_EXTRABOLD, WEIGHT_HEAVY, WEIGHT_LIGHT, WEIGHT_MEDIUM, WEIGHT_REGULAR, WEIGHT_SEMIBOLD, WEIGHT_ULTRABOLD, WIDTH, WIDTH_CONDENSED, WIDTH_EXTENDED, WIDTH_REGULAR, WIDTH_SEMI_CONDENSED, WIDTH_SEMI_EXTENDED, X4, X8, YELLOW_SCHEME, YES, YES_NO, YES_NO_CANCEL

Constructor Summary

Constructors

Constructor and Description
GKnob(processing.core.PApplet theApplet, float p0, float p1, float p2, float p3, float gripAmount) Will create the a circular knob control that fits the rectangle define by the values passed as parameters.

Method Summary

Methods

Modifier and Type	Method and Description
void	draw()
float	getSensitivity() This gets the sensitivity to be used in modes CTRL_HORIZONTAL and CTRL_VERTICAL
int	getTurnMode() Get the current mouse controller mode possible values are GKnob.CTRL_ANGULAR or GKnob.CTRL_HORIZONTAL) orGKnob.CTRL_VERTICAL
boolean	isIncludeOverBezel() Is the bezel included when considering when the mouse is over.
boolean	isOverArcOnly() Does the mouse only respond when over the arc?
boolean	isShowArcOnly() Are we showing arc only?
boolean	isShowTrack() Are we showing the the value track bar.
void	mouseEvent(processing.event.MouseEvent event)
void	setArcPolicy(boolean over_arc_only, boolean draw_arc_only, boolean overfullsize) Convenience method to set both the show and the mouse over arc only properties for this knob
void	setGripAmount(float gripAmount) The radius of the inner griper radius is calculated from the bezel radius and the parameter gripAmount using
void	setIncludeOverBezel(boolean overBezel) Whether to include the bezel when deciding when the mouse is over.
void	setOverArcOnly(boolean arcOnly) Decides when the knob will respond to the mouse buttons.
void	setSensitivity(float sensitivity) This gets the sensitivity to be used in modes CTRL_HORIZONTAL and CTRL_VERTICAL A value of 1 is 1 degree per pixel and a value of 2 is 2 degrees per pixel.
void	setShowArcOnly(boolean arcOnly) This will decide whether the knob is draw as a full circle or as an arc.
void	setShowTrack(boolean showTrack) Whether or not to show the circular progress bar.
void	setTurnMode(int mode) Set the mouse control mode to use, acceptable values are GKnob.CTRL_ANGULAR or GKnob.CTRL_HORIZONTAL) orGKnob.CTRL_VERTICAL any other value will be ignored.
void	setTurnRange(float start, float end) Set the limits for the range of valid rotation angles for the knob.
void	setValue(float v) Set the value for the slider.

Methods inherited from class g4p_controls.GValueControl

getEasing, getEndLimit, getNbrTicks, getPrecision, getStartLimit, getUnit, getValueF, getValueI, getValueS, getValueType, isShowLimits, isShowTicks, isShowValue, isStickToTicks, pre, setEasing, setLimits, setLimits, setLimits, setLimits, setNbrTicks, setNumberFormat, setNumberFormat, setNumberFormat, setPrecision, setShowDecor, setShowLimits, setShowTicks, setShowValue, setStickToTicks, setUnits

Methods inherited from class g4p_controls.GAbstractControl

addControl, addControl, addControl, addControls, addEventHandler, dispose, forceBufferUpdate, getCursorOver, getCX, getCY, getHeight, getLocalColorScheme, getPApplet, getParent, getSnapshot, getWidth, getX, getY, hasFocus, isDragging, isEnabled, isOpaque, isOver, isVisible, keyEvent, markForDisposal, moveTo, moveTo, post, saveSnapshot, saveSnapshot, setAlpha, setAlpha, setCursorOver, setEnabled, setFocus, setLocalColor, setLocalColorScheme, setLocalColorScheme, setOpaque, setRotation, setRotation, setVisible, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SLIDER_STYLES

public static final java.lang.String SLIDER_STYLES

See Also:

Constant Field Values

DEFAULT_SLIDER_STYLE

public static final java.lang.String DEFAULT_SLIDER_STYLE

See Also:

Constant Field Values

DRAW_METHOD

public static final int DRAW_METHOD

See Also:

Constant Field Values

MOUSE_METHOD

public static final int MOUSE_METHOD

See Also:

Constant Field Values

PRE_METHOD

public static final int PRE_METHOD

See Also:

Constant Field Values

KEY_METHOD

public static final int KEY_METHOD

See Also:

Constant Field Values

POST_METHOD

public static final int POST_METHOD

See Also:

Constant Field Values

ALL_METHOD

public static final int ALL_METHOD

See Also:

Constant Field Values

GROUP_CONTROL_METHOD

public static final int GROUP_CONTROL_METHOD

See Also:

Constant Field Values

MISSING

public static final int MISSING

See Also:

Constant Field Values

NONEXISTANT

public static final int NONEXISTANT

See Also:

Constant Field Values

INVALID_TYPE

public static final int INVALID_TYPE

See Also:

Constant Field Values

INVALID_PAPPLET

public static final int INVALID_PAPPLET

See Also:

Constant Field Values

EXCP_IN_HANDLER

public static final int EXCP_IN_HANDLER

See Also:

Constant Field Values

OFF_CONTROL

public static final int OFF_CONTROL

See Also:

Constant Field Values

OVER_CONTROL

public static final int OVER_CONTROL

See Also:

Constant Field Values

PRESS_CONTROL

public static final int PRESS_CONTROL

See Also:

Constant Field Values

DRAG_CONTROL

public static final int DRAG_CONTROL

See Also:

Constant Field Values

TINT_FOR_ALPHA

public static final int TINT_FOR_ALPHA

See Also:

Constant Field Values

I_NONE

public static final int I_NONE

See Also:

Constant Field Values

I_TL

public static final int I_TL

See Also:

Constant Field Values

I_TR

public static final int I_TR

See Also:

Constant Field Values

I_CL

public static final int I_CL

See Also:

Constant Field Values

I_CR

public static final int I_CR

See Also:

Constant Field Values

I_INSIDE

public static final int I_INSIDE

See Also:

Constant Field Values

I_COVERED

public static final int I_COVERED

See Also:

Constant Field Values

I_MODES

public static final int I_MODES

See Also:

Constant Field Values

MERGE_RUNS

public static final int MERGE_RUNS

See Also:

Constant Field Values

CLIP_RUN

public static final int CLIP_RUN

See Also:

Constant Field Values

COMBI_MODES

public static final int COMBI_MODES

See Also:

Constant Field Values

grid

public static final int[][] grid

pen_1_0

public static final java.awt.BasicStroke pen_1_0

pen_2_0

public static final java.awt.BasicStroke pen_2_0

pen_3_0

public static final java.awt.BasicStroke pen_3_0

pen_4_0

public static final java.awt.BasicStroke pen_4_0

TPAD2

public static final int TPAD2

See Also:

Constant Field Values

TPAD4

public static final int TPAD4

See Also:

Constant Field Values

TPAD6

public static final int TPAD6

See Also:

Constant Field Values

TPAD8

public static final int TPAD8

See Also:

Constant Field Values

SCROLLBAR_VERTICAL

public static final int SCROLLBAR_VERTICAL

See Also:

Constant Field Values

SCROLLBAR_HORIZONTAL

public static final int SCROLLBAR_HORIZONTAL

See Also:

Constant Field Values

WHEEL_DELTA

public static final float WHEEL_DELTA

See Also:

Constant Field Values

WHEEL_STICK_FACTOR

public static final float WHEEL_STICK_FACTOR

See Also:

Constant Field Values

EOL

public static final char EOL

See Also:

Constant Field Values

Z_STICKY

public static final int Z_STICKY

See Also:

Constant Field Values

Z_SLIPPY

public static final int Z_SLIPPY

See Also:

Constant Field Values

Z_SLIPPY_EXPANDS

public static final int Z_SLIPPY_EXPANDS

See Also:

Constant Field Values

Z_PANEL

public static final int Z_PANEL

See Also:

Constant Field Values

Constructor Detail

GKnob

public GKnob(processing.core.PApplet theApplet,
     float p0,
     float p1,
     float p2,
     float p3,
     float gripAmount)

Will create the a circular knob control that fits the rectangle define by the values passed as parameters.
The knob has two zones the outer bezel and the inner gripper. The radius of the outer bezel is calculated from

bezel radius = min(width, height)/2 - 2


 The radius of the inner griper radius is calculated from the bezel radius 
 and the last parameter. 

 
grip radius = bezel radiius * gripAmount 


 The gripAmount should be in te range 0.0 to 1.0 inclusive. The actual value 
 will be constrained to that range. 

Parameters:

theApplet -

p0 -

p1 -

p2 -

p3 -

gripAmount - must be >=0.0 and <=1.0

Method Detail

setGripAmount

public void setGripAmount(float gripAmount)

The radius of the inner griper radius is calculated from the bezel radius and the parameter gripAmount using

grip radius = bezel radiius * gripAmount 

The gripAmount should be in te range 0.0 to 1.0 inclusive. The actual value will be constrained to that range.

Parameters:

gripAmount - must be >=0.0 and <=1.0

setValue

public void setValue(float v)

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

Overrides:

setValue in class GValueControl

Parameters:

v -

setShowTrack

public void setShowTrack(boolean showTrack)

Whether or not to show the circular progress bar.

Parameters:

showTrack - true for visible

isShowTrack

public boolean isShowTrack()

Are we showing the the value track bar.

setIncludeOverBezel

public void setIncludeOverBezel(boolean overBezel)

Whether to include the bezel when deciding when the mouse is over.

Parameters:

overBezel - true if bezel inclded.

isIncludeOverBezel

public boolean isIncludeOverBezel()

Is the bezel included when considering when the mouse is over.

Returns:

true if included.

setOverArcOnly

public void setOverArcOnly(boolean arcOnly)

Decides when the knob will respond to the mouse buttons. If set to true it will only respond when ver the arc made by the start and end angles. If false it will be the full circle.

Parameters:

arcOnly -

isOverArcOnly

public boolean isOverArcOnly()

Does the mouse only respond when over the arc?

Returns:

true = yes

setArcPolicy

public void setArcPolicy(boolean over_arc_only,
                boolean draw_arc_only,
                boolean overfullsize)

Convenience method to set both the show and the mouse over arc only properties for this knob

Parameters:

over_arc_only - mouse over arc only?

draw_arc_only - draw arc only?

overfullsize - include bezel in mouse over calculations?

setShowArcOnly

public void setShowArcOnly(boolean arcOnly)

This will decide whether the knob is draw as a full circle or as an arc.

Parameters:

arcOnly - true for arc only

isShowArcOnly

public boolean isShowArcOnly()

Are we showing arc only?

Returns:

true = yes

mouseEvent

public void mouseEvent(processing.event.MouseEvent event)

Overrides:

mouseEvent in class GAbstractControl

draw

public void draw()

Overrides:

draw in class GAbstractControl

getTurnMode

public int getTurnMode()

Get the current mouse controller mode possible values are
GKnob.CTRL_ANGULAR or GKnob.CTRL_HORIZONTAL) orGKnob.CTRL_VERTICAL

Returns:

the mode

setTurnMode

public void setTurnMode(int mode)

Set the mouse control mode to use, acceptable values are
GKnob.CTRL_ANGULAR or GKnob.CTRL_HORIZONTAL) orGKnob.CTRL_VERTICAL any other value will be ignored.

Parameters:

mode - the mode to set

getSensitivity

public float getSensitivity()

This gets the sensitivity to be used in modes CTRL_HORIZONTAL and CTRL_VERTICAL

Returns:

the sensitivity

setSensitivity

public void setSensitivity(float sensitivity)

This gets the sensitivity to be used in modes CTRL_HORIZONTAL and CTRL_VERTICAL
A value of 1 is 1 degree per pixel and a value of 2 is 2 degrees per pixel.

Parameters:

sensitivity - the sensitivity to set

setTurnRange

public void setTurnRange(float start,
                float end)

Set the limits for the range of valid rotation angles for the knob.

Parameters:

start - the range start angle in degrees

end - the range end angle in degrees