Single Dim Pars¶
Single-Dimension Variant
Import¶
import "_IVLS/std-library/nodes/components/engine-box/single-dim-pars.ksp"Overview¶
Single-Dimension Variant
LIBRARY MODULE
Parameter engine for single-dimension data addressed by a single par index.
Data.CreateSingleDim(name)— creates engine with persistent_data[],_data.buffer[],_data.mod[]- Exposes
data,data.buffer,data.mod,par,par.mod_offset,par.ctrl_idproperties - Generates named per-parameter properties from
par.MEMBERSviaData._SingleParProperty - Generates metadata properties from
Data.META_PARSviaData._SingleMetaProperty
API¶
Properties¶
| Name | Description |
|---|---|
property #par# |
Gets current value; sets value triggering par_cb and control update. |
property #par#.ctrl_id |
Gets or sets the bound UI control ID for this parameter. |
property #par#.ctrl_label |
Gets or sets the bound label control ID for this parameter. |
property #par#.live |
Gets value with modulation offset applied (read-only). |
property #par#.mod_offset |
Gets or sets modulation offset for this parameter. |
property #par#.pad_idx |
Gets or sets the XY pad cursor index for this parameter. |
property #par#.public |
Gets current value; sets value triggering par_cb with UI display flag. |
property #par#.raw |
Direct value access bypassing par_cb. |
property #par#.ui_routine |
Gets or sets the UI routine binding for this parameter. |
property data |
Gets or sets raw data by parameter index. |
property data.buffer |
Gets or sets buffer data by parameter index. |
property data.mod |
Gets or sets modulation offset by parameter index. |
property par |
Gets parameter value; sets value triggering par_cb and control update. |
property par.#meta_par# |
Gets or sets the #meta_par# metadata value for a parameter. |
property par.#meta_par#.all |
Sets #meta_par# metadata for all dimension combinations of a parameter (write-... |
property par.ctrl_id |
Gets or sets the bound UI control ID for a parameter. |
property par.mod_offset |
Gets or sets modulation offset for a parameter. |
Macros¶
| Name | Description |
|---|---|
Data.CreateSingleDim(#name#) |
Creates a single-dimension parameter engine for parameter sets addressed by a si... |
Properties¶
property #par#¶
Gets current value; sets value triggering par_cb and control update.
property #par#.ctrl_id¶
Gets or sets the bound UI control ID for this parameter.
property #par#.ctrl_label¶
Gets or sets the bound label control ID for this parameter.
property #par#.live¶
Gets value with modulation offset applied (read-only).
property #par#.mod_offset¶
Gets or sets modulation offset for this parameter.
property #par#.pad_idx¶
Gets or sets the XY pad cursor index for this parameter.
property #par#.public¶
Gets current value; sets value triggering par_cb with UI display flag.
property #par#.raw¶
Direct value access bypassing par_cb.
property #par#.ui_routine¶
Gets or sets the UI routine binding for this parameter.
property data¶
Gets or sets raw data by parameter index.
property data.buffer¶
Gets or sets buffer data by parameter index.
property data.mod¶
Gets or sets modulation offset by parameter index.
property par¶
Gets parameter value; sets value triggering par_cb and control update.
property par.#meta_par#¶
Gets or sets the #meta_par# metadata value for a parameter.
property par.#meta_par#.all¶
Sets #meta_par# metadata for all dimension combinations of a parameter (write-only).
property par.ctrl_id¶
Gets or sets the bound UI control ID for a parameter.
property par.mod_offset¶
Gets or sets modulation offset for a parameter.
Macros¶
Data.CreateSingleDim(#name#)¶
Creates a single-dimension parameter engine for parameter sets addressed by a single index.
Preconditions:
#name#.DIMS,#name#.SIZES,#name#.par.MEMBERS,#name#.par.LONGNAMESmust be defineddata.engine_id.#name#must be defined as a unique engine ID
| Parameter | Description |
|---|---|
#name# |
engine namespace |
Side effects:
| Name | Type | Purpose |
|---|---|---|
#name#._data[] |
int[] | Main persistent data storage |
#name#._data.buffer[] |
int[] | Instance-persistent buffer |
#name#._data.mod[] |
int[] | Modulation offsets |
- Generates
data,data.buffer,data.modproperties - Generates
par,par.mod_offset,par.ctrl_idproperties - Generates per-parameter properties via
Data._SingleParProperty - Generates per-meta-parameter properties via
Data._SingleMetaProperty - Calls
Data._CreateCommon()internally
Example¶
// TODO: Add usage example