Widget

Base class of all widgets.

Widget is the base class of all widgets in nanogui. It can also be used as an panel to arrange an arbitrary number of child widgets using a layout generator (see nanogui.layout.Layout).

class Widget {

this(Widget parent);

Widget parent();

void parent(Widget parent);

Layout layout();

void layout(Layout layout);

const(Theme) theme();

void theme(Theme theme);

Vector2i position();

void position(Vector2i pos);

Vector2i absolutePosition();

Vector2i size();

void size(Vector2i size);

void width(int width);

int height();

void height(int height);

void fixedSize(Vector2i fixedSize);

Vector2i fixedSize();

int fixedWidth();

int fixedHeight();

void fixedWidth(int width);

void fixedHeight(int height);

bool visible();

void visible(bool visible);

bool visibleRecursive();

int childCount();

auto children();

auto children();

void addChild(int index, Widget widget);

void addChild(Widget widget);

void removeChild(int index);

void removeChild(Widget widget);

auto childAt(int index);

auto childAt(int index);

int childIndex(Widget widget);

auto add(Args args);

Window window();

Screen screen();

void setId(string id);

bool enabled();

void enabled(bool enabled);

bool focused();

void focused(bool focused);

void requestFocus();

string tooltip();

void tooltip(string tooltip);

int fontSize();

void fontSize(int fontSize);

bool hasFontSize();

float iconExtraScale();

void iconExtraScale(float scale);

Cursor cursor();

void cursor(Cursor value);

bool contains(Vector2i p);

Widget findWidget(Vector2i p);

bool mouseButtonEvent(Vector2i p, MouseButton button, bool down, int modifiers);

bool mouseMotionEvent(Vector2i p, Vector2i rel, MouseButton button, int modifiers);

bool mouseDragEvent(Vector2i p, Vector2i rel, MouseButton button, int modifiers);

bool mouseEnterEvent(Vector2i p, bool enter);

bool scrollEvent(Vector2i p, Vector2f rel);

bool focusEvent(bool focused);

bool keyboardEvent(int key, int scancode, KeyAction action, int modifiers);

bool keyboardCharacterEvent(dchar codepoint);

Vector2i preferredSize(NanoContext ctx);

Vector2i preferredSize(NanoContext ctx, Widget skipped);

void performLayout(NanoContext ctx);

void draw(NanoContext ctx);

float icon_scale();

Widget mParent;

Theme mTheme;

Layout mLayout;

Vector2i mPos;

Vector2i mSize;

Vector2i mFixedSize;

Array!Widget mChildren;

bool mVisible;

bool mEnabled;

bool mFocused;

bool mMouseFocus;

string mTooltip;

int mFontSize;

float mIconExtraScale;

Cursor mCursor;

}

Constructors

this this(Widget parent): Construct a new widget with the given parent widget

Destructor

~this ~this(): Free all resources used by the widget and any children

Members

Functions

