Description

This element can be used to create custom surfaces which value can be set using links.

Inherited Attributes

See Attributes Common to All Elements.

Specific Attributes

Name

Value Type

Default Value

Description

Comment

V.

Exp.

name

string

Empty.

Displayed named of the surface.

2.0

No

comment

string

Empty.

description of the surface.

2.0

No

persistent

boolean

false

Sets the persistency of the surface.

When this property is set to 'true', the surface will be saved when closing the user interface and the value will be restored next time the user interface is opened.

2.0

No

Events

value_changed

event

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

2.0

also, each axis has the same attributes as a PARAM element, with additional "x_", "y_" or "z_" prefix, according to the considered axis.

Examples

The following example creates a surface used to display spectrum information in dB over time:

<?xml version="1.0" encoding="utf-8" ?>
<SKIN language_version="1.1">
    <SURFACE name="spectrum" x_default="0" x_max="1000" x_min="0" x_unit="ms" y_default="20" y_max="20000" y_min="20" y_unit="Hz" z_default="0" z_max="0" z_min="-60" z_unit="dB" />
</SKIN>