controlP5
Class Knob

java.lang.Object
  extended by controlP5.Controller
      extended by controlP5.Knob
All Implemented Interfaces:
CDrawable, ControllerInterface, ControlP5Constants

public class Knob
extends Controller

a knob. description tbd.


Field Summary
 
Fields inherited from class controlP5.Controller
MOVE, PRESSED, RELEASE
 
Fields inherited from interface controlP5.ControlP5Constants
acceptClassList, ALT, ARRAY, BACKSPACE, BOOLEAN, CONTROL, DECREASE, DELETE, DOWN, ENTER, ESCAPE, eventMethod, FIELD, FLOAT, HALF_PI, HIDE, INCREASE, INTEGER, INVALID, KEYCONTROL, LEFT, LOAD, MENU, METHOD, PI, PRINT, RESET, RIGHT, SAVE, SHIFT, STRING, SWITCH_BACK, SWITCH_FORE, TAB, TWO_PI, UP, VERBOSE
 
Constructor Summary
Knob(ControlP5 theControlP5, ControllerGroup theParent, java.lang.String theName, float theMin, float theMax, float theDefaultValue, int theX, int theY, int theWidth)
           
 
Method Summary
 void addToXMLElement(ControlP5XMLElement theElement)
           
 void draw(processing.core.PApplet theApplet)
           
 void mousePressed()
           
 void mouseReleased()
           
 void setMax(float theValue)
          set the maximum level of the knob.
 void setMin(float theValue)
          set the minimum level of the knob.
 void setOffsetAngle(float theValue)
           
 void setValue(float theValue)
          set the value of the controller.
 void update()
          updates the value of the controller without having to set the value explicitly.
 void updateInternalEvents(processing.core.PApplet theApplet)
          TODO
 
Methods inherited from class controlP5.Controller
absolutePosition, add, addListener, arrayValue, behavior, captionLabel, changeValue, color, continuousUpdateEvents, controlWindow, defaultValue, disableSprite, enableSprite, getAsXML, getColor, getHeight, getTab, getWidth, getWindow, hide, id, init, isBroadcast, isInside, isMousePressed, isUpdate, isVisible, isXMLsavable, keyEvent, label, listenerSize, max, min, moveTo, moveTo, moveTo, moveTo, moveTo, moveTo, moveTo, moveTo, name, parent, position, remove, remove, removeBehavior, removeListener, setArrayValue, setBehavior, setBroadcast, setCaptionLabel, setColorActive, setColorBackground, setColorForeground, setColorLabel, setColorValue, setDecimalPrecision, setDefaultValue, setGroup, setGroup, setHeight, setId, setLabel, setLabelVisible, setMousePressed, setMoveable, setParent, setPosition, setSprite, setTab, setTab, setUpdate, setValueLabel, setVisible, setWidth, setWindow, setWindow, show, stringValue, trigger, updateAbsolutePosition, updateEvents, value, valueLabel
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Knob

public Knob(ControlP5 theControlP5,
            ControllerGroup theParent,
            java.lang.String theName,
            float theMin,
            float theMax,
            float theDefaultValue,
            int theX,
            int theY,
            int theWidth)
Parameters:
theControlP5 - ControlP5
theParent - ControllerGroup
theName - String
theMin - float
theMax - float
theDefaultValue - float
theX - int
theY - int
theWidth - int
Method Detail

updateInternalEvents

public void updateInternalEvents(processing.core.PApplet theApplet)
Description copied from class: Controller
TODO

Specified by:
updateInternalEvents in interface ControllerInterface
Overrides:
updateInternalEvents in class Controller
See Also:
ControllerInterfalce.updateInternalEvents

draw

public void draw(processing.core.PApplet theApplet)
Specified by:
draw in interface CDrawable
Specified by:
draw in interface ControllerInterface
Overrides:
draw in class Controller
Parameters:
theApplet - PApplet

mousePressed

public void mousePressed()

mouseReleased

public void mouseReleased()

setMin

public void setMin(float theValue)
set the minimum level of the knob.

Overrides:
setMin in class Controller
Parameters:
theValue - float

setMax

public void setMax(float theValue)
set the maximum level of the knob.

Overrides:
setMax in class Controller
Parameters:
theValue - float

setValue

public void setValue(float theValue)
Description copied from class: Controller
set the value of the controller.

Specified by:
setValue in class Controller
Parameters:
theValue - float

update

public void update()
Description copied from class: Controller
updates the value of the controller without having to set the value explicitly. update does not visually update the controller. the updating status can be set with setUpdate(true/false) and checked with isUpdate().

Specified by:
update in interface ControllerInterface
Overrides:
update in class Controller

setOffsetAngle

public void setOffsetAngle(float theValue)

addToXMLElement

public void addToXMLElement(ControlP5XMLElement theElement)
Parameters:
theElement - ControlP5XMLElement


processing library controlP5 by Andreas Schlegel. (c) 2010