UIFilmstripKnob

class UIFilmstripKnob : UIElement , IParameterListener {
enum defaultSensivity;
OwnedImage!RGBA _filmstrip;
OwnedImage!RGBA _faderFilmstrip;
OwnedImage!RGBA _knobGreenFilmstrip;
ImageRef!RGBA _currentImage;
int _numFrames;
int _imageX1;
int _imageX2;
int _imageY1;
int _imageY2;
int currentFrame;
int _knobWidth;
int _knobHeight;
float _pushedAnimation;
float _mousePosOnLast0Cross;
float _mousePosOnLast1Cross;
bool _disabled;
}

Destructor

A destructor is present on this object, but not explicitly documented in the source.

Members

Functions

getSubsquare
box2i getSubsquare()
sensivity
float sensivity()
sensivity
float sensivity(float sensitivity)

Sets sensivity.

Variables

_param
FloatParameter _param;

The parameter this knob is linked with.

_sensitivity
float _sensitivity;

Sensivity: given a mouse movement in 100th of the height of the knob, how much should the normalized parameter change.

Inherited Members

From UIElement

renderRaw
void renderRaw(ImageRef!RGBA rawMap, in box2i[] areasToUpdate)

This method is called for each item in the drawlist that was visible and has a dirty Raw layer. This is called after compositing, starting from the buffer output by the Compositor.

renderPBR
void renderPBR(ImageRef!RGBA diffuseMap, ImageRef!L16 depthMap, ImageRef!RGBA materialMap, in box2i[] areasToUpdate)
reflow
void reflow(box2i availableSpace)

TODO: useless until we have resizeable UIs. Meant to be overriden almost everytime for custom behaviour. Default behaviour is to span the whole area and reflow children. Any layout algorithm is up to you. Like in the DOM, children elements don't need to be inside _position of their parent.

position
box2i position()
position
box2i position(box2i p)

Forces the position of the element. It is typically used in the parent reflow() method IMPORTANT: As of today you are not allowed to assign a position outside the extent of

removeChild
void removeChild(UIElement element)

Removes a child (but does not destroy it, you take back the ownership of it). Useful for creating dynamic UI's. MAYDO: there are restrictions for where this is allowed. Find them.

setDirtyWhole
void setDirtyWhole(UILayer layer = UILayer.guessFromFlags)

Mark this element as wholly dirty.

setDirty
void setDirty(box2i rect, UILayer layer = UILayer.guessFromFlags)

Mark a part of the element dirty. This part must be a subrect of its _position.

parent
UIElement parent()
topLevelParent
UIElement topLevelParent()
getDrawLists
void getDrawLists(ref Vec!UIElement listRaw, ref Vec!UIElement listPBR)

Appends the Elements that should be drawn, in order. You should empty it before calling this function. Everything visible get into the draw list, but that doesn't mean they will get drawn if they don't overlap with a dirty area.

onDrawRaw
void onDrawRaw(ImageRef!RGBA rawMap, box2i[] dirtyRects)

Raw layer draw method. This gives you 1 surface cropped by _position for drawing. Note that you are not forced to draw all to the surfacs at all.

onDrawPBR
void onDrawPBR(ImageRef!RGBA diffuseMap, ImageRef!L16 depthMap, ImageRef!RGBA materialMap, box2i[] dirtyRects)

PBR layer draw method. This gives you 3 surfaces cropped by _position for drawing. Note that you are not forced to draw all to the surfaces at all, in which case the below UIElement will be displayed.

onAnimate
void onAnimate(double dt, double time)

Called periodically for every UIElement. Override this to create animations. Using setDirty there allows to redraw an element continuously (like a meter or an animated object). Warning: Summing dt will not lead to a time that increase like time. time can go backwards if the window was reopen. time is guaranteed to increase as fast as system time but is not synced to audio time.

_parent
UIElement _parent;

Parent element. Following this chain gets to the root element.

_position
box2i _position;

Position is the graphical extent of the element, or something larger. An UIElement is not allowed though to draw further than its _position. For efficiency it's best to keep _position as small as feasible.

_children
Vec!UIElement _children;

The list of children UI elements.

_visible
bool _visible;

If _visible is false, neither the Element nor its children are drawn.

_flags
immutable(uint) _flags;

Flags, for now immutable

_zOrder
int _zOrder;

Higher z-order = above other UIElement. By default, every UIElement have the same z-order. Because the sort is stable, tree traversal order is the default order (depth first).

From IParameterListener

onParameterChanged
void onParameterChanged(Parameter sender)

Called when a parameter value was changed, from an UI control or through the host. You'll probably want to call setDirtyWhole() or setDirty() in it to make the graphics respond to host changing a parameter.

onBeginParameterEdit
void onBeginParameterEdit(Parameter sender)

Called when a parameter value _starts_ being changed due to an UI element.

onEndParameterEdit
void onEndParameterEdit(Parameter sender)

Called when a parameter value _stops_ being changed.

Meta