The unique identifier for this control.
This is true if the control can respond to UI events else false.
Use enable() and disable() to enable and disable it.
This is true if the control background is opaque else false.
Use opaque() and transparent() display / hide the background.
This is true if the control is visible else false.
Use hide() and show() to set visibility.
The type name for this control.
(type name = class name without the Cvs prefix)
Add a child to this control using its relative position [rx, ry]. If rx and ry are not provided then it uses the values set in the child.
this control
is the actual control or its id
Optional rx: numberOptional ry: numberGet or set the corner radii used for this control.
To set the radii the parameters must be one of the following
If no parameter is passed or does not match one of the above then an array of the currently used radii values.
an array of the currently used radii values
Rest ...c: anyvalid radii combination
Disables this control.
this control
Optional cascade: booleanif true disable child controls
Enables this control.
this control
Optional cascade: booleanif true enable child controls
Make this control invisible.
this control
Optional cascade: booleanif true hide children
Remove this control from its parent
this control
The mode defines the constraints applied to movement of the joystick. There are three permitted modes -
Any other value will be silently ignored.
this control
either 'X0', 'X4' or 'X8'
Move this control relative to current position.
this control
horizontal distance
vertical distance
Move this control to an absolute position.
this control
horizontal position
vertical position
Makes the controls background opaque. The actual color depends on the controls color scheme.
The second parameter, alpha, is optional and controls the level of opaqueness from 0 - transparent to 255 - fully opaque (efault value).
this control
alpha value for controls background color.
Sets this controls display orientation to one of the four cardinal compass points. An invalid parameter will set the orientation to 'east' which is the default value.
this control
'north', 'south', 'east' or 'west'
Adds this control to another control which becomes its parent.
this control
is the parental control or its id
Optional rx: numberx position relative to parent
Optional ry: numbery position relative to parent
Remove a child control from this one so that it stays in same screen position.
this control
the control to remove or its id
If the name of a valid color scheme is provided then it will use it to display the control, non-existant scheme names will be ignored. In both cases this control is returned.
If there is no parameter it returns the name of the current color scheme used by this control.
this control or the control's color scheme
Optional name: stringthe color scheme name e.g. 'blue'
Optional cascade: booleanif true propogate scheme to all child controls.
This sets the event handler to be used when this control fires an event. The parameter can take one of three forms:
this control
the function to handle this control's events.
Make this control visible.
this control
Optional cascade: booleanif true show children
Shrink the control to fit contents.
To shrink on one dimension only pass either 'w' (width) or 'h' (height) to indicate which dimmension to shrink
this control
Optional dim: stringthe dimension to shrink
Set the thumb size.
this control
the diameter of the thumb
Sets the size of the text to use in the tooltip.
Optional tsize: numbertext size for this tooltip
Create a tooltip for this control.
this control
the text to appear in the tooltip
Makes the controls background fully transparent.
this control
Generated using TypeDoc
This class simulates a multi-mode joystick. Each of the three possible modes apply different constraints to the range of movement allowed they are -.
'X0': can move in any direction (360°). This is the default value.'X4': constrained to the 4 main compass directions (N, E, S, W).'X8': constrained to the 8 main compass directions (N, NE, E, SE, S, SW, W, NW).To handle events use the
setActionmethod to specify the action-method that will be used to process action-info objects created when the joystick is moved.The action-info object has several very useful fields that describes the state of the joystick, they include -
dirAn integer that indicates the direction the stick is pushed. The values returned depend on the current mode -
Direction values for X4 and X8 modes 5 6 7 \ | / \ | / 4 --- Z --- 0 Z is the dead zone. / | \ / | \ If control is in mode 'X0' or the joystick 3 2 1 position is in the dead zone then the value is -1'X0': always -1'X4': 0, 2, 4 or 6'X8': 0, 1, 2, 3, 4, 5, 6 or 7deadIf the stick is in the dead zone which surrounds the stick's rest state then this value will be
true.magThe magnitude is in range ≥ 0 and ≤ 1 representing the distance the stick has been pushed.
angleThe angle is in range ≥ 0 and < 2π representing the angle the stick makes to the poistive x axis in the clockwise direction. In modes X4 and X8 the angles will be constrained to the permitted directions.
finalThis is
falseif the stick is still being moved andtrueif the stick has been released.When the joystick is released it will return back to its rest state i.e. centered.