absolutePosition Vector2i absolutePosition(): Return the absolute position on screen
add auto add(Args args): Variadic shorthand notation to construct and add a child widget
addChild void addChild(int index, Widget widget): Add a child widget to the current widget at the specified index.
addChild void addChild(Widget widget): Convenience function which appends a widget at the end
childAt auto childAt(int index): Retrieves the child at the specific position
childAt auto childAt(int index): Retrieves the child at the specific position
childCount int childCount(): Return the number of child widgets
childIndex int childIndex(Widget widget): Returns the index of a specific child or -1 if not found
children auto children(): Return the list of child widgets of the current widget
contains bool contains(Vector2i p): Check if the widget contains a certain position
cursor Cursor cursor(): Return a pointer to the cursor of the widget
cursor void cursor(Cursor value): Set the cursor of the widget
draw void draw(NanoContext ctx): Draw the widget (and all child widgets)
enabled bool enabled(): Return whether or not this widget is currently enabled
enabled void enabled(bool enabled): Set whether or not this widget is currently enabled
findWidget Widget findWidget(Vector2i p): Determine the widget located at the given position value (recursive)
fixedHeight int fixedHeight(): Return the fixed height (see fixedSize)
fixedHeight void fixedHeight(int height): Set the fixed height (see fixedSize)
fixedSize void fixedSize(Vector2i fixedSize): Set the fixed size of this widget
fixedSize Vector2i fixedSize(): Return the fixed size
fixedWidth int fixedWidth(): Return the fixed width (see fixedSize)
fixedWidth void fixedWidth(int width): Set the fixed width (see fixedSize)
focusEvent bool focusEvent(bool focused): Handle a focus change event (default implementation: record the focus status, but do nothing)
focused bool focused(): Return whether or not this widget is currently focused
focused void focused(bool focused): Set whether or not this widget is currently focused
fontSize int fontSize(): Return current font size. If not set the default of the current theme will be returned
fontSize void fontSize(int fontSize): Set the font size of this widget
hasFontSize bool hasFontSize(): Return whether the font size is explicitly specified for this widget
height int height(): Return the height of the widget
height void height(int height): Set the height of the widget
iconExtraScale float iconExtraScale(): The amount of extra scaling applied to *icon* fonts. See nanogui.Widget.mIconExtraScale.
iconExtraScale void iconExtraScale(float scale): Sets the amount of extra scaling applied to *icon* fonts. See nanogui.Widget.mIconExtraScale.
icon_scale float icon_scale(): Convenience definition for subclasses to get the full icon scale for this class of Widget. It simple returns the value mTheme.mIconScale * this.mIconExtraScale.
id auto id(): Return the ID value associated with this widget, if any
keyboardCharacterEvent bool keyboardCharacterEvent(dchar codepoint): Handle text input (UTF-32 format) (default implementation: do nothing)
keyboardEvent bool keyboardEvent(int key, int scancode, KeyAction action, int modifiers): Handle a keyboard event (default implementation: do nothing)
layout Layout layout(): Return the used nanogui.layout.Layout generator
layout auto layout(): Return the used nanogui.layout.Layout generator
layout void layout(Layout layout): Set the used nanogui.layout.Layout generator
mouseButtonEvent bool mouseButtonEvent(Vector2i p, MouseButton button, bool down, int modifiers): Handle a mouse button event (default implementation: propagate to children)
mouseDragEvent bool mouseDragEvent(Vector2i p, Vector2i rel, MouseButton button, int modifiers): Handle a mouse drag event (default implementation: do nothing)
mouseEnterEvent bool mouseEnterEvent(Vector2i p, bool enter): Handle a mouse enter/leave event (default implementation: record this fact, but do nothing)
mouseMotionEvent bool mouseMotionEvent(Vector2i p, Vector2i rel, MouseButton button, int modifiers): Handle a mouse motion event (default implementation: propagate to children)
parent Widget parent(): Return the parent widget
parent auto parent(): Return the parent widget
parent void parent(Widget parent): Set the parent widget
performLayout void performLayout(NanoContext ctx): Invoke the associated layout generator to properly place child widgets, if any
position Vector2i position(): Return the position relative to the parent widget
position void position(Vector2i pos): Set the position relative to the parent widget
preferredSize Vector2i preferredSize(NanoContext ctx): Compute the preferred size of the widget
preferredSize Vector2i preferredSize(NanoContext ctx, Widget skipped): Compute the preferred size of the widget considering its child except skipped one (for example button panel of window)
removeChild void removeChild(int index): Remove a child widget by index
removeChild void removeChild(Widget widget): Remove a child widget by value
requestFocus void requestFocus(): Request the focus to be moved to this widget
screen Screen screen(): Walk up the hierarchy and return the parent screen
scrollEvent bool scrollEvent(Vector2i p, Vector2f rel): Handle a mouse scroll event (default implementation: propagate to children)
setId void setId(string id): Associate this widget with an ID value (optional)
size Vector2i size(): Return the size of the widget
size void size(Vector2i size): set the size of the widget
theme const(Theme) theme(): Return the nanogui.theme.Theme used to draw this widget
theme void theme(Theme theme): Set the nanogui.theme.Theme used to draw this widget
tooltip string tooltip(): Undocumented in source. Be warned that the author may not have intended to support it.
tooltip void tooltip(string tooltip): Undocumented in source. Be warned that the author may not have intended to support it.
visible bool visible(): Return whether or not the widget is currently visible (assuming all parents are visible)
visible void visible(bool visible): Set whether or not the widget is currently visible (assuming all parents are visible)
visibleRecursive bool visibleRecursive(): Check if this widget is currently visible, taking parent widgets into account
width int width(): Return the width of the widget
width void width(int width): Set the width of the widget
window Window window(): Walk up the hierarchy and return the parent window

Variables

mChildren Array!Widget mChildren;: Undocumented in source.
mCursor Cursor mCursor;: Undocumented in source.
mEnabled bool mEnabled;: Whether or not this Widget is currently enabled. Various different kinds of derived types use this to determine whether or not user input will be accepted. For example, when `mEnabled == false`, the state of a CheckBox cannot be changed, or a TextBox will not allow new input.
mFixedSize Vector2i mFixedSize;: Undocumented in source.
mFocused bool mFocused;: Undocumented in source.
mFontSize int mFontSize;: Undocumented in source.
mIconExtraScale float mIconExtraScale;: The amount of extra icon scaling used in addition the the theme's default icon font scale. Default value is `1.0`, which implies that icon_scale simply returns the value of nanogui.Theme.mIconScale.
mId string mId;: Undocumented in source.
mLayout Layout mLayout;
mMouseFocus bool mMouseFocus;: Undocumented in source.
mParent Widget mParent;: Undocumented in source.
mPos Vector2i mPos;
mSize Vector2i mSize;: Undocumented in source.
mTheme Theme mTheme;: Undocumented in source.
mTooltip string mTooltip;: Undocumented in source.
mVisible bool mVisible;: Whether or not this Widget is currently visible. When a Widget is not currently visible, no time is wasted executing its drawing method.

Meta

Source

See Implementation

nanogui widget classes

Widget