This is the interface area that can be filled with buttons, knobs, etc. More...
Public Member Functions | |
ScriptAudioWaveform * | addAudioWaveform (Identifier audioWaveformName, int x, int y) |
Adds a audio waveform display. More... | |
ScriptButton * | addButton (Identifier buttonName, int x, int y) |
Adds a toggle button to the Content and returns the component index. More... | |
ScriptComboBox * | addComboBox (Identifier boxName, int x, int y) |
Adds a comboBox to the Content and returns the component index. More... | |
ScriptFloatingTile * | addFloatingTile (Identifier floatingTileName, int x, int y) |
Adds a floating layout component. More... | |
ScriptImage * | addImage (Identifier imageName, int x, int y) |
Adds a image to the script interface. More... | |
ScriptSlider * | addKnob (Identifier knobName, int x, int y) |
Adds a knob to the Content and returns the component index. More... | |
ScriptLabel * | addLabel (Identifier label, int x, int y) |
Adds a text input label. More... | |
ScriptPanel * | addPanel (Identifier panelName, int x, int y) |
Adds a panel (rectangle with border and gradient). More... | |
ScriptedViewport * | addScriptedViewport (Identifier viewportName, int x, int y) |
Adds a viewport. More... | |
ScriptSliderPack * | addSliderPack (Identifier sliderPackName, int x, int y) |
Adds a slider pack. More... | |
ScriptTable * | addTable (Identifier tableName, int x, int y) |
Adds a table editor to the Content and returns the component index. More... | |
var | createPath () |
Creates a Path that can be drawn to a ScriptPanel. More... | |
var | getComponent (var name) |
Returns the reference to the given component. More... | |
void | makeFrontInterface (int width, int height) |
Sets this script as main interface with the given size. More... | |
void | makeFullScreenInterface () |
Sets this script as main interface with the given device resolution (only works with mobile devices). More... | |
void | restoreAllControlsFromPreset (const String &fileName) |
Restores all controls from a previously saved XML data file. More... | |
void | setColour (int red, int green, int blue) |
Sets the colour for the panel. More... | |
void | setContentTooltip (const String &tooltipToShow) |
sets the Tooltip that will be shown if the mouse hovers over the script's tab button. More... | |
void | setHeight (int newHeight) noexcept |
Sets the height of the content. More... | |
void | setName (const String &newName) |
Sets the name that will be displayed in big fat Impact. More... | |
void | setPropertiesFromJSON (const Identifier &name, const var &jsonData) |
Restore the Component from a JSON object. More... | |
void | setToolbarProperties (const var &toolbarProperties) |
Sets the main toolbar properties from a JSON object. More... | |
void | setUseHighResolutionForPanels (bool shouldUseDoubleResolution) |
Set this to true to render all script panels with double resolution for retina or rescaling. More... | |
void | setValuePopupData (var jsonData) |
sets the data for the value popups. More... | |
void | setWidth (int newWidth) noexcept |
Sets the height of the content. More... | |
void | storeAllControlsAsPreset (const String &fileName, const ValueTree &automationData) |
Saves all controls that should be saved into a XML data file. More... | |
This is the interface area that can be filled with buttons, knobs, etc.
ScriptingApi::Content::ScriptAudioWaveform * addAudioWaveform | ( | Identifier | audioWaveformName, |
int | x, | ||
int | y | ||
) |
Adds a audio waveform display.
ScriptingApi::Content::ScriptButton * addButton | ( | Identifier | buttonName, |
int | x, | ||
int | y | ||
) |
Adds a toggle button to the Content and returns the component index.
knobName | the name for the knob. It should contain no whitespace |
x | the x position |
y | the y position |
ScriptingApi::Content::ScriptComboBox * addComboBox | ( | Identifier | boxName, |
int | x, | ||
int | y | ||
) |
Adds a comboBox to the Content and returns the component index.
ScriptingApi::Content::ScriptFloatingTile * addFloatingTile | ( | Identifier | floatingTileName, |
int | x, | ||
int | y | ||
) |
Adds a floating layout component.
ScriptingApi::Content::ScriptImage * addImage | ( | Identifier | imageName, |
int | x, | ||
int | y | ||
) |
Adds a image to the script interface.
ScriptingApi::Content::ScriptSlider * addKnob | ( | Identifier | knobName, |
int | x, | ||
int | y | ||
) |
Adds a knob to the Content and returns the component index.
knobName | the name for the knob. It should contain no whitespace |
x | the x position |
y | the y position |
ScriptingApi::Content::ScriptLabel * addLabel | ( | Identifier | label, |
int | x, | ||
int | y | ||
) |
Adds a text input label.
ScriptingApi::Content::ScriptPanel * addPanel | ( | Identifier | panelName, |
int | x, | ||
int | y | ||
) |
Adds a panel (rectangle with border and gradient).
ScriptingApi::Content::ScriptedViewport * addScriptedViewport | ( | Identifier | viewportName, |
int | x, | ||
int | y | ||
) |
Adds a viewport.
ScriptingApi::Content::ScriptSliderPack * addSliderPack | ( | Identifier | sliderPackName, |
int | x, | ||
int | y | ||
) |
Adds a slider pack.
ScriptingApi::Content::ScriptTable * addTable | ( | Identifier | tableName, |
int | x, | ||
int | y | ||
) |
Adds a table editor to the Content and returns the component index.
var createPath | ( | ) |
Creates a Path that can be drawn to a ScriptPanel.
var getComponent | ( | var | name | ) |
Returns the reference to the given component.
void makeFrontInterface | ( | int | width, |
int | height | ||
) |
Sets this script as main interface with the given size.
void makeFullScreenInterface | ( | ) |
Sets this script as main interface with the given device resolution (only works with mobile devices).
void restoreAllControlsFromPreset | ( | const String & | fileName | ) |
Restores all controls from a previously saved XML data file.
|
inline |
Sets the colour for the panel.
|
inline |
sets the Tooltip that will be shown if the mouse hovers over the script's tab button.
|
noexcept |
Sets the height of the content.
|
inline |
Sets the name that will be displayed in big fat Impact.
void setPropertiesFromJSON | ( | const Identifier & | name, |
const var & | jsonData | ||
) |
Restore the Component from a JSON object.
void setToolbarProperties | ( | const var & | toolbarProperties | ) |
Sets the main toolbar properties from a JSON object.
void setUseHighResolutionForPanels | ( | bool | shouldUseDoubleResolution | ) |
Set this to true to render all script panels with double resolution for retina or rescaling.
void setValuePopupData | ( | var | jsonData | ) |
sets the data for the value popups.
|
noexcept |
Sets the height of the content.
void storeAllControlsAsPreset | ( | const String & | fileName, |
const ValueTree & | automationData | ||
) |
Saves all controls that should be saved into a XML data file.