KUIML
Blue Cat's User Interface Programming Language
SURFACE_FROM_CURVE_OVER_TIME

Description

This element can be used to create custom surfaces based on the variations of an existing curve: the surface represents the evolution of the curve 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 surface.


1.3

No

comment

string

Empty.

Comment about the surface.


1.3

No

duration_ms

Any positive integer value

5000

Duration for the swept curve.

The x coordinate bounds will be [0;duration_ms]

1.3

No

refresh_time_ms

Any positive integer value

50

interval between two sampled values.

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

1.3

1.7

curve_id

curve id

Empty

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

Mandatory

1.3

No

paused

boolean

false

parameter sampling paused.

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

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 surface sampling the dsp.output_curve1 curve every 100 ms for 10 seconds:

<?xml version="1.0" encoding="utf-8" ?>
<SKIN language_version="1.2.2">
   <!--Create a surface with output curve 1 of the plug-in to display it later in a surface graph-->
	<CURVE_FROM_PARAM_OVER_TIME id="mySurface1"  curve_id="dsp.output_curve1" name="Output1 Surface" duration_ms="10000" refresh_time_ms="100"/>
</SKIN>