A newer version of Max is available. Click here to access the latest version of the documentation

live.dial Reference

Output numbers by moving a dial onscreen

live.dial

Description

live.dial works like a circular slider that outputs numbers according to its degree of rotation.

Examples

Arguments

None.

Attributes

active [int] (default: 1)

Toggles the object's active mode. When the active attribute is set to 0, the mouse action does not cause output and the inactive colors are used.

activedialcolor [4 floats]

Sets the dial color in RGBA format to be used when the active attribute is set to 1.

activefgdialcolor [4 floats]8.0.0

Sets the foreground dial color in RGBA format to be used when the active attribute is set to 1.

activeneedlecolor [4 floats]

Sets the needle color in RGBA format to be used when the active attribute is set to 1.

annotation_name [symbol] (default: )

The string that is prepended to annotations. This shows up in the Info pane in Live, and the clue window in Max.

appearance [int] (default: 0)

The word appearance followed by a number, sets the display style for the live.dial object.

Possible values:

0 = 'Vertical' ( Vertical dial display )
Sets a vertical display (the default).

1 = 'Tiny' ( Tiny dial display )
Sets a very tiny dial display.

2 = 'Panel' ( Panel dial display )
Sets a dial display that includes a labeled panel.

3 = 'Large' ( Large dial display )
Sets a large dial display.

bordercolor [4 floats]

Sets the display color for the live.dial object's border in RGBA format.

dialcolor [4 floats]

Sets the dial color in RGBA format displayed when the active attribute is set to 0.

fgdialcolor [4 floats]8.0.0

Sets the foreground dial color in RGBA format displayed when the active attribute is set to 0.

focusbordercolor [4 floats]

Sets the display color for the focused live.dial object's border in RGBA format.

needlecolor [4 floats]

Sets the needle color in RGBA format. This is only used when the active attribute is set to 0.

panelcolor [4 floats]

Sets the panel color in RGBA format. This is only used when the appearance attribute is set to panel mode.

parameter_mappable [int] (default: 1)

When parameter_mappable is enabled, the object will be available for mapping to keyboard or MIDI input using the Mappings feature.

showname [int] (default: 1)

Toggles the display of the parameter name. The default is 1 (displayed).

shownumber [int] (default: 1)

Toggles the display of the parameter value. The default is 1 (displayed).

textcolor [4 floats]

Sets the display color for the live.dial object's text in RGBA format.

triangle [int] (default: 0)

Toggles the display of a triangle in the dial display. When the triangle attribute is set to 1 and the triangle is displayed, clicking on it will restore the dial's initial value.

tricolor [4 floats]

Sets the display color for the live.dial object's triangle in RGBA format when the dial is in the default position.

Common Box Attributes

Parameter Attributes

Messages

bang

Sends the current value out the outlet.

int

Arguments

input [int]
The number received in the inlet is stored and displayed by the live.dial object and sent out the outlet.

float

Arguments

input [float]
The number received in the inlet is stored and displayed in the live.dial and sent out the outlet.

assign

Arguments

assign-input [float]
The word assign, followed by a floating point value, causes that value to be stored and displayed and sent out the live.dial object's outlet. If the Parameter Visibility attribute is set to Stored Only, the assign message will not add the new value to the Live application’s undo chain.

init

Restores and outputs the initial value.

(mouse)

Click and drag in the dial to change the value. Hold down the Shift key for more precise mouse control.

outputvalue

Sends the current value out the outlet.

rawfloat

Arguments

input [float]
A raw normalized value (between 0. and 1.) received in the inlet is converted to a real value, stored, displayed by live.dial, and the current value is sent out the outlet.

set

Arguments

set-input [float]
Sets the current value without causing any output.

Output

float

Out right outlet: When an output is triggered, a raw normalized value (between 0. and 1.) is sent out this outlet.

int/float

Out left outlet: Numbers received in the object's inlet or produced by clicking or dragging on the live.dial object with the mouse are sent out the outlet. The value sent is an integer if the Parameter Type is set to INT or ENUM.

See Also

Name Description
Max For Live Max For Live
live.numbox
live.slider
dial
Max Basic Tutorial 7: Numerical User Interfaces Max Basic Tutorial 7: Numerical User Interfaces