round~ Reference

Round an input signal value

round~

Description

Use the round~ object to round a signal input to an integer multiple.

Examples

round~ takes floating-point signals and rounds them to a specific increment

Discussion

You can set the object's 'nearest' attribute to determine whether or not it rounds to the absolute nearest integer multiple, or the nearest integer multiple between the value and zero (for positive numbers this will round down). By default this is on.

Arguments

int or float [number]

Optional

Sets the value to which the input signal will be rounded. The default value is 0. (no modification).

Attributes

nearest [int]

When set to 1 (the default), the round~ object will round to the nearest multiple of the specified signal value.

Note: This attribute does not set the rounding step (which is set using round~ object's right inlet), It specifies that rounding to the nearest signal value will occur. Here are some examples:

With the rounding interval set to 3 and the nearest attribute set to 1:
an input signal value of 5.8 will return 6
an input signal value of 3.7 will return 3
an input signal value of -1 will return 0
an input signal value of -2.7 will return -3

With the rounding interval set to 3 and the nearest attribute set to 0:
an input signal value of 5.8 will return 3
an input signal value of 3.7 will return 3
an input signal value of -1 will return 0
an input signal value of -2.7 will return 0

Common Box Attributes

annotation [symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background [int] (default: 0)

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.

color [4 floats]

Sets the color for the object box outline.

fontface [int]

Sets the type style used by the object. The options are:

plain
bold
italic
bold italic Possible values:

0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'

fontname [symbol]

Sets the object's font.

fontsize [float]

Sets the object's font size (in points). Possible values:

'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'

hidden [int] (default: 0)

Toggles whether an object is hidden when the patcher is locked.

hint [symbol]

Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.

ignoreclick [int] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

jspainterfile [symbol]

JS Painter File

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.

presentation [int] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 0. 0. 0. 0.)

Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.

rect [4 floats]

g/s(set)

Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).

size [2 floats]

g/s(set)

Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.

textcolor [4 floats]

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

textjustification [int]

Sets the justification for the object's text. Possible values:

0 = 'left'
1 = 'center'
2 = 'right'

varname [symbol]

Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.

Messages

int

Arguments

rounding-multiple-specifier [int]
In right inlet: an int will cause the input to be rounded to the nearest multiple of the specified number. If a signal is attached to the inlet, int messages are ignored.

float

Arguments

rounding-multiple-specifier [float]
In right inlet: a float will cause the input to be rounded to the nearest multiple of the specified number. If a signal is attached to the inlet, float messages are ignored.

signal

In left inlet: A signal whose values will be rounded.

In right inlet: A signal whose value is used for rounding. Signal values received in the left inlet will be rounded to either the absolute nearest integer multiple or the nearest integer multiple between the value received in this inlet or 0 (see the nearest message for more information).

Output

signal

The rounded input signal.

See Also

Name Description
rampsmooth~ Smooth an incoming signal
slide~ Filter a signal logarithmically
trunc~ Truncate fractional signal values
round Round to a value