struct CCL::ParameterDefinition

Overview

#include <paramdefinition.h>

struct ParameterDefinition
{
    // fields

    ParameterType type;
    MutableCString className;
    int flags;
    MutableCString name;
    String title;
    int tag;
    Variant minValue;
    Variant maxValue;
    Variant midValue;
    Variant defaultValue;
    Variant precision;
    Variant data;
    MutableCString curveName;
    MutableCString unitName;

    // methods

    bool hasRange () const;
    ParameterDefinition& setType (ParameterType _type);
    ParameterDefinition& setFlags (int _flags);
    ParameterDefinition& setName (StringID _name);
    ParameterDefinition& setTitle (StringRef _title);
    ParameterDefinition& setTag (int _tag);
    ParameterDefinition& setRange (VariantRef _min, VariantRef _max);
    ParameterDefinition& setMid (VariantRef _mid);
    ParameterDefinition& setDefault (VariantRef _default);
    ParameterDefinition& setPrecision (VariantRef _precision);
    ParameterDefinition& setListValue (const ConstVector <String>& strings);
    ParameterDefinition& setListValue (const ConstVector <CStringPtr>& strings);
    ParameterDefinition& setCurve (StringID _curve);
    ParameterDefinition& setUnit (StringID _unit);
};

Detailed Documentation

Parameter definition.

Fields

ParameterType type

parameter type,

See also:

ParameterFlags

MutableCString name

internal parameter name, e.g. for persistence

String title

user-facing parameter title

int tag

internal parameter identifier

Variant minValue

minimum value for numeric parameters (integer or floating-point)

Variant maxValue

maxiumun value for numeric parameters (integer or floating-point)

Variant midValue

additional value for interpolator (optional, independent of to min/max)

Variant defaultValue

default parameter value

Variant precision

parameter precision (optional)

Variant data

additional data (e.g. IArrayObject with list entries)

MutableCString curveName

parameter curve name (IParamCurve, optional)

MutableCString unitName

parameter unit name (IFormatter, optional)

Methods

bool hasRange () const

Check if parameter has min/max range.