/ HALion Developer Resource / HALion Macro Page / Templates /

Step Modulator(Template)


On this page:


Step Modulator

Description

The StepModulator template contains controls for adjusting the steps and their slopes, for shifting the steps left or right and for reversing the steps. To ensure the operation of these controls, the preconfigured properties must not be modified. The look and the size of the controls can be modified freely. All controls for functions that are not needed for your instrument can be omitted on your macro page.

To explore the functionality and connections:

  1. Load the Init Basic Controls.vstpreset from the Basic Controls library.
  2. Open the Macro Page Designer, go to the GUI Tree and navigate to "Pages > Step Modulator Page".
  3. Select "StepModulator" and click Edit Element Edit Element to examine the template.

❕ The other control templates inside the Step Modulator Page group are directly connected to the Step Modulator of the zone and do not require detailed explanation.

Template Properties

PopertyDescription
NameThe name of the element. This name will be displayed in the GUI Tree.
Position/SizePosition X, Position Y, Width, Height: Position and size of the element in pixels. Position X/Y defines the position of the upper left corner.
AttachDefines how an element behaves when its parent element is resized. You can set the following parameters:
  • Left: If the parent element is resized, the element remains attached to left edge, with the specified ratio.
  • Right: If the parent element is resized, the element moves relatively to the right edge, with the specified ratio.
  • Top: If the parent element is resized, the element remains attached to top edge, with the specified ratio.
  • Bottom: If the parent element is resized, the element moves relatively to the bottom edge, with the specified ratio.
  • Left + Right: If the parent element is resized, the element is resized horizontally relatively to the left and right edges, with the specified ratio.
TooltipText that appears as a tooltip when the mouse hovers over the element.
TemplateDetermines the template to be referenced.

Template Parameters

ParameterDescription
Step1-32Connect these to the corresponding steps (Step1 to Step32) of the StepMod section of the zone.
StepsConnect this to the Steps parameter of the StepMod section of the zone.
SlopeConnect this to the Slope parameter of the StepMod section of the zone.
Slope AmtConnect this to the SlopeAmount parameter of the StepMod section of the zone.

Components inside the Template

StepModulatorTemplate

UI Variables

These variables are defined to allow the communication between the stepmodulator control and other controls in the template.

VariableDescriptionTypeRange
level12Level in fractions of -12 to 12 semitones (used when Snap is on).float-12.0 - 12.0
levelLevel of the selected node.float0 - 100.0
indexIndex of the selected node.integer1 - 32
snapActivates snap lines.integer0, 1
shiftleftShifts the pattern to the left.integer0, 1
shiftrightShifts the pattern to the right.integer0, 1
reverseReverses the pattern.integer0, 1

Controls and Subtemplates

To ensure the operation of the controls and subtemplates, the preconfigured properties must not be modified. The look and the size of the controls can be modified freely. All controls for functions that are not needed for your instrument can be omitted on your macro page.

ItemDescription
SnapA Switch control to activate the Snap option. Its Value must be set to @snap.
Lev/Lev12This Stack contains two value box templates. The Stack switches between Level100 and Level12 using the UI variable @snap.
  • Lev100: A value box template that is connected to the step modulator by the UI variable @level. It controls the level of the selected step in the range from 0 to 100 %. The template is active if Snap is off.
  • Lev12: A value box template that is connected to the step modulator by the UI variable @level12. It controls the level of the selected step in fractions of -12 to 12 semitones. The template is active if Snap is on.
IndexA value box template that is connected to the step modulator by the UI variable @index. It selects the step to be edited by the value boxes.
stepmodulatorFor details see Step Modulator control.
imageAn Image control that provides the bitmap for the frame of the step modulator.
ShiftLeftA Switch control that is connected to the Shift Left parameter of the step modulator by the UI variable @shiftleft.
ShiftRightA Switch control that is connected to the Shift Right parameter of the step modulator by the UI variable @shiftright.
ReverseA Switch control that is connected to the Reverse parameter of the step modulator by the UI variable @reverse.