<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<?xml-stylesheet href="./_c74_ref.xsl" type="text/xsl"?>
<!--This is an automatically generated file. DO NOT EDIT THIS FILE DIRECTLY.-->
<c74object module="rnbo" kind="rnboobject" name="line" category="Envelopes">
<!--METADATA-->
<metadatalist>
<metadata name="author">Cycling '74</metadata>
<metadata name="tag">RNBO</metadata>
<metadata name="tag">RNBO Functions</metadata>
<metadata name="tag">RNBO Envelopes</metadata>
</metadatalist>
<digest>Linear event ramp generator</digest>
<description><p>
Generate ramps and line segments from one value to another within a specified amount of time.
</p></description>
<!--ARGUMENTS-->
<objarglist>
<objarg name="initial" optional="1" type="number">
<digest>Initial value of ramp</digest>
<description><p>
Sets an initial value for the signal output. The default value is 0.
</p></description>
</objarg>
<objarg name="grain" optional="1" type="number">
<digest>Time Grain in Milliseconds.</digest>
<description><p>
Sets an initial value for the grain: the time interval at which numbers are sent out. If the grain is not specified, line outputs a number every 20 milliseconds.
</p></description>
</objarg>
</objarglist>
<!--OPTIONS-->
<rnbooptionlist>
<option name="initial" size="1" type="number">
<digest>Initial value of ramp</digest>
<attributelist>
<attribute name="default" type="number" value="0"></attribute>
</attributelist>
<description><p>
Sets an initial value for the signal output. The default value is 0.
</p></description>
</option>
</rnbooptionlist>
<!--ATTRIBUTES-->
<rnboattributelist>
<attribute name="grain" size="1" type="number">
<digest>Time Grain in Milliseconds.</digest>
<description><p>
Sets an initial value for the grain: the time interval at which numbers are sent out. If the grain is not specified, line outputs a number every 20 milliseconds.
</p></description>
</attribute>
<attribute name="pause" size="1" type="bang">
<digest>Pause the ramp</digest>
<description><p>
Pauses the internal ramp but does not change the target value nor clear pending target-time pairs. line will continue outputting whatever value was its current value when the pause message was received, until either it receives a resume message or until a new ramp is input.
</p></description>
</attribute>
<attribute name="resume" size="1" type="bang">
<digest>Resume the ramp</digest>
<description><p>
Resumes the internal ramp and subsequent pending target-time pairs if the line object was paused.
</p></description>
</attribute>
<attribute name="set" size="1" type="number">
<digest>Set initial value without output</digest>
<description><p>
Sets the starting value of the next ramp without output.
</p></description>
</attribute>
<attribute name="stop" size="1" type="bang">
<digest>Stop the ramp</digest>
<description><p>
Stops line from sending out numbers, until a new target value is received.
</p></description>
</attribute>
<attribute name="target" size="1" type="list">
<digest>Destination Value of ramp</digest>
<description><p>
In left inlet: The first number specifies a target value and the second number specifies the ramp time (in milliseconds) in which line should reach the target value. In the specified amount of time, line generates a ramp signal from its current value to the target value.
</p>
<p>
The line object accepts target-time pairs in a list, to generate compound ramps. (An example would be 0 1000 1 1000, which would go from the current value to 0 in a second, then to 1 in a second.) Once one of the ramps has reached its target value, the next one starts. A subsequent list, float, or int in the left inlet clears all ramps yet to be generated.
</p>
<p>
A list consisting of a number, followed by a value of '0' will set an initial value for the ramp. An example would be 4.5 0 1 1000 which would set an initial value of 0, a new value of 1, and a target time of 1000 ms.
</p></description>
</attribute>
<attribute name="time" size="1" type="number">
<digest>Total Ramp Time in Milliseconds.</digest>
<description><p>
Ramp time is the total amount of time (in milliseconds) in which line should reach the target value. This value is only used when a single value is input to the leftmost target inlet. Once a ramp has been completed, this value is set to 0 and must be set again.
</p></description>
</attribute>
</rnboattributelist>
<!--INLETS-->
<rnboinletlist>
<inlet id="inlet_target" name="target" type="list">
<digest>Destination Value of ramp</digest>
<description><p>
In left inlet: The first number specifies a target value and the second number specifies the ramp time (in milliseconds) in which line should reach the target value. In the specified amount of time, line generates a ramp signal from its current value to the target value.
</p>
<p>
The line object accepts target-time pairs in a list, to generate compound ramps. (An example would be 0 1000 1 1000, which would go from the current value to 0 in a second, then to 1 in a second.) Once one of the ramps has reached its target value, the next one starts. A subsequent list, float, or int in the left inlet clears all ramps yet to be generated.
</p>
<p>
A list consisting of a number, followed by a value of '0' will set an initial value for the ramp. An example would be 4.5 0 1 1000 which would set an initial value of 0, a new value of 1, and a target time of 1000 ms.
</p></description>
</inlet>
<inlet id="inlet_time" name="time" type="number">
<digest>Total Ramp Time in Milliseconds.</digest>
<description><p>
Ramp time is the total amount of time (in milliseconds) in which line should reach the target value. This value is only used when a single value is input to the leftmost target inlet. Once a ramp has been completed, this value is set to 0 and must be set again.
</p></description>
</inlet>
<inlet id="inlet_grain" name="grain" type="number">
<digest>Time Grain in Milliseconds.</digest>
<description><p>
Sets an initial value for the grain: the time interval at which numbers are sent out. If the grain is not specified, line outputs a number every 20 milliseconds.
</p></description>
</inlet>
</rnboinletlist>
<!--OUTLETS-->
<rnbooutletlist>
<outlet id="outlet_output" name="output" type="number">
<digest>Ramp Output</digest>
<description><p>
The current destination value, or a ramp moving toward the destination value according to the currently stored value and the ramp time.
</p></description>
</outlet>
<outlet id="outlet_end" name="end" type="bang">
<digest>End of Ramp</digest>
<description><ul>
<li>A bang is sent out the right outlet when line has finished generating all its ramps.</li>
</ul></description>
</outlet>
</rnbooutletlist>
<!--SEE ALSO-->
<seealsolist>
<seealso name="line~" type="refpage" module="MSP"></seealso>
<seealso name="line" type="refpage" module="Max"></seealso>
<seealso name="rnbo_line~" type="rnborefpage" module="RNBO" display="line~"></seealso>
<seealso name="rnbo_uzi" type="rnborefpage" module="RNBO" display="uzi"></seealso>
</seealsolist>
</c74object>