OverlayChain

This node implements the OverlayIO interface by using its own space to lay out its children.

As this node is based on NodeChain, it accepts a single regular node to draw inside. It will always be drawn first, before the overlay nodes. The usual, "regular" content can thus be placed as a regular child, and overlays can then be spawned and be drawn above.

The OverlayChain can be considered a more modern alternative to MapFrame, however it is not guaranteed to be compatible with the old backend. For future code, OverlayChain should generally be preferred, but it has some drawbacks:

* Overlay nodes drawn on OverlayChain must implement Overlayable. * OverlayChain is not a Frame, and cannot be used as one. * It is not stylable; background color, border or decorations cannot be used, and margins may not work. * Overlays are not considered in the chain's minSize. * Position is relative to the window, not to the node.

@safe

class OverlayChain : NodeChain , OverlayIO {

void beforeResize(Vector2 );

void afterResize(Vector2 space);

void afterDraw(Rectangle , Rectangle inner);

void addOverlay(Overlayable overlayable, OverlayType[] type);

void addChildOverlay(Overlayable parent, Overlayable overlayable, OverlayType[] type);

}

Constructors

this this(Node next): Undocumented in source.

Members

Functions

addChildOverlay void addChildOverlay(Overlayable parent, Overlayable overlayable, OverlayType[] type): Undocumented in source. Be warned that the author may not have intended to support it.
addOverlay void addOverlay(Overlayable overlayable, OverlayType[] type): Undocumented in source. Be warned that the author may not have intended to support it.
afterDraw void afterDraw(Rectangle , Rectangle inner): Undocumented in source. Be warned that the author may not have intended to support it.
afterResize void afterResize(Vector2 space): Undocumented in source. Be warned that the author may not have intended to support it.
beforeResize void beforeResize(Vector2 ): Undocumented in source. Be warned that the author may not have intended to support it.

Mixins

__anonymous mixin controlIO: Undocumented in source.

Structs

Child struct Child: Undocumented in source.

Variables

children Child[] children;: Overlay nodes of the chain.

Inherited Members

From NodeChain

next Node next(Node value): Set the next node in chain.
next inout(Node) next()
nextChain inout(NodeChain) nextChain()
beforeResize void beforeResize(Vector2 space): Undocumented in source. Be warned that the author may not have intended to support it.
afterResize void afterResize(Vector2 space): Undocumented in source. Be warned that the author may not have intended to support it.
beforeDraw void beforeDraw(Rectangle outer, Rectangle inner): Undocumented in source. Be warned that the author may not have intended to support it.
afterDraw void afterDraw(Rectangle outer, Rectangle inner): Undocumented in source. Be warned that the author may not have intended to support it.
resizeImpl void resizeImpl(Vector2 space): Undocumented in source. Be warned that the author may not have intended to support it.
drawImpl void drawImpl(Rectangle outer, Rectangle inner): Undocumented in source. Be warned that the author may not have intended to support it.

From OverlayIO

Types enum Types: Defines known types of overlays. To use a type from this list, use types, spelled lowercase.
types types(): Get an overlay type defined in OverlayIO.
addOverlay void addOverlay(Overlayable node, OverlayType[] type): Insert new overlay content.
addChildOverlay void addChildOverlay(Overlayable parent, Overlayable node, OverlayType[] type): Insert overlay content as a child of another.