The event handler for this control. Although it is permitted to set
this property directly it is recommended that the setAction(...)
method is used to define the event handler actions.
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 name
Optional rx: numberOptional ry: numberSet or get the corner radii used for this control
an array with the 4 corner radii
an array of 4 corner radii
Disables this control
this control
Optional cascade: booleanif true disable child controls
Enables this control
this control
Optional cascade: booleanif true enable child controls
this controls parent
Make this control invisible
this control
Optional cascade: booleanif true hide children
Invalidates the control's buffer forcing it to validate it on the next frame
this control
Remove this control from its parent
this control
Makes the controls background opaque. The actual color depends on the controls color scheme
this control
Specify the orientation to show this control
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 name
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 name
This sets the event handler to be used when this control fires an event. The parameter can take three forms:
this control
the function to handle this controls event
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
how long the tip remains visible (milliseconds)
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°).'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 dthat 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 the 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.mag: has a value in range ≥ 0 and ≤ 1 representing the distance the stick has been pushed.angle: has a value 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.final: has the valuefalseif the stick is still being moved andfalseif the stick has been released.When the joystick is released it will return back to its rest state i.e. centered.
Since
1.1.0