Difference between revisions of "Component: Button helper (Helpers)"
From Flowcode Help
Jump to navigationJump to search(One intermediate revision by the same user not shown) | |||
Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
− | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/ | + | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_buttonhelper.fcfx FC_Comp_Source_buttonhelper.fcfx] |
− | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/ | + | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_buttonhelper.fcfx FC_Comp_Source_buttonhelper.fcfx] |
==Detailed description== | ==Detailed description== | ||
Line 57: | Line 57: | ||
''<span style="color:red;">No additional examples</span>'' | ''<span style="color:red;">No additional examples</span>'' | ||
+ | |||
+ | |||
+ | |||
+ | |||
Line 508: | Line 512: | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
− | |||
− | |||
Latest revision as of 13:13, 7 February 2023
Author | Matrix Ltd |
Version | 1.1 |
Category | Helpers |
Contents
- 1 Button helper component
- 2 Component Source Code
- 3 Detailed description
- 4 Examples
- 5 Macro reference
- 5.1 Clear
- 5.2 GetState
- 5.3 GetStateFor
- 5.4 GetTarget
- 5.5 Register
- 5.6 SetAutoReset
- 5.7 SetAxis
- 5.8 SetAxisFor
- 5.9 SetDisabledPos
- 5.10 SetDisabledPosFor
- 5.11 SetEnabledPos
- 5.12 SetEnabledPosFor
- 5.13 SetLatching
- 5.14 SetLatchingFor
- 5.15 SetMode
- 5.16 SetModeFor
- 5.17 SetMovement
- 5.18 SetMovementFor
- 5.19 SetNotify
- 5.20 SetPivotPos
- 5.21 SetPivotPosFor
- 5.22 Unregister
- 6 Property reference
Button helper component
A button overlay that allows any object to behave like a button
Component Source Code
Please click here to download the component source project: FC_Comp_Source_buttonhelper.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_buttonhelper.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
Clear
![]() |
Clear |
Clears all objects from the lists This leaves no links for the button helper | |
![]() |
Return |
GetState
![]() |
GetState |
Returns true if the button is depressed, else false | |
![]() |
Return |
GetStateFor
![]() |
GetStateFor |
Returns true if the button is depressed, else false | |
![]() |
Target |
![]() |
Return |
GetTarget
![]() |
GetTarget |
Gets the target handle the property links to | |
![]() |
Return |
Register
![]() |
Register |
Adds the object to the list if not already there | |
![]() |
Target |
![]() |
Return |
SetAutoReset
SetAxis
![]() |
SetAxis |
Sets the movement axis as an Axis_... constant | |
![]() |
Axis |
Movement axis to set to, default 4 | |
![]() |
Return |
SetAxisFor
![]() |
SetAxisFor |
Sets the movement axis as an Axis_... constant | |
![]() |
Target |
![]() |
Axis |
Movement axis to set to, default 4 | |
![]() |
Return |
SetDisabledPos
![]() |
SetDisabledPos |
Sets the position of the released button | |
![]() |
PositionHandle |
A handle to the position of the depressed location | |
![]() |
Return |
SetDisabledPosFor
![]() |
SetDisabledPosFor |
Sets the disabled position for an object | |
![]() |
Target |
![]() |
Position |
![]() |
Return |
SetEnabledPos
![]() |
SetEnabledPos |
Sets the position of the depressed button | |
![]() |
PositionHandle |
A handle to the position of the depressed location | |
![]() |
Return |
SetEnabledPosFor
![]() |
SetEnabledPosFor |
Sets the enabled position for an object | |
![]() |
Target |
![]() |
Position |
![]() |
Return |
SetLatching
![]() |
SetLatching |
Sets whether the button is depressed when the mouse is released | |
![]() |
Enabled |
![]() |
Return |
SetLatchingFor
![]() |
SetLatchingFor |
Sets whether the button is depressed when the mouse is released | |
![]() |
Target |
![]() |
Enabled |
![]() |
Return |
SetMode
![]() |
SetMode |
Sets the animation mode for the button | |
![]() |
Mode |
0=User, 1=Up/Down, 2 = Lever | |
![]() |
Return |
SetModeFor
![]() |
SetModeFor |
Sets the animation mode for the button | |
![]() |
Target |
The target object, 0 for 'set default' | |
![]() |
Mode |
0=User, 1=Up/Down, 2 = Lever | |
![]() |
Return |
SetMovement
![]() |
SetMovement |
Sets the movement in units or PI/16 steps for the button | |
![]() |
Move |
Movement to set to - default is 4 | |
![]() |
Return |
SetMovementFor
![]() |
SetMovementFor |
Sets the movement in units or PI/16 steps for the button | |
![]() |
Target |
![]() |
Move |
Movement to set to, default 4 | |
![]() |
Return |
SetNotify
SetPivotPos
![]() |
SetPivotPos |
Sets the position of the object the lever rotates around | |
![]() |
PositionHandle |
A handle to the position of the depressed location | |
![]() |
Return |
SetPivotPosFor
![]() |
SetPivotPosFor |
Sets the position the lever rotates around for an object | |
![]() |
Target |
![]() |
Position |
![]() |
Return |
Unregister
![]() |
Unregister |
Removes the object to the list if present | |
![]() |
Target |
![]() |
Return |
Property reference
![]() |
Properties |
![]() |
Host component |
![]() |
Lever pivot |