Button Events (LogiX node)
Button Events | ||
---|---|---|
Inputs | ||
IButton | Button | |
Outputs | ||
Impulse | Pressed | |
Impulse | Pressing | |
Impulse | Released | |
Impulse | HoverEnter | |
Impulse | HoverStay | |
Impulse | HoverLeave | |
Component | Source | |
Float3 | GlobalPoint | |
Float2 | LocalPoint | |
Float2 | NormalizedPoint |
The Button Events node fires impulses when the input Button
is interacted with. It also outputs additional information about the interacting Component
and where the interaction occurred.
Usage
All output impulses are owned by the user interacting with the Button
.
The Pressed
output fires a single impulse when the Button
is pressed.
The Pressing
output fires a single impulse every frame while the Button
is pressed. The first impulse from Pressing
is fired the frame after the impulse from Pressed
.
The Released
output fires a single impulse when the Button
stops being pressed. If the Button
is a NeosButton, this fires the frame after Pressed
.
The HoverEnter
output fires a single impulse when a user's interaction laser hovers over the Button
.
The HoverStay
output fires an impulse every frame while a user's interaction laser is hovering over the Button
. The first impulse from HoverStay
is fired the frame after the impulse from HoverEnter
.
The HoverLeave
output fires a single impulse when a user's interaction laser stops hovering over the Button
.
The Source
output provides the Component responsible for interacting with the Button
when any of the impulse outputs fire. The value is only available for the duration of the relevant impulse chain.
The GlobalPoint
output provides the global position of the point where the Button
interaction occurred when any of the impulse outputs fire. The value is only available for the duration of the relevant impulse chain.
The LocalPoint
output provides the X and Y coordinates (in the Button
slot's local coordinate space) when where the Button
interaction occurred when any of the impulse outputs fire. The value is only available for the duration of the relevant impulse chain.
The NormalizedPoint
output provides the X and Y coordinates on the surface of the Button
where the interaction occurred when any of the impulse outputs fire. The value is normalised to the range -0.5 to 0.5 in both dimensions.
Components which can be referenced as an IButton for the Button
input include the NeosButton, PhysicalButton, TouchButton, and UIX Button. All impulse outputs will function with a UIX Button and TouchButton. Only Pressed
and Released
will output impulses for a NeosButton. Only Pressed
, Released
, HoverEnter
, and HoverLeave
will output impulses for PhysicalButton.
Button events respect the AcceptPhysicalTouch
and AcceptRemoteTouch
fields on the respective NeosButton/PhysicalButton components or UIX canvas. Hover events will not be fired if the component/canvas does not accept remote touches.
Examples
Node Menu
Interaction | ||||||
---|---|---|---|---|---|---|
Back | Grabbable | Touchable | Button Events | Close Context Menu | Is Context Menu Open | Notify Modified |
Text Editor Events | Tip Jar Events |