Component: Button helper (Helpers)
From Flowcode Help
(Redirected from Component: ID 3005c264 3a6d 412a 97dc 2569ed8c149c)
Jump to navigationJump to searchAuthor | 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 | |
- VOID | Return |
GetState
GetState | |
Returns true if the button is depressed, else false | |
- BOOL | Return |
GetStateFor
GetStateFor | |
Returns true if the button is depressed, else false | |
- HANDLE | Target |
- BOOL | Return |
GetTarget
GetTarget | |
Gets the target handle the property links to | |
- HANDLE | Return |
Register
Register | |
Adds the object to the list if not already there | |
- HANDLE | Target |
- VOID | Return |
SetAutoReset
SetAxis
SetAxis | |
Sets the movement axis as an Axis_... constant | |
- BYTE | Axis |
Movement axis to set to, default 4 | |
- VOID | Return |
SetAxisFor
SetAxisFor | |
Sets the movement axis as an Axis_... constant | |
- HANDLE | Target |
- BYTE | Axis |
Movement axis to set to, default 4 | |
- VOID | Return |
SetDisabledPos
SetDisabledPos | |
Sets the position of the released button | |
- HANDLE | PositionHandle |
A handle to the position of the depressed location | |
- VOID | Return |
SetDisabledPosFor
SetDisabledPosFor | |
Sets the disabled position for an object | |
- HANDLE | Target |
- HANDLE | Position |
- VOID | Return |
SetEnabledPos
SetEnabledPos | |
Sets the position of the depressed button | |
- HANDLE | PositionHandle |
A handle to the position of the depressed location | |
- VOID | Return |
SetEnabledPosFor
SetEnabledPosFor | |
Sets the enabled position for an object | |
- HANDLE | Target |
- HANDLE | Position |
- VOID | Return |
SetLatching
SetLatching | |
Sets whether the button is depressed when the mouse is released | |
- BOOL | Enabled |
- VOID | Return |
SetLatchingFor
SetLatchingFor | |
Sets whether the button is depressed when the mouse is released | |
- HANDLE | Target |
- BOOL | Enabled |
- VOID | Return |
SetMode
SetMode | |
Sets the animation mode for the button | |
- BYTE | Mode |
0=User, 1=Up/Down, 2 = Lever | |
- VOID | Return |
SetModeFor
SetModeFor | |
Sets the animation mode for the button | |
- HANDLE | Target |
The target object, 0 for 'set default' | |
- BYTE | Mode |
0=User, 1=Up/Down, 2 = Lever | |
- VOID | Return |
SetMovement
SetMovement | |
Sets the movement in units or PI/16 steps for the button | |
- FLOAT | Move |
Movement to set to - default is 4 | |
- VOID | Return |
SetMovementFor
SetMovementFor | |
Sets the movement in units or PI/16 steps for the button | |
- HANDLE | Target |
- FLOAT | Move |
Movement to set to, default 4 | |
- VOID | Return |
SetNotify
SetPivotPos
SetPivotPos | |
Sets the position of the object the lever rotates around | |
- HANDLE | PositionHandle |
A handle to the position of the depressed location | |
- VOID | Return |
SetPivotPosFor
SetPivotPosFor | |
Sets the position the lever rotates around for an object | |
- HANDLE | Target |
- HANDLE | Position |
- VOID | Return |
Unregister
Unregister | |
Removes the object to the list if present | |
- HANDLE | Target |
- VOID | Return |
Property reference
Properties | |
Host component | |
Lever pivot | |