ScriptImage

Create a reference to a Image UI component and modify its values.

const var Image1 = Content.getComponent("Image1");

Class methods

addToMacroControl

Adds the knob / button to a macro controller (from 0 to 7). Edit on GitHub

ScriptImage.addToMacroControl(int macroIndex)

changed

Call this to indicate that the value has changed (the onControl callback will be executed. Edit on GitHub

ScriptImage.changed()

createLocalLookAndFeel

Returns a local look and feel if it was registered before. Edit on GitHub

ScriptImage.createLocalLookAndFeel(ScriptContentComponent *contentComponent, Component *componentToRegister)

fadeComponent

Toggles the visibility and fades a component using the global animator. Edit on GitHub

ScriptImage.fadeComponent(bool shouldBeVisible, int milliseconds)

get

returns the value of the property. Edit on GitHub

ScriptImage.get(String propertyName)

getAllProperties

Returns a list of all property IDs as array. Edit on GitHub

ScriptImage.getAllProperties()

getChildComponents

Returns list of component's children Edit on GitHub

ScriptImage.getChildComponents()

getGlobalPositionX

Returns the absolute x-position relative to the interface. Edit on GitHub

ScriptImage.getGlobalPositionX()

getGlobalPositionY

Returns the absolute y-position relative to the interface. Edit on GitHub

ScriptImage.getGlobalPositionY()

getHeight

Returns the height of the component. Edit on GitHub

ScriptImage.getHeight()

getId

Returns the ID of the component. Edit on GitHub

ScriptImage.getId()

getLocalBounds

Returns a [x, y, w, h] array that was reduced by the given amount. Edit on GitHub

ScriptImage.getLocalBounds(float reduceAmount)

getValue

Returns the current value. Edit on GitHub

ScriptImage.getValue()

getValueNormalized

Returns the normalized value. Edit on GitHub

ScriptImage.getValueNormalized()

getWidth

Returns the width of the component. Edit on GitHub

ScriptImage.getWidth()

grabFocus

Call this method in order to grab the keyboard focus for this component. Edit on GitHub

ScriptImage.grabFocus()

loseFocus

Call this method in order to give away the focus for this component. Edit on GitHub

ScriptImage.loseFocus()

sendRepaintMessage

Manually sends a repaint message for the component. Edit on GitHub

ScriptImage.sendRepaintMessage()

set

Sets the property. Edit on GitHub

ScriptImage.set(String propertyName, var value)

setAlpha

Sets the transparency (0.0 = full transparency, 1.0 = full opacity). Edit on GitHub

ScriptImage.setAlpha(float newAlphaValue)

setColour

sets the colour of the component (BG, IT1, IT2, TXT). Edit on GitHub

ScriptImage.setColour(int colourId, int colourAs32bitHex)

setConsumedKeyPresses

Registers a selection of key presses to be consumed by this component. Edit on GitHub

ScriptImage.setConsumedKeyPresses(var listOfKeys)

setControlCallback

Pass a inline function for a custom callback event. Edit on GitHub

ScriptImage.setControlCallback(var controlFunction)

setImageFile

Sets the image file that will be displayed. Edit on GitHub

ScriptImage.setImageFile( String absoluteFileName, bool forceUseRealFile)

setKeyPressCallback

Adds a callback to react on key presses (when this component is focused). Edit on GitHub

ScriptImage.setKeyPressCallback(var keyboardFunction)

setLocalLookAndFeel

Attaches the local look and feel to this component. Edit on GitHub

ScriptImage.setLocalLookAndFeel(var lafObject)

setPosition

Sets the position of the component. Edit on GitHub

ScriptImage.setPosition(int x, int y, int w, int h)

setPropertiesFromJSON

Restores all properties from a JSON object. Edit on GitHub

ScriptImage.setPropertiesFromJSON( var jsonData)

setStyleSheetClass

Sets the given class selectors for the component stylesheet. Edit on GitHub

ScriptImage.setStyleSheetClass( String classIds)

setStyleSheetProperty

Sets a variable for this component that can be queried from a style sheet. Edit on GitHub

ScriptImage.setStyleSheetProperty( String variableId,  var value,  String type)

setStyleSheetPseudoState

Programatically sets a pseudo state (:hover, :active, :checked, :focus, :disabled) that will be used by the CSS renderer. Edit on GitHub

ScriptImage.setStyleSheetPseudoState( String pseudoState)

setTooltip

Shows a informative text on mouse hover. Edit on GitHub

ScriptImage.setTooltip( String tooltip)

setValue

Sets the current value Edit on GitHub

ScriptImage.setValue(var newValue)

setValueNormalized

Sets the current value from a range 0.0 ... 1.0. Edit on GitHub

ScriptImage.setValueNormalized(double normalizedValue)

setValueWithUndo

Sets the current value and adds it to the undo list. Don't call this from onControl! Edit on GitHub

ScriptImage.setValueWithUndo(var newValue)

setZLevel

Changes the depth hierarchy (z-axis) of sibling components (Back, Default, Front or AlwaysOnTop). Edit on GitHub

ScriptImage.setZLevel(String zLevel)

showControl

Hides / Shows the control. Edit on GitHub

ScriptImage.showControl(bool shouldBeVisible)

updateContentPropertyInternal

This updates the internal content data object from the script processor. Edit on GitHub

ScriptImage.updateContentPropertyInternal(int propertyId,  var newValue)

updateValueFromProcessorConnection

Updates the value from the processor connection. Call this method whenever the module state has changed and you want to refresh the knob value to show the current state. Edit on GitHub

ScriptImage.updateValueFromProcessorConnection()