Difference between revisions of "Component: Joystick (Controls)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix TSL
 
| Matrix TSL
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.0 (Release)
+
| 1.0
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Controls
 
| Controls
 
|}
 
|}
  
  
−
 
+
==Joystick component==
−
==[[File:Component Icon 29e63c23_636f_4f9a_b691_ba1a717e3503.png|Image]] Joystick component==
 
 
A simple joystick component allowing for easy mouse or touchscreen based analogue control.
 
A simple joystick component allowing for easy mouse or touchscreen based analogue control.
  
−
==Examples==
+
==Component Pack==
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
SCADA
  
−
==Downloadable macro reference==
+
==Detailed description==
  
−
''This component does not contain any downloadable macros''
 
  
−
==Simulation macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>ReadAxisAsFloat</tt></u></span>===
 
−
Reads a single axis of the joystick and returns as a floating point value.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''Axis''
 
−
::Range 0-1 Where 0=X, 1=Y
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|FLOAT]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>ReadAxisAsInt</tt></u></span>===
 
−
Reads a single axis of the joystick and returns as a signed integer value.
 
  
−
'''Parameters'''
+
''No detailed description exists yet for this component''
  
−
:[[Variable Types|BYTE]] ''Axis''
+
==Examples==
−
::Range 0-1 Where 0=X, 1=Y
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|INT]]
 
  
  
  
  
−
==Property reference==
 
−
<span style="font-weight: normal;"><u>Joystick Type</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''JoyType''.
 
  
−
Defines the directions the joystick can travel.
 
  
−
<span style="font-weight: normal;"><u>Return To Center</u></span>
 
  
−
This property is of type ''True or false'' and can be referenced with the variable name ''ReturnToCenter''.
 
  
−
Decides if the joystick automatically returns to the center position when released.
+
''<span style="color:red;">No additional examples</span>''
  
−
Yes: The joystick will return to the center when released.
 
  
−
No: The joystick will remain in the current position when released.
+
==Downloadable macro reference==
  
−
<span style="font-weight: normal;"><u>Y Min</u></span>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAxisAsFloat'''
 +
|-
 +
| colspan="2" | Reads a single axis of the joystick and returns as a floating point value.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Axis
 +
|-
 +
| colspan="2" | Range 0-1 Where 0=X, 1=Y&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
This property is of type ''Floating point'' and can be referenced with the variable name ''YMin''.
 
  
−
''<span style="color:red;">No additional information</span>''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAxisAsInt'''
 +
|-
 +
| colspan="2" | Reads a single axis of the joystick and returns as a signed integer value.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Axis
 +
|-
 +
| colspan="2" | Range 0-1 Where 0=X, 1=Y&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
  
−
<span style="font-weight: normal;"><u>Y Max</u></span>
 
  
−
This property is of type ''Floating point'' and can be referenced with the variable name ''YMax''.
+
==Property reference==
  
−
''<span style="color:red;">No additional information</span>''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
<span style="font-weight: normal;"><u>Box Colour</u></span>
+
|-
−
 
+
|-
−
This property is of type ''Color picker'' and can be referenced with the variable name ''BoxCol''.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Joystick Type
−
''<span style="color:red;">No additional information</span>''
+
|-
−
 
+
| colspan="2" | Defines the directions the joystick can travel.&nbsp;
−
 
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
<span style="font-weight: normal;"><u>Shaft Colour</u></span>
+
| width="90%" | Return To Center
−
 
+
|-
−
This property is of type ''Color picker'' and can be referenced with the variable name ''ShaftCol''.
+
| colspan="2" | Decides if the joystick automatically returns to the center position when released. Yes: The joystick will return to the center when released. No: The joystick will remain in the current position when released.&nbsp;
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Limits
−
 
+
|-
−
 
+
|-
−
<span style="font-weight: normal;"><u>Knob Colour</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
−
 
+
| width="90%" | Y Min
−
This property is of type ''Color picker'' and can be referenced with the variable name ''KnobCol''.
+
|-
−
 
+
| colspan="2" | &nbsp;
−
''<span style="color:red;">No additional information</span>''
+
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Y Max
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Theme
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Box Colour
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Shaft Colour
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Knob Colour
 +
|-
 +
| colspan="2" | &nbsp;
 +
|}

Latest revision as of 17:22, 9 November 2022

Author Matrix TSL
Version 1.0
Category Controls


Joystick component

A simple joystick component allowing for easy mouse or touchscreen based analogue control.

Component Pack

SCADA

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png ReadAxisAsFloat
Reads a single axis of the joystick and returns as a floating point value. 
Fc9-u8-icon.png - BYTE Axis
Range 0-1 Where 0=X, 1=Y 
Fc9-f32-icon.png - FLOAT Return


Fc9-comp-macro.png ReadAxisAsInt
Reads a single axis of the joystick and returns as a signed integer value. 
Fc9-u8-icon.png - BYTE Axis
Range 0-1 Where 0=X, 1=Y 
Fc9-s16-icon.png - INT Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Joystick Type
Defines the directions the joystick can travel. 
Fc9-type-7-icon.png Return To Center
Decides if the joystick automatically returns to the center position when released. Yes: The joystick will return to the center when released. No: The joystick will remain in the current position when released. 
Fc9-conn-icon.png Limits
Fc9-type-15-icon.png Y Min
 
Fc9-type-15-icon.png Y Max
 
Fc9-conn-icon.png Theme
Fc9-type-1-icon.png Box Colour
 
Fc9-type-1-icon.png Shaft Colour
 
Fc9-type-1-icon.png Knob Colour
 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_Joystick_(Controls)&oldid=28722"