Envelope

Description

The Envelope template allows you to control HALion's multi-stage zone envelopes. The template contains a combination of controls, for example, to control the zoom level or values of the selected node. These controls are connected using UI parameters, and they must be part of the template and must use the UI variables as they are defined in the delivered template.

The envelope view that is used in the template cannot be created as an independent control directly on the macro page. If certain controls are not required or wanted, for example, no editing of values for the selected node, these controls can be removed for a user envelope template.

On this page:

Template Properties

Property	Description
Size	Position and Size of the element in pixels. Pos x, Pos y, Width, Height (Pos = Position of upper left corner)
Attach	Left: If the parent is resized, the control remains attached to left edge, with the specified ratio. Right: If the parent is resized, the control moves relatively to the right edge, with the specified ratio. Top: If the parent is resized, the control remains attached to top edge, with the specified ratio. Bottom: If the parent is resized, the control moves relatively to the bottom edge, with the specified ratio. Left + Right: If the parent is resized, the control is resized horizontally relatively to the left and right edges, with the specified ratio. Top + Bottom: If the parent is resized, the control is resized vertically relatively to the top and bottom edges, with the specified ratio.
Tooltip	Text that appears as a tooltip when the mouse hovers over the element.
Template	The referenced template.
Env Points	Connect this to the Envelope Points parameter of the envelope (zone parameter).
Mode	Connect this to the Mode parameter of the envelope (zone parameter).
Sync	Connect this to the Sync parameter of the envelope (zone parameter).
Triplet	Connect this to the Triplet parameter of the envelope (zone parameter).
Loop Start	Connect this to the LoopStart parameter of the envelope (zone parameter).
Loop End	Connect this to the LoopEnd parameter of the envelope (zone parameter).
Sustain	Connect this to the SustainIndex parameter of the envelope (zone parameter).
Playback Pos	Connect this to the PlaybackPos parameter of the envelope (zone parameter).

Components and how they are used

UI Variables

These variables are defined to allow the communication between the envelope view and other controls in the template.

Variable	Description	Type	Range
index	Index of the selected node	integer	n.a.
level	Level of the selected node	float	0 - 100
time	Time of the selected note	float	0 - 30000
curve	Curvature of the selected note segment	float	-10 - 10
beat	Time in beats	rational	n.a.
syncnote	Specifies the note grid	stringlist	1/1, 1/2, 1/4, 1/8, 1/16, 1/32, 1/64, 1/128, 1/256

Controls and Sub Templates

Item	Description
Scroll & Zoom	This group view contains several controls which allow you to access the scroll and zoom functionalities of the envelope. Scrollbar: A range slider which needs to be configured with Low Value = "@ScrollMin" and High Value = "@ScrollMax". Scrollbar Background: An image that delivers the background bitmap for the scrollbar. Zoom Out: A switch that allows you to trigger the zoom out function of the envelope. Its value must be set to "@ZoomOut". Zoom In: A switch that allows you to trigger the zoom in function of the envelope. Its value must be set to "@ZoomIn". Zoom Alternate: A switch that allows you to switch between the last zoom state and a full zoom out. Its value must be set to "@StateA". Zoom1: A switch that allows you to call zoom state 1 of the envelope. Its value must be set to "@State1". Zoom2: A switch that allows you to call zoom state 2 of the envelope. Its value must be set to "@State2". Zoom3: A switch that allows you to call zoom state 3 of the envelope. Its value must be set to "@State3".
Edit	This group view contains several controls which allow to control the selected node, as well as some edit options of the envelope. Time: A stack with two edit controls to either set the time of a node in ms or beats. Its value is exported as "Sync", to allow a connection to the Sync parameter of the HALion engine. The "Time ms" control is set to Value = "@time", the "Time Beat" control is set to Value = "@beat". Mode: A menu template, with an exported value (Mode) that can be connected to the Mode parameter of the envelope in the HALion zone. Sync: A switch template, with an exported value (Sync) that can be connected to the sync parameter of the envelope in the HALion zone. Fixed: A switch template, with a value set to "@fixed", which represents an integer variable defined under "Variables". This way, you can control the HALion UI parameter "Fixed" which is no Zone parameter. Curve: An edit template, with a value set to "@curve", which allows you to control the curve setting of the selected node. Level: An edit template, with a value set to "@level", which allows you to control the level setting of the selected node. Index: An edit template, with a value set to "@index", which allows you to specify which node is selected. SyncNote: A disable view, with an exported value (Sync) that can be connected to the Sync parameter of the envelope in the HALion zone. If Sync is active, the contained templates can be used to set Sync Note and Triplet. Sync Note: A menu template, with a value set to "@syncnote", which represents a stringlist variable defined under "Variables". This way, you can control the HALion UI parameter "Sync Note" which is no Zone parameter. Triplet: A switch template, with an exported value (Triplet), which can be connected to the Triplet parameter of the envelope in the HALion zone.
Envelope View	Provides a graphical envelope editor. Several of its parameters are exported to be connected on a template instance level to the HALion engine (Value, Mode, Sync, Triplet, Loop Start/End, Sustain, Play Pos). Other parameters are set to the same internal variables as the controls mentioned above, to allow for communication between the envelope view and the connected controls (SyncNote, Fixed, Index, Level, Time, Beat, Curve).
Env Background	This image delivers the background bitmap for the envelope.

