minimalcomps.components.Knob

A knob component for choosing a numerical value.

Constructor

`new (?parent:DisplayObjectContainer, ?xpos:Float, ?ypos:Float, ?label:String, ?defaultHandler:Dynamic)`

Constructor

Parameters:

`parent`	The parent DisplayObjectContainer on which to add this Knob.
`xpos`	The x position to place this component.
`ypos`	The y position to place this component.
`label`	String containing the label for this component.
`defaultHandler`	The event handling function to handle the default event for this component (change in this case).

Variables

`label:String`

Gets / sets the text shown in this component's label.

`labelPrecision:Int`

Gets / sets the number of decimals to format the value label.

`maximum:Float`

Gets / sets the maximum value of this knob.

`minimum:Float`

Gets / sets the minimum value of this knob.

`mode:String`

`mouseRange:Float`

Sets / gets the number of pixels the mouse needs to move to make the value of the knob go from min to max.

`radius:Float`

`showValue:Bool`

Gets / sets whether or not to show the value label.

`value:Float`

Sets / gets the current value of this knob.

Methods

`draw ():Void`

Draws the visual ui of the component.

`w`	The width of the component.
`h`	The height of the component.

`xpos`	the x position to move the component
`ypos`	the y position to move the component

class Knob

package minimalcomps.components

extends Component

Constructor

new (?parent:DisplayObjectContainer, ?xpos:Float, ?ypos:Float, ?label:String, ?defaultHandler:Dynamic)

Variables

label:String

labelPrecision:Int

maximum:Float

minimum:Float

mode:String

mouseRange:Float

radius:Float

showValue:Bool

value:Float

Methods

draw ():Void

get_label ():String

get_labelPrecision ():Int

get_maximum ():Float

get_minimum ():Float

get_mode ():String

get_mouseRange ():Float

get_radius ():Float

get_showValue ():Bool

get_value ():Float

set_label (value:String):String

set_labelPrecision (value:Int):Int

set_maximum (value:Float):Float

set_minimum (value:Float):Float

set_mode (value:String):String

set_mouseRange (value:Float):Float

set_radius (value:Float):Float

set_showValue (value:Bool):Bool

set_value (value:Float):Float

Static variables

staticinline read onlyHORIZONTAL:String

staticinline read onlyROTATE:String

staticinline read onlyVERTICAL:String

Inherited Variables

Defined by Component

enabled:Bool

tag:Int

Inherited Methods

Defined by Component

get_enabled ():Bool

get_height ():Float

get_tag ():Int

get_width ():Float

move (xpos:Float, ypos:Float):Void

setSize (w:Float, h:Float):Void

set_enabled (value:Bool):Bool

set_height (value:Float):Void

set_tag (value:Int):Int

set_width (value:Float):Void

set_x (value:Float):Void

set_y (value:Float):Void

`new (?parent:DisplayObjectContainer, ?xpos:Float, ?ypos:Float, ?label:String, ?defaultHandler:Dynamic)`

`label:String`

`labelPrecision:Int`

`maximum:Float`

`minimum:Float`

`mode:String`

`mouseRange:Float`

`radius:Float`

`showValue:Bool`

`value:Float`

`draw ():Void`

`get_label ():String`

`get_labelPrecision ():Int`

`get_maximum ():Float`

`get_minimum ():Float`

`get_mode ():String`

`get_mouseRange ():Float`

`get_radius ():Float`

`get_showValue ():Bool`

`get_value ():Float`

`set_label (value:String):String`

`set_labelPrecision (value:Int):Int`

`set_maximum (value:Float):Float`

`set_minimum (value:Float):Float`

`set_mode (value:String):String`

`set_mouseRange (value:Float):Float`

`set_radius (value:Float):Float`

`set_showValue (value:Bool):Bool`

`set_value (value:Float):Float`

`staticinline read onlyHORIZONTAL:String`

`staticinline read onlyROTATE:String`

`staticinline read onlyVERTICAL:String`

`enabled:Bool`

`tag:Int`

`get_enabled ():Bool`

`get_height ():Float`

`get_tag ():Int`

`get_width ():Float`

`move (xpos:Float, ypos:Float):Void`

`setSize (w:Float, h:Float):Void`

`set_enabled (value:Bool):Bool`

`set_height (value:Float):Void`

`set_tag (value:Int):Int`

`set_width (value:Float):Void`

`set_x (value:Float):Void`

`set_y (value:Float):Void`