KUIML
Blue Cat's User Interface Programming Language
CURVE_FROM_PARAM_OVER_TIME

Description

This element can be used to create custom curves based on the variations of a parameter: the curve represents the evolution of the parameter over time.

Inherited Attributes

See Attributes Common to All Elements.

Specific Attributes

Name Value Type Default Value Description Comment V. Exp.

name

string

Empty.

Displayed name of the curve.


1.2.2

No

comment

string

Empty.

Comment about the curve.


1.2.2

No

duration_ms

Any positive integer value

5000

Duration for the curve.


1.2.2

No

refresh_time_ms

Any positive integer value

50

interval between two sampled values.

You should decrease this value if you are concerned with display performance issues.

1.2.2

No

param_id

param id

Empty

Identifier of the parameter sampled over time to create the curve.

Mandatory

1.2.2

No

paused

boolean

false

parameter sampling paused.

Use this parameter to pause the curve (it will stop sampling the parameter).

1.3

1.3

Events

value_changed

event

the event is triggered anytime the value of the object has changed.

2.0

Examples

The following example creates a curve sampling the dsp.input1 parameter every 100 ms for 10 seconds:

<?xml version="1.0" encoding="utf-8" ?>
<SKIN language_version="1.2.2">
   <!--Create a curve with input param 1 of the plug-in to display it later in a graph-->
	<CURVE_FROM_PARAM_OVER_TIME id="myCurve1"  param_id="dsp.input1" name="Input1 Curve" duration_ms="10000" refresh_time_ms="100"/>
</SKIN>