ScriptingApi::Content Class Reference

Inherits ScriptingObject, DynamicObject, SafeChangeBroadcaster, and RestorableObject.

Public Member Functions
ScriptAudioWaveform *	addAudioWaveform (Identifier audioWaveformName, int x, int y)
ScriptButton *	addButton (Identifier buttonName, int x, int y)
ScriptComboBox *	addComboBox (Identifier boxName, int x, int y)
ScriptFloatingTile *	addFloatingTile (Identifier floatingTileName, int x, int y)
ScriptImage *	addImage (Identifier imageName, int x, int y)
ScriptSlider *	addKnob (Identifier knobName, int x, int y)
ScriptLabel *	addLabel (Identifier label, int x, int y)
ModulatorMeter *	addModulatorMeter (Identifier modulatorName, int x, int y)
ScriptPanel *	addPanel (Identifier panelName, int x, int y)
ScriptedPlotter *	addPlotter (Identifier plotterName, int x, int y)
ScriptedViewport *	addScriptedViewport (Identifier viewportName, int x, int y)
ScriptSliderPack *	addSliderPack (Identifier sliderPackName, int x, int y)
ScriptTable *	addTable (Identifier tableName, int x, int y)
var	createPath ()
var	getComponent (var name)
void	makeFrontInterface (int width, int height)
void	makeFullScreenInterface ()
void	restoreAllControlsFromPreset (const String &fileName)
void	setColour (int red, int green, int blue)
void	setContentTooltip (const String &tooltipToShow)
void	setHeight (int newHeight) noexcept
void	setName (const String &newName)
void	setPropertiesFromJSON (const Identifier &name, const var &jsonData)
void	setToolbarProperties (const var &toolbarProperties)
void	setUseHighResolutionForPanels (bool shouldUseDoubleResolution)
void	setWidth (int newWidth) noexcept
void	storeAllControlsAsPreset (const String &fileName, const ValueTree &automationData)

Detailed Description

This is the interface area that can be filled with buttons, knobs, etc.

Member Function Documentation

ScriptAudioWaveform* addAudioWaveform	(	Identifier	audioWaveformName,
		int	x,
		int	y
	)

Adds a audio waveform display.

ScriptButton* addButton	(	Identifier	buttonName,
		int	x,
		int	y
	)

Adds a toggle button to the Content and returns the component index.

Parameters

knobName	the name for the knob. It should contain no whitespace
x	the x position
y	the y position

ScriptComboBox* addComboBox	(	Identifier	boxName,
		int	x,
		int	y
	)

Adds a comboBox to the Content and returns the component index.

ScriptFloatingTile* addFloatingTile	(	Identifier	floatingTileName,
		int	x,
		int	y
	)

Adds a floating layout component.

ScriptImage* addImage	(	Identifier	imageName,
		int	x,
		int	y
	)

Adds a image to the script interface.

ScriptSlider* addKnob	(	Identifier	knobName,
		int	x,
		int	y
	)

Adds a knob to the Content and returns the component index.

Parameters

knobName	the name for the knob. It should contain no whitespace
x	the x position
y	the y position

ScriptLabel* addLabel	(	Identifier	label,
		int	x,
		int	y
	)

Adds a text input label.

ModulatorMeter* addModulatorMeter	(	Identifier	modulatorName,
		int	x,
		int	y
	)

Adds a peak meter that displays the modulator's output.

ScriptPanel* addPanel	(	Identifier	panelName,
		int	x,
		int	y
	)

Adds a panel (rectangle with border and gradient).

ScriptedPlotter* addPlotter	(	Identifier	plotterName,
		int	x,
		int	y
	)

Adds a plotter that plots multiple modulators.

ScriptedViewport* addScriptedViewport	(	Identifier	viewportName,
		int	x,
		int	y
	)

Adds a viewport.

ScriptSliderPack* addSliderPack	(	Identifier	sliderPackName,
		int	x,
		int	y
	)

Adds a slider pack.

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.

void setColour	(	int	red,
		int	green,
		int	blue
	)

Sets the colour for the panel.

void setContentTooltip

(

const String &

tooltipToShow

)

sets the Tooltip that will be shown if the mouse hovers over the script's tab button.

void setHeight ( int  newHeight )

noexcept

Sets the height of the content.

void setName

(

const String &

newName

)

Sets the name that will be displayed in big fat Impact.

void setPropertiesFromJSON	(	const Identifier &	name,
		const var &	jsonData
	)

Restore the widget 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 setWidth ( int  newWidth )

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.