UserVariable

Fields

`UVAR_TYPE`	`_type`
`UVAR_WIDGET`	`_widget`
bool	`_b`
char	`_c`
short	`_s`
int	`_i`
float	`_f`
double	`_d`
union RFK::UserVariable::@0	`[anonymous]`
char	`_cmin`
short	`_smin`
int	`_imin`
float	`_fmin`
double	`_dmin`
union RFK::UserVariable::@2	`[anonymous]`
char	`_cmax`
short	`_smax`
int	`_imax`
float	`_fmax`
double	`_dmax`
union RFK::UserVariable::@4	`[anonymous]`
char	`_cstep`
short	`_sstep`
int	`_istep`
float	`_fstep`
double	`_dstep`
union RFK::UserVariable::@6	`[anonymous]`
String	`_string`
Vector < String >	`_list`
int	`_list_current_index`
String	`_file_extensions`
String	`_name`

Functions

UserVariable

Detailed Description

class UserVariable : public RED::Object 

Describes a user variable.

@related class RFK::TutorialApplication

A user variable is added to a vector of variables that is set using RFK::TutorialApplication::SetUserVariables. A user variable can be then modified, thus generating a RFK::EVT_UVAR event, to which a callback can be associated.

A user variable has a _type and a _name to identify it. Depending on the variable type, the minimal value of the variable, its maximal value and modification steps must be supplied. Thus a floating point value should fill _fmin, _fmax, _fstep and _f for the actual variable value.

If the variable is set for viewing only, then _widget should be set to RFK::UVW_VIEW.

Public Functions

inline UserVariable(): Default construction method.

Public Members

UVAR_TYPE _type: Type of the user variable.

UVAR_WIDGET _widget: Edition widget of the variable (can be a slider or a numerical input for instance).

bool _b: Value of the variable.

char _c: Value of the variable.

short _s: Value of the variable.

int _i: Value of the variable.

float _f: Value of the variable.

double _d: Value of the variable.

union RFK::UserVariable::[anonymous] [anonymous]

char _cmin: Minimal value of the variable.

short _smin: Minimal value of the variable.

int _imin: Minimal value of the variable.

float _fmin: Minimal value of the variable.

double _dmin: Minimal value of the variable.

union RFK::UserVariable::[anonymous] [anonymous]

char _cmax: Maximal value of the variable.

short _smax: Maximal value of the variable.

int _imax: Maximal value of the variable.

float _fmax: Maximal value of the variable.

double _dmax: Maximal value of the variable.

union RFK::UserVariable::[anonymous] [anonymous]

char _cstep: Edition step of the variable.

short _sstep: Edition step of the variable.

int _istep: Edition step of the variable.

float _fstep: Edition step of the variable.

double _dstep: Edition step of the variable.

union RFK::UserVariable::[anonymous] [anonymous]

RED::String _string: String for the UVT_STRING and UVT_FILE variable.

RED::Vector<RED::String> _list: Strings list for a UVT_LIST variable.

int _list_current_index: Currently selected string in the list for a UVT_LIST variable.

RED::String _file_extensions

RED::String _name: Name of the user variable.