UIKnob

Undocumented in source.

}

Constructors

this this(UIContext context, Parameter param): Undocumented in source.

Destructor

~this ~this(): Undocumented in source.

Members

Functions

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.
drawKnob void drawKnob(ImageRef!RGBA diffuseMap, ImageRef!L16 depthMap, ImageRef!RGBA materialMap, box2i[] dirtyRects): Undocumented in source. Be warned that the author may not have intended to support it.
drawTrail void drawTrail(ImageRef!RGBA diffuseMap, ImageRef!L16 depthMap, ImageRef!RGBA materialMap, box2i[] dirtyRects): Undocumented in source. Be warned that the author may not have intended to support it.
getBaseAngle float getBaseAngle(): Max angle of the trail, fit for aaFillSector.
getCenter vec2f getCenter(): Undocumented in source. Be warned that the author may not have intended to support it.
getMaxAngle float getMaxAngle(): Min angle of the trail, fit for aaFillSector.
getMinAngle float getMinAngle(): Min angle of the trail, fit for aaFillSector.
getRadius float getRadius(): Undocumented in source. Be warned that the author may not have intended to support it.
getSubsquare box2i getSubsquare()
getValueAngle float getValueAngle(): Angle of the trail, fit for aaFillSector.
onAnimate void onAnimate(double dt, double time): Undocumented in source. Be warned that the author may not have intended to support it.
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.
onDrawPBR void onDrawPBR(ImageRef!RGBA diffuseMap, ImageRef!L16 depthMap, ImageRef!RGBA materialMap, 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.
roundParamValue double roundParamValue(double normalizedValue, MouseState mstate): Override this to round the parameter normalized value to some particular values. For example for a special drag movement with right-click or control-click. Default does nothing.

Manifest constants

defaultSensivity enum defaultSensivity;: Undocumented in source.

Static functions

angleConvert float angleConvert(float angle): Exists because public angle properties are given in a different referential, where 0 is at the top

Variables

LEDDepth ushort LEDDepth;: Undocumented in source.
LEDDiffuseLit RGBA LEDDiffuseLit;: Undocumented in source.
LEDDiffuseUnlit RGBA LEDDiffuseUnlit;: Undocumented in source.
LEDDistanceFromCenter float LEDDistanceFromCenter;: Undocumented in source.
LEDDistanceFromCenterDragged float LEDDistanceFromCenterDragged;: Undocumented in source.
LEDMaterial RGBA LEDMaterial;: Undocumented in source.
LEDRadiusMax float LEDRadiusMax;: Undocumented in source.
LEDRadiusMin float LEDRadiusMin;: Undocumented in source.
_displacementInHeightDebt double _displacementInHeightDebt;: Undocumented in source.
_mousePosOnLast0Cross float _mousePosOnLast0Cross;: Undocumented in source.
_mousePosOnLast1Cross float _mousePosOnLast1Cross;: Undocumented in source.
_normalizedValueWhileDragging float _normalizedValueWhileDragging;: Undocumented in source.
_param Parameter _param;: The parameter this knob is linked with.
_pushedAnimation float _pushedAnimation;: Undocumented in source.
_shouldBeHighlighted bool _shouldBeHighlighted;: Undocumented in source.
animationTimeConstant float animationTimeConstant;: Undocumented in source.
emissive ubyte emissive;: Undocumented in source.
emissiveDragged ubyte emissiveDragged;: Undocumented in source.
emissiveHovered ubyte emissiveHovered;: Undocumented in source.
hasAlternateTrail bool hasAlternateTrail;: Undocumented in source.
hasTrail bool hasTrail;: Undocumented in source.
knobDiffuse RGBA knobDiffuse;: Undocumented in source.
knobMaterial RGBA knobMaterial;: Undocumented in source.
knobRadius float knobRadius;: Undocumented in source.
litTrailDiffuse RGBA litTrailDiffuse;: Undocumented in source.
litTrailDiffuseAlt RGBA litTrailDiffuseAlt;: Undocumented in source.
numLEDs int numLEDs;: Undocumented in source.
sensivity float sensivity;: Sensivity: given a mouse movement in 100th of the height of the knob, how much should the normalized parameter change.
style KnobStyle style;: Undocumented in source.
trailBaseAngle float trailBaseAngle;: Undocumented in source.
trailMaxAngle float trailMaxAngle;: Undocumented in source.
trailMinAngle float trailMinAngle;: Undocumented in source.
trailOffsetX float trailOffsetX;: Undocumented in source.
trailOffsetY float trailOffsetY;: Undocumented in source.
trailRadiusMax float trailRadiusMax;: Undocumented in source.
trailRadiusMin float trailRadiusMin;: Undocumented in source.
unlitTrailDiffuse RGBA unlitTrailDiffuse;: Undocumented in source.

Inherited Members

From UIElement

~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): Set widget ID.
getId const(char)[] getId()
id const(char)[] id(): Get widget 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(): Widget hovered by mouse?
isDragged bool isDragged(): Widget dragged by mouse?
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.

From IParameterListener

onParameterChanged void onParameterChanged(Parameter sender): A parameter value was changed, from the UI or the host (automation).
onBeginParameterEdit void onBeginParameterEdit(Parameter sender): A parameter value _starts_ being changed due to an UI element.
onEndParameterEdit void onEndParameterEdit(Parameter sender): Called when a parameter value _stops_ being changed.
onBeginParameterHover void onBeginParameterHover(Parameter sender)
onEndParameterHover void onEndParameterHover(Parameter sender): Called when a widget that can changes this parameter is mouseover, and wants to signal that to the listeners.

UIKnob

Constructors

Destructor

Members

Functions

Manifest constants

Static functions

Variables

Inherited Members

From UIElement

From IParameterListener

Meta

Source