FloatParameter

A float parameter This is an abstract class, mapping from normalized to parmeter values is left to the user.

Constructors

this
this(int index, string name, string label, double min, double max, double defaultValue)
Undocumented in source.

Members

Functions

defaultValue
double defaultValue()
Undocumented in source. Be warned that the author may not have intended to support it.
fromNormalized
double fromNormalized(double value)

Override it to specify mapping from normalized [0..1] to parameter value

getNormalized
double getNormalized()
Undocumented in source. Be warned that the author may not have intended to support it.
getNormalizedDefault
double getNormalizedDefault()
Undocumented in source. Be warned that the author may not have intended to support it.
isDiscrete
bool isDiscrete()
Undocumented in source. Be warned that the author may not have intended to support it.
maxValue
double maxValue()
Undocumented in source. Be warned that the author may not have intended to support it.
minValue
double minValue()
Undocumented in source. Be warned that the author may not have intended to support it.
normalizedValueFromString
bool normalizedValueFromString(const(char)[] valueString, double result)
Undocumented in source. Be warned that the author may not have intended to support it.
setDecimalPrecision
void setDecimalPrecision(int digits)

Sets the number of decimal digits after the dot to be displayed.

setFromGUI
void setFromGUI(double value)

Sets the value of the parameter from UI, using a normalized value. Note: If value is not inside [min .. max], then it is clamped. This is not an error.

setFromGUINormalized
void setFromGUINormalized(double normValue)

Sets the value of the parameter from UI, using a normalized value. Note: If normValue is not inside [0.0 .. 1.0], then it is clamped. This is not an error.

setNormalized
void setNormalized(double hostValue)
Undocumented in source. Be warned that the author may not have intended to support it.
stringFromNormalizedValue
void stringFromNormalizedValue(double normalizedValue, char* buffer, size_t len)
Undocumented in source. Be warned that the author may not have intended to support it.
toNormalized
double toNormalized(double value)

Override it to specify mapping from parameter values to normalized [0..1]

toStringN
void toStringN(char* buffer, size_t numBytes)
Undocumented in source. Be warned that the author may not have intended to support it.
value
double value()

Gets current value.

valueAtomic
double valueAtomic()

Same as value but doesn't use locking, and doesn't use ordering. Which make it a better fit for the audio thread.

withDecimalPrecision
FloatParameter withDecimalPrecision(int digits)

Helper for setDecimalPrecision that returns this, help when in parameter creation.

Inherited Members

From Parameter

addListener
void addListener(IParameterListener listener)

Adds a parameter listener.

removeListener
void removeListener(IParameterListener listener)

Removes a parameter listener.

name
string name()
label
string label()
index
int index()
isAutomatable
bool isAutomatable()
nonAutomatable
Parameter nonAutomatable()

Makes parameter non-automatable.

setFromHost
void setFromHost(double hostValue)

From a normalized double [0..1], set the parameter value. This is a Dplug internal call, not for plug-in code.

getForHost
double getForHost()
toDisplayN
void toDisplayN(char* buffer, size_t numBytes)

Output a string representation of a Parameter.

beginParamEdit
void beginParamEdit()

Warns the host that a parameter will be edited. Should only ever be called from the UI thread.

endParamEdit
void endParamEdit()

Warns the host that a parameter has finished being edited. Should only ever be called from the UI thread.

beginParamHover
void beginParamHover()

Warns the listeners that a parameter is being hovered in the UI. Should only ever be called from the UI thread.

endParamHover
void endParamHover()

Warns the listeners that a parameter has finished being hovered in the UI. Should only ever be called from the UI thread. This doesn't communicate anything to the host.

getNormalized
double getNormalized()
getNormalizedDefault
double getNormalizedDefault()
stringFromNormalizedValue
void stringFromNormalizedValue(double normalizedValue, char* buffer, size_t len)
normalizedValueFromString
bool normalizedValueFromString(const(char)[] valueString, double result)
isDiscrete
bool isDiscrete()
~this
~this()
Undocumented in source.
setNormalized
void setNormalized(double hostValue)

From a normalized double, set the parameter value. No guarantee at all that getNormalized will return the same, because this value is rounded to fit.

toStringN
void toStringN(char* buffer, size_t numBytes)

Display parameter (without label). This always adds a terminal zero within numBytes.

notifyListeners
void notifyListeners()
Undocumented in source. Be warned that the author may not have intended to support it.
checkBeingEdited
void checkBeingEdited()
Undocumented in source. Be warned that the author may not have intended to support it.
isEdited
bool isEdited()
Undocumented in source. Be warned that the author may not have intended to support it.
setClientReference
void setClientReference(Client client)

Parameters are owned by a client, this is used to make them refer back to it.

Meta