- cacheImage
void cacheImage(int frame)
Undocumented in source. Be warned that the author may not have intended to support it.
- clearCrosspoints
void clearCrosspoints()
Undocumented in source. Be warned that the author may not have intended to support it.
- containsPoint
bool containsPoint(int x, int y)
Undocumented in source. Be warned that the author may not have intended to support it.
- disable
void disable()
Undocumented in source. Be warned that the author may not have intended to support it.
- distance
float distance(float x1, float x2, float y1, float y2)
Undocumented in source. Be warned that the author may not have intended to support it.
- getCenter
vec2f getCenter()
Undocumented in source. Be warned that the author may not have intended to support it.
- getRadius
float getRadius()
Undocumented in source. Be warned that the author may not have intended to support it.
- getSubsquare
box2i getSubsquare()
- onBeginDrag
void onBeginDrag()
Undocumented in source. Be warned that the author may not have intended to support it.
- onBeginParameterEdit
void onBeginParameterEdit(Parameter sender)
Undocumented in source. Be warned that the author may not have intended to support it.
- onBeginParameterHover
void onBeginParameterHover(Parameter sender)
Undocumented in source. Be warned that the author may not have intended to support it.
- onDrawRaw
void onDrawRaw(ImageRef!RGBA rawMap, box2i[] dirtyRects)
Undocumented in source. Be warned that the author may not have intended to support it.
- onEndParameterEdit
void onEndParameterEdit(Parameter sender)
Undocumented in source. Be warned that the author may not have intended to support it.
- onEndParameterHover
void onEndParameterHover(Parameter sender)
Undocumented in source. Be warned that the author may not have intended to support it.
- onMouseClick
Click onMouseClick(int x, int y, int button, bool isDoubleClick, MouseState mstate)
Undocumented in source. Be warned that the author may not have intended to support it.
- onMouseDrag
void onMouseDrag(int x, int y, int dx, int dy, MouseState mstate)
Undocumented in source. Be warned that the author may not have intended to support it.
- onMouseEnter
void onMouseEnter()
Undocumented in source. Be warned that the author may not have intended to support it.
- onMouseExit
void onMouseExit()
Undocumented in source. Be warned that the author may not have intended to support it.
- onMouseMove
void onMouseMove(int x, int y, int dx, int dy, MouseState mstate)
Undocumented in source. Be warned that the author may not have intended to support it.
- onParameterChanged
void onParameterChanged(Parameter sender)
Undocumented in source. Be warned that the author may not have intended to support it.
- onStopDrag
void onStopDrag()
Undocumented in source. Be warned that the author may not have intended to support it.
- reflow
void reflow()
Undocumented in source. Be warned that the author may not have intended to support it.
- sensivity
float sensivity()
- sensivity
float sensivity(float sensitivity)
- setCurrentImage
void setCurrentImage()
Undocumented in source. Be warned that the author may not have intended to support it.
- ~this
~this()
Destroy a UIElement.
Normally this happens naturally, since each widget
owns its children.
- position
box2i position()
Get widget position in the window (absolute).
- position
void position(box2i p)
void position(box2f p)
Set widget position in the window (absolute).
- context
UIContext context()
Get the UI context, which is an additional API for
widgets to use (though quite a bit of methods are
internals there).
- parent
UIElement parent()
Get parent widget, if any.
- topLevelParent
UIElement topLevelParent()
Get top-level parent, if any.
- child
UIElement child(int n)
- addChild
void addChild(UIElement element)
Add a UIElement as child to another.
- removeChild
void removeChild(UIElement element)
Removes a child from its parent.
Useful for creating dynamic UI's.
- setDirtyWhole
void setDirtyWhole(UILayer layer)
Mark this element as "dirty" on its whole position.
- setDirty
void setDirty(box2i rect, UILayer layer)
Mark a sub-part of the element "dirty".
- isVisible
bool isVisible()
A widget is "visible" when it has a true visibility
flag, and its parent is itself visible.
- visibility
bool visibility()
Get visibility flag of the widget.
- visibility
void visibility(bool visible)
Change visibility flag of the widget. Show or hide
all children of this UIElement, regardless of
their position on screen, invalidating their
graphics if need be (much like a position change).
- zOrder
int zOrder()
void zOrder(int zOrder)
Set/get widget Z-order (default = 0).
- setZOrder
alias setZOrder = zOrder
Undocumented in source.
- setId
void setId(const(char)[] identifier)
- id
void id(const(char)[] identifier)
- getId
const(char)[] getId()
- id
const(char)[] id()
- hasId
bool hasId()
Has this widget an identifier?
- getElementById
UIElement getElementById(const(char)* id)
Search subtree for an UIElement with ID id.
Undefined Behaviour if ID are not unique.
- reflow
void reflow()
The .reflow() callback is called whenver the
.position of a widget changes.
- isMouseOver
bool isMouseOver()
- isDragged
bool isDragged()
- isFocused
bool isFocused()
Widget has keyboard focused? (last clicked)
- drawsToPBR
bool drawsToPBR()
Widget draws on the PBR layer?
- drawsToRaw
bool drawsToRaw()
Widget draws on the Raw layer?
- isAnimated
bool isAnimated()
Is widget animated? (onAnimate called)
- isDrawAloneRaw
bool isDrawAloneRaw()
Should widget be drawn alone in Raw layer?
- isDrawAlonePBR
bool isDrawAlonePBR()
Should widget be drawn alone in PBR layer?
- cursorWhenDragged
MouseCursor cursorWhenDragged()
- setCursorWhenDragged
void setCursorWhenDragged(MouseCursor mouseCursor)
- cursorWhenMouseOver
MouseCursor cursorWhenMouseOver()
- setCursorWhenMouseOver
void setCursorWhenMouseOver(MouseCursor mouseCursor)
- getUserPointer
void* getUserPointer(int pointerID)
- setUserPointer
void setUserPointer(int pointerID, void* user)
Set/Get a user pointer.
This allow dplug:gui extensions.
- contains
bool contains(int x, int y)
Check if given point is considered in the widget,
for clicks, mouse moves, etc.
This function is meant to be overridden.
- onMouseEnter
void onMouseEnter()
- onMouseExit
void onMouseExit()
Called when mouse enter or exits a widget.
This function is meant to be overridden.
- onMouseClick
Click onMouseClick(int x, int y, int button, bool isDoubleClick, MouseState mstate)
.onMouseClick() is called for every new click.
- onMouseWheel
bool onMouseWheel(int x, int y, int wheelDeltaX, int wheelDeltaY, MouseState mstate)
Mouse wheel was turned.
This function is meant to be overridden.
- onMouseMove
void onMouseMove(int x, int y, int dx, int dy, MouseState mstate)
Called when the mouse moves over this widget area.
This function is meant to be overridden.
- onBeginDrag
void onBeginDrag()
- onStopDrag
void onStopDrag()
Called when a drag operation starts or ends.
This function is meant to be overridden.
- onMouseDrag
void onMouseDrag(int x, int y, int dx, int dy, MouseState mstate)
Called when the mouse moves while dragging this
widget.
- onFocusEnter
void onFocusEnter()
Called when this widget is clicked and get the
"focus" (ie. meaning the keyboard focus).
This function is meant to be overridden.
- onFocusExit
void onFocusExit()
This widget lost the keyboard focus.
This function is meant to be overridden.
- onKeyDown
bool onKeyDown(Key key)
- onKeyUp
bool onKeyUp(Key key)
Called when a key is pressed/released.
Functiosn meant to be overridden.
- onDrawRaw
void onDrawRaw(ImageRef!RGBA rawMap, box2i[] dirtyRects)
Raw layer draw method.
This function is meant to be overridden.
- onDrawPBR
void onDrawPBR(ImageRef!RGBA diffuse, ImageRef!L16 depth, ImageRef!RGBA material, box2i[] dirtyRects)
PBR layer draw method.
This function is meant to be overridden.
- onAnimate
void onAnimate(double dt, double time)
Called periodically for every UIElement that has
flagAnimated.
Override this to create animations.
- renderRaw
void renderRaw(ImageRef!RGBA rawMap, box2i[] areasToUpdate)
Undocumented in source. Be warned that the author may not have intended to support it.
- renderPBR
void renderPBR(ImageRef!RGBA diffuse, ImageRef!L16 depth, ImageRef!RGBA material, box2i[] areasToUpdate)
Undocumented in source. Be warned that the author may not have intended to support it.
- mouseClick
bool mouseClick(int x, int y, int button, bool isDoubleClick, MouseState mstate)
Undocumented in source. Be warned that the author may not have intended to support it.
- mouseRelease
void mouseRelease(int x, int y, int button, MouseState mstate)
Undocumented in source. Be warned that the author may not have intended to support it.
- mouseWheel
bool mouseWheel(int x, int y, int wheelDeltaX, int wheelDeltaY, MouseState mstate)
Undocumented in source. Be warned that the author may not have intended to support it.
- mouseMove
bool mouseMove(int x, int y, int dx, int dy, MouseState mstate, bool alreadyFoundMouseOver)
Undocumented in source. Be warned that the author may not have intended to support it.
- keyDown
bool keyDown(Key key)
Undocumented in source. Be warned that the author may not have intended to support it.
- keyUp
bool keyUp(Key key)
Undocumented in source. Be warned that the author may not have intended to support it.
- animate
void animate(double dt, double time)
Undocumented in source. Be warned that the author may not have intended to support it.
- getDrawLists
void getDrawLists(Vec!UIElement listRaw, Vec!UIElement listPBR)
Undocumented in source. Be warned that the author may not have intended to support it.
- _parent
UIElement _parent;
Undocumented in source.
- _position
box2i _position;
Undocumented in source.
- _children
Vec!UIElement _children;
Undocumented in source.
- _flags
immutable(uint) _flags;
Undocumented in source.
- _zOrder
int _zOrder;
Undocumented in source.
UIFilmstripKnob is a knob with a vertical RGBA image describing the knob graphics.