class RFK::UserVariable

Describes a user variable. More...

#include <RFKTutorialApplication.h>

Inherits: Object.

Public functions:

UserVariable ( )

Public variables:

bool	_b
char	_c
char	_cmax
char	_cmin
char	_cstep
double	_d
double	_dmax
double	_dmin
double	_dstep
float	_f
RED::String	_file_extensions
float	_fmax
float	_fmin
float	_fstep
int	_i
int	_imax
int	_imin
int	_istep
RED::Vector< RED::String >	_list
int	_list_current_index
RED::String	_name
short	_s
short	_smax
short	_smin
short	_sstep
RED::String	_string
UVAR_TYPE	_type
UVAR_WIDGET	_widget

Detailed description:

Describes a user variable.

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.

Functions documentation

public RFK::UserVariable::UserVariable

(

)

Default construction method.

Variables documentation

public bool RFK::UserVariable::_b

Value of the variable.

public char RFK::UserVariable::_c

Value of the variable.

public char RFK::UserVariable::_cmax

Maximal value of the variable.

public char RFK::UserVariable::_cmin

Minimal value of the variable.

public char RFK::UserVariable::_cstep

Edition step of the variable.

public double RFK::UserVariable::_d

Value of the variable.

public double RFK::UserVariable::_dmax

Maximal value of the variable.

public double RFK::UserVariable::_dmin

Minimal value of the variable.

public double RFK::UserVariable::_dstep

Edition step of the variable.

public float RFK::UserVariable::_f

Value of the variable.

public RED::String RFK::UserVariable::_file_extensions

public float RFK::UserVariable::_fmax

Maximal value of the variable.

public float RFK::UserVariable::_fmin

Minimal value of the variable.

public float RFK::UserVariable::_fstep

Edition step of the variable.

public int RFK::UserVariable::_i

Value of the variable.

public int RFK::UserVariable::_imax

Maximal value of the variable.

public int RFK::UserVariable::_imin

Minimal value of the variable.

public int RFK::UserVariable::_istep

Edition step of the variable.

public RED::Vector< RED::String > RFK::UserVariable::_list

Strings list for a UVT_LIST variable.

public int RFK::UserVariable::_list_current_index

Currently selected string in the list for a UVT_LIST variable.

public RED::String RFK::UserVariable::_name

Name of the user variable.

public short RFK::UserVariable::_s

Value of the variable.

public short RFK::UserVariable::_smax

Maximal value of the variable.

public short RFK::UserVariable::_smin

Minimal value of the variable.

public short RFK::UserVariable::_sstep

Edition step of the variable.

public RED::String RFK::UserVariable::_string

String for the UVT_STRING and UVT_FILE variable.

public UVAR_TYPE RFK::UserVariable::_type

Type of the user variable.

public UVAR_WIDGET RFK::UserVariable::_widget

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