添加链接
link管理
链接快照平台
  • 输入网页链接,自动生成快照
  • 标签化管理网页链接

swatch Reference

Choose a color

swatch

Description

Provides 2-dimensional selection and display of colors, representing hue along the horizontal axis and lightness along the vertical axis. A third color dimension, saturation, may be set by means of the saturation message.

Examples

Sets the order of recall of this parameter. Lower numbers are recalled first. The order of recall of parameters with the same order number is undefined.

Parameter Mode Enable

Type int Parameter Mode Enable (not available from Parameters window)

Link to Scripting Name

Type int When checked, the Scripting Name is linked to the Long Name attribute.

Long Name

Type symbol The long name of the parameter. This name must be unique per patcher hierarchy.

Short Name

Type symbol Sets the short name for the object's visual display. The maximum length varies according to letter width, but is generally in a range of 5 to 7 characters. Type int Specifies the data type. The data types used in Max for Live are: Float Enum (enumerated list) Note: By convention, the Live application uses floating point numbers for its calculations; the native integer representation is limited to 256 values, with a default range of 0-255 (similar to the char data type used in Jitter). When working with Live UI objects whose integer values will exceed this range, the Type attribute should be set to Float, and the Unit Style attribute should be set to Int.

Range/Enum

Type list When used with an integer or floating point data type, this field is used to specify the minimum and maximum values of the parameter. When used with an enumerated list (Enum) data type, this field contains a space-delimited list of the enumerated values (if list items contain a space or special characters, the name should be enclosed in double quotes).

Clip Modulation Mode

Type int Sets the Clip Modulation Mode used by the Live application. The modulation modes are: Unipolar Bipolar Additive Absolute Sets the unit style to be used when displaying values. The unit style values are: Int: displays integer values Float: displays floating point values Time: displays time values in milliseconds (ms) Hertz: displays frequency values (Hz/kHz). deciBel: displays loudness (dB) %: Percentage Pan: displays Left and Right values Semitones: displays steps (st) MIDI: displays pitch corresponding to the MIDI note number Custom: displays custom data type Native: defaults to floating point values

Custom Units

Type symbol Sets the units to be used with the 'Custom' unit style (see "Unit Style", above). Custom unit strings may be simple symbols (e.g. "Harmonic(s)"), in which case the parameter's value will be displayed in its 'Native' display mode, followed by the symbol (e.g. "12 Harmonic(s)" for an Int-typed parameter or "12.54 Harmonic(s)" for a Float-typed parameter). For additional control over the numerical component displayed, a sprintf-style string may be used (e.g. "%0.2f Bogon(s)", which would display a value such as ".87 Bogons").

Exponent

Type float When set to a value other than 1., the parameter's input and output values will be exponentially scaled according to the factor entered in this column.

Steps

Type int The number of steps available between the minimum and maximum values of a parameter. For instance, if the parameter has a range from 0.-64., with Steps set to 4, the user can only set the parameter to 0, 21.33, 42.66 and 64.

Parameter Visibility

Type int For automatable parameters (Int, Float, Enum), 'Stored Only' disables automation, although parameter values are stored in presets. 'Hidden' causes the parameter's value to be ignored when storing and recalling data. Non-automatable parameters (Blob) are 'Stored Only' by default, and can be set to 'Hidden', if desired.

Update Limit (ms)

Type int Speed limits values triggered by automation.

Defer Automation Output

Type int Defers values triggered by automation.

Messages

bang message causes output of the RGBA values of the current color at the selected (x,y) position on the 2-dimensional colorspace, taking into account the current saturation value.

Arguments

[int] In left inlet: Set the red color value (ignores values over 1), and cause output of all values. Note: Unlike most Max objects, input to any one of the three inlets will re-calculate the current color location on the swatch, and trigger output.

(inlet1)

Arguments

green [int] In middle inlet: Set the red color value (ignores values over 1), and cause output of all values. Note: Unlike most Max objects, input to any one of the three inlets will re-calculate the current color location on the swatch, and trigger output.

(inlet2)

Arguments

[int] In right inlet: Set the red color value (ignores values over 1), and cause output of all values. Note: Unlike most Max objects, input to any one of the three inlets will re-calculate the current RGBA color location on the swatch, and trigger output.

float

Arguments

[float] Set the red color value (0.-1.), and cause output of all values.

(inlet1)

Arguments

green [float] Set the green color value (0.-1.), and cause output of all values.

(inlet2)

Arguments

[float] Set the red color value (0.-1.), and cause output of all values.

Arguments

[number]
green [number] [number]
alpha [number] A list of three numbers between 0. and 1. sets the four RGBA color components (red, green, blue, alpha), refreshes the display and causes RGBA output.

alpha

Arguments

opacity [float] The word alpha , followed by a floating-point number between 0. and 1., will set the RGBA alpha (opacity) value.

Arguments

[int]
saturation [int]
lightness [int] The word hsl , followed by a list of three numbers between 0. and 1., sets the color based on the given hue (x-axis), saturation, and lightness (y-axis) values. The swatch object converts these values to RGBA color values, refreshes the display, and causes output of the RGBA values.

(mouse)

Clicking and dragging on the swatch object will calculate and output the RGBA color at the selected (x, y) position on the 2-dimensional (hue-lightness) colorspace, taking into account the current saturation value.

Arguments

[number]
green [number] [number]
alpha [number] The word set , followed by a list of three numbers between 0. and 1. sets the four RGBA color components (red, green, blue, alpha) and refreshes the display without causing RGBA output.

sethsl

Arguments

[int]
saturation [int]
lightness [int] The word sethsl , followed by a list of three numbers between 0. and 1., sets the color based on the given hue (x-axis), saturation, and lightness (y-axis) values and the refreshes the display. Unlike the hsl message the sethsl message does not output the corresponding RGBA values.

Output

Out right outlet: the current saturation value (calculated from an RGB list input, or output directly after a saturation message) Out left outlet: a list of four RGBA (red, green, blue, alpha) color values

See Also

Description