g4p_controls

Class GKnob

java.lang.Object

g4p_controls.GAbstractControl

g4p_controls.GValueControl

g4p_controls.GKnob

All Implemented Interfaces:

GConstants, GConstantsInternal, 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 inherited from class g4p_controls.GAbstractControl

tag, tagNo

Fields inherited from interface processing.core.PConstants

ADD, ALPHA, ALPHA_MASK, ALT, AMBIENT, ARC, ARGB, ARROW, BACKSPACE, BASELINE, BEVEL, BEZIER_VERTEX, BLEND, BLUE_MASK, BLUR, BOTTOM, BOX, BREAK, BURN, CENTER, CHATTER, CLAMP, CLOSE, CODED, COMPLAINT, CONTROL, CORNER, CORNERS, CROSS, CURVE_VERTEX, CUSTOM, DARKEST, DEG_TO_RAD, DELETE, DIAMETER, DIFFERENCE, DILATE, DIRECTIONAL, DISABLE_ACCURATE_2D, DISABLE_ACCURATE_TEXTURES, DISABLE_DEPTH_MASK, DISABLE_DEPTH_SORT, DISABLE_DEPTH_TEST, DISABLE_NATIVE_FONTS, DISABLE_OPENGL_ERRORS, DISABLE_STROKE_PERSPECTIVE, DISABLE_STROKE_PURE, DISABLE_TEXTURE_CACHE, DISABLE_TEXTURE_MIPMAPS, DISABLE_TRANSFORM_CACHE, DODGE, DOWN, DXF, ELLIPSE, ENABLE_ACCURATE_2D, ENABLE_ACCURATE_TEXTURES, ENABLE_DEPTH_MASK, ENABLE_DEPTH_SORT, ENABLE_DEPTH_TEST, ENABLE_NATIVE_FONTS, ENABLE_OPENGL_ERRORS, ENABLE_STROKE_PERSPECTIVE, ENABLE_STROKE_PURE, ENABLE_TEXTURE_CACHE, ENABLE_TEXTURE_MIPMAPS, ENABLE_TRANSFORM_CACHE, ENTER, EPSILON, ERODE, ERROR_BACKGROUND_IMAGE_FORMAT, ERROR_BACKGROUND_IMAGE_SIZE, ERROR_PUSHMATRIX_OVERFLOW, ERROR_PUSHMATRIX_UNDERFLOW, ERROR_TEXTFONT_NULL_PFONT, ESC, EXCLUSION, GIF, GRAY, GREEN_MASK, 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, platformNames, POINT, POINTS, POLYGON, PORTRAIT, POSTERIZE, PROBLEM, PROJECT, PROJECTION, QUAD, QUAD_BEZIER_VERTEX, QUAD_STRIP, QUADS, QUARTER_PI, RAD_TO_DEG, RADIUS, RECT, RED_MASK, REPEAT, REPLACE, RETURN, RGB, RIGHT, ROUND, SCREEN, SHAPE, SHIFT, SOFT_LIGHT, SPHERE, SPOT, SQUARE, SUBTRACT, TAB, TARGA, 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, CLOSE_WINDOW, CTRL_ANGULAR, CTRL_HORIZONTAL, CTRL_VERTICAL, CYAN_SCHEME, DECIMAL, EXIT_APP, EXPONENT, FAMILY, FOREGROUND, GOLD_SCHEME, GREEN_SCHEME, INTEGER, KEEP_OPEN, ORANGE_SCHEME, ORIENT_LEFT, ORIENT_RIGHT, ORIENT_TRACK, POSTURE, POSTURE_OBLIQUE, POSTURE_REGULAR, PURPLE_SCHEME, RED_SCHEME, SCHEME_10, SCHEME_11, SCHEME_12, SCHEME_13, SCHEME_14, SCHEME_15, SCHEME_8, SCHEME_9, SCROLLBAR_HORIZONTAL, SCROLLBAR_VERTICAL, 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, 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, YELLOW_SCHEME

Fields inherited from interface g4p_controls.GConstantsInternal

ALL_METHOD, CLIP_RUN, COMBI_MODES, DRAW_METHOD, EXCP_IN_HANDLER, grid, I_CL, I_COVERED, I_CR, I_INSIDE, I_MODES, I_NONE, I_TL, I_TR, KEY_METHOD, MERGE_RUNS, MISSING, MOUSE_METHOD, NONEXISTANT, OFF_CONTROL, OVER_CONTROL, pen_1_0, pen_2_0, pen_3_0, pen_4_0, POST_METHOD, PRE_METHOD, PRESS_CONTROL, RUNTIME_ERROR, TINT_FOR_ALPHA

Constructor Summary

Constructors

Constructor and Description
GKnob(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(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, forceBufferUpdate, getCursorOver, getCX, getCY, getFocusName, getHeight, getLocalColorScheme, getPApplet, getParent, getSnapshot, getWidth, getX, getY, hasFocus, isDragging, isEnabled, isOpaque, isVisible, keyEvent, markForDisposal, post, setAlpha, setAlpha, setAvailable, setAvailableChildren, setCursorOver, setEnabled, setFocus, setLocalColorScheme, setLocalColorScheme, setOpaque, setRotation, setRotation, setVisible, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GKnob

public GKnob(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(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