LayoutTree

Constructors

this

this(Node root, FluidBackend backend)

Create a new tree with the given node as its root, and using the given backend for I/O.

this

this(Node root)

Create a new tree with the given node as its root. Use the default backend, if any is present.

Members

Aliases

io

alias io = backend

Undocumented in source.

keyboardHandled

deprecated alias keyboardHandled = wasKeyboardHandled

Undocumented in source.

Functions

bindInput

void bindInput(InputActionID action, InputStroke stroke)

Bind a key stroke or button to given input action. Multiple key strokes are allowed to match given action.

bindInputReplace

void bindInputReplace(InputActionID action, InputStroke stroke)

Bind a key stroke or button to given input action, replacing any previously bound inputs.

clearBoundInput

bool clearBoundInput(InputActionID action)

Remove any inputs bound to given input action.

filterActions

auto filterActions()

List actions in the tree, remove finished actions while iterating.

intersectScissors

Rectangle intersectScissors(Rectangle rect)

Intersect the given rectangle against current scissor area.

isHovered

bool isHovered()

layerForStroke

inout(InputLayer)* layerForStroke(InputStroke stroke)

Find a layer for the given input stroke.

poll

void poll()

Fetch tree events (e.g. actions)

popScissors

void popScissors(Rectangle lastScissorsMode)

Undocumented in source. Be warned that the author may not have intended to support it.

pushScissors

Rectangle pushScissors(Rectangle rect)

Start scissors mode.

queueAction

void queueAction(TreeAction action)

Queue an action to perform while iterating the tree.

resizePending

bool resizePending()

Returns true if this branch requested a resize or is pending a resize.

restoreDefaultInputBinds

void restoreDefaultInputBinds()

Restore defaults for given actions.

Variables

actions

DList!TreeAction actions;

Tree actions queued to execute during next draw.

activeActions

DList!InputBinding activeActions;

Actions that have just triggered.

backend

FluidBackend backend;

Access to core input and output facilities.

boundInputs

InputLayer[] boundInputs;

Input strokes bound to emit given action signals.

breadcrumbs

Breadcrumbs breadcrumbs;

Current breadcrumbs. These are assigned to any node that is resized or drawn at the time.

context

TreeContextData context;

Context for the new I/O system. https://git.samerion.com/Samerion/Fluid/issues/148

depth

uint depth;

Current node drawing depth.

downActions

DList!InputBinding downActions;

Actions that are currently held down.

focus

FluidFocusable focus;

Currently focused node.

focusBox

Rectangle focusBox;

Padding box of the currently focused node. Only available after the node has been drawn.

focusDirection

FocusDirection focusDirection;

Focus direction data.

hover

Node hover;

Node the mouse is hovering over if any.

isBranchDisabled

bool isBranchDisabled;

True if the current tree branch is marked as disabled (doesn't take input).

root

Node root;

Root node of the tree.

scissors

Rectangle scissors;

Current rectangle drawing is limited to.

scroll

FluidScrollable scroll;

Deepest hovered scrollable node.

wasKeyboardHandled

bool wasKeyboardHandled;

True if keyboard input was handled during the last frame; updated after tree rendering has completed.

• TreeAction

• FocusDirection
• LayoutTree