Class Siblings

Represents a DirectionNode's entry within its paint group.

Every DirectionNode has its own Siblings instance.

Siblings are often used to iterate all nodes in the graph, using forEach. Siblings are also used to store the preferred axis of a node, as this affects the layout and iteration order of the node's children.

See

PreferredAxis

Hierarchy

  • Siblings

Constructors

Properties

_layoutPreference: PreferredAxis
_next: DirectionNode<any>
_node: DirectionNode<any>
_prev: DirectionNode<any>

Methods

  • Iterates over every node in this node's paint group, beginning with this node and continuing until all nodes are iterated.

    Parameters

    • func: ((node: DirectionNode<any>) => void)

      the iterator that will be called for each node in this node's paint group. The iterator's signature is (node: DirectionNode) => void

    Returns void

  • Low-level method to convert this node's layout order from horizontal to vertical.

    See

    • setLayoutPreference
    • vertToHorz

    Returns void

  • Low-level method to convert this node's layout order from vertical to horizontal.

    See

    • setLayoutPreference
    • horzToVert

    Returns void

Generated using TypeDoc