FindHoveredNodeAction

Find the topmost node that occupies the given position on the screen, along with its scrollable.

The result may change while the search runs; the final result is available once the action stops.

On top of finding the node at specified position, a scroll value can be passed through the pointer so this action will also find any Scrollable ancestor present in the branch, if one can handle the motion. The hovered node and the scrollable node can be the same.

For backwards compatibility, this node is not currently registered as a NodeSearchAction and does not emit a node when done.

@safe final

class FindHoveredNodeAction : BranchAction {

import fluid.node;;

Node result;

HoverScrollable scrollable;

HoverPointer pointer;

this(HoverPointer pointer);

void started();

void beforeDraw(Node node, Rectangle , Rectangle outer, Rectangle inner);

void afterDraw(Node node, Rectangle );

}

Constructors

this this(HoverPointer pointer): Undocumented in source.

Members

Functions

afterDraw void afterDraw(Node node, Rectangle ): Find a matching scrollable for the node. The topmost ancestor of result (the chosen node) will be used.
beforeDraw void beforeDraw(Node node, Rectangle , Rectangle outer, Rectangle inner): Test if the searched position is within the bounds of this node, and set it as the result if so. Any previously found result is overridden.
started void started(): Undocumented in source. Be warned that the author may not have intended to support it.

Variables

pointer HoverPointer pointer;: Position to use for the lookup. The pointer determines the current position and scroll value of interest.
result Node result;: If a node was found, this is the result.
scrollable HoverScrollable scrollable;: Topmost scrollable ancestor of result (the chosen node).

Inherited Members

From BranchAction

beforeTree void beforeTree(Node , Rectangle )
beforeResize void beforeResize(Node , Vector2 )
afterTree void afterTree()
afterInput void afterInput(bool ): A branch action can only hook to draw calls of specific nodes. It cannot bind into these hooks.
filterBeforeDraw bool filterBeforeDraw(Node node): Branch action excludes the start node from results.
filterAfterDraw bool filterAfterDraw(Node node): Branch action excludes the start node from results.
stopped void stopped(): Undocumented in source. Be warned that the author may not have intended to support it.