GMZZMultiSlider:
Filter:
GraphicalModule/Classes (extension) | GUI > Graphical Module

GMZZMultiSlider
ExtensionExtension

An abstract class for sliders with multiple values (Graphical Module)

Description

GMZZMultiSlider is an abstract class that defines multiple values sliders behavior within the scope of the Graphical Module. The class name begins with "GMZZ" so it is displayed last in the autocompletion API.

A note about this documentation

This class is an extension of the GMZZSlider class. It retains the same principle, but for several values instead of one. As such, you should read the GMZZSlider class documentation first, as only differences between those two classes are documented here.

Action Mode

GMZZMultiSlider manipulates an Array of values. The size of this array will define how many sliders are displayed within the view. By default, the Function associated with the action will be called passing this array as argument every time one of the value is modified.

This is however somehow inefficient, as the the multislider only allows to modify a single value at a time. You can change this behavior by setting the actionMode parameter to \index. In this case, the function will be evaluated with the index of the value, and its new value, as arguments :

Orientation

The orientation logic isn't the same as GMZZSlider. Here, an \horizontal orientation means sliders will be distributed horizontally, which means they will be interacted with vertically.

When the sliders are distributed vertically, the topmost slider will modify the first value of the array, the bottommost slider will modify the last value of the array.

Sequencer API

GMZZMultiSlider can be used as a sequencer. As such, it is possible to highlight certain sliders, and to use a Routine to highlight the current beat. Since those are graphical properties only, those methods are documented within the documentation of the classes that inherit from GMZZMultiSlider.

Class Methods

.new

Creates a new instance of GMZZMultiSlider.

Returns:

a GMZZMultiSlider instance. This method is implicitely internal.

Instance Methods

.values

Sets or gets the values the multislider is manipulating. The size of the array defines how many sliders are displayed.

.action

Sets or gets the Function to be evaluated when interacting with the multislider changes one its value. Depending on the selected actionMode, this Function either takes the current values as argument, or the last modified value with its index.

.actionMode

Sets or gets the argument format the action function is expecting. Can be either \values or \index (see above).

.orientation

Sets or gets the orientation of the multislider. This refers to the orientation of the sliders distribution, not the orientation they are interacted with. Can be either \horizontal or \vertical.

GMZZSlider Methods

See the GMZZSlider class documentation for those methods.

.min

.max

.expMin

.scale

.polarity

.mouseDownAction

.helpersNumber

.helperSubdivisions

.modStep

.modStepOperator

.modStepPixelRange

.modStep2

.modStep2Operator

.modStep2PixelRange

.modSteps

.modStepsOperators

.modStepsPixelRanges

Internal Methods

.prUpdateValue

.prCheckMod

.prGetClosestHelper

.prGetModStepValue

Examples

See the GMFaderMultiSlider documentation for examples.