Envelope View

Properties

In addition to standard properties like size, position, etc., the envelope view provides a number of properties and colors to customize its appearance and behavior.

Property	Description
Name	The name of the envelope view.
Size	Position and Size of the element in pixels. Pos x, Pos y, Width, Height (Pos = Position of upper left corner)
Attach	Left: If the parent is resized, the control remains attached to left edge, with the specified ratio. Right: If the parent is resized, the control moves relatively to the right edge, with the specified ratio. Top: If the parent is resized, the control remains attached to top edge, with the specified ratio. Bottom: If the parent is resized, the control moves relatively to the bottom edge, with the specified ratio. Left + Right: If the parent is resized, the control is resized horizontally relatively to the left and right edges, with the specified ratio. Top + Bottom: If the parent is resized, the control is resized vertically relatively to the top and bottom edges, with the specified ratio.
Tooltip	Text that appears as a tooltip when the mouse hovers over the element.
Style	Bipolar: Activate this style for bipolar envelopes like pitch or pan. Scrollbar: If this is active, the view can be scrolled and zoomed. Cross: Shows a cross line when editing nodes. Grid: Shows a time grid. Play Pos: Shows the current playback position on the curve. Nodes: Shows nodes. Add/Rem: Allows adding and removing of nodes. Deactivate this option to provide an ADSR envelope with a fixed number of nodes, for example. Sel Nod: Allows you to select a node. Sustain: Shows a sustain line. For this, a mode with sustain must be active. Loop: Shows a graphical frame overlay for the loop region. For this, the Envelope mode must be switched to Loop. Free End: Allows to ...
Env Value	Exported to the template (see template parameters above).
Mode	Exported to the template (see template parameters above).
Sync	Exported to the template (see template parameters above).
Triplet	Exported to the template (see template parameters above).
SyncNote	Connected using @syncnote variable.
Fixed	Connected using @fixed variable.
Tool	Connected using @tool variable. Only for Shaper mode, therefore use Envelope Shaper template (Minimum HALion7 )
ShapeSave	Connected using @shapesave variable. Only for Shaper mode, therefore use Envelope Shaper template (Minimum HALion7 )
ShapeSelect	Connected using @shapeselect variable. Only for Shaper mode, therefore use Envelope Shaper template (Minimum HALion7 )
Shape	Connected using @shape variable. Only for Shaper mode, therefore use Envelope Shaper template (Minimum HALion7 )
Index	Connected using @index variable.
Level	Connected using @level variable.
Time	Connected using @time variable.
Beat	Connected using @beat variable.
Curve	Connected using @curve variable.
Loop Start	Exported to the template (see template parameters above).
Loop End	Exported to the template (see template parameters above).
Sustain	Exported to the template (see template parameters above).
Play Pos	Exported to the template (see template parameters above).
Min X	The minimal horizontal zoom value.
Max X	The maximum horizontal zoom value.
Min Y	The minimal vertical zoom value.
Max Y	The maximum vertical zoom value.

Colors

Property	Description
Line	Curve line
Fill	Fill color of the nodes
FillSelected	Fill color of selected nodes (only used if "Sel Node" style is active)
FrameFocus	Focused node frame
Frame	Node frame
Hover	Hover frame
Sustain	Sustain line (only used if "Sustain" style is active)
Synced	Dot color of nodes that are snapped to a sync grid position (only used if Sync is active)
Crosshair	Node edit crosshair (only used if "Crosshair" style is active)
Playback	Playback position indicator
Border	Overall border
Grid V	Main vertical grid (only used if "Grid" style is active)
Grid V2	Additional vertical fine grid (only used if "Grid" style is active)
Grid H	Main horizontal grid (only used if "Grid" style is active)
Grid H2	Additional horizontal fine grid (only used if "Grid" style is active)
Font	Scale font
SelFrame	Selection area frame
Loop	Loop area
LoopFrame	Loop area frame
Zoom	Zoom area
ZoomFrame	Zoom area frame

Page tree