/cygdrive/d/src/svn/vrut/trunk/core/src/environment.h File Reference

#include <wx/hashmap.h>
#include <vector>
#include "parameter.h"

Go to the source code of this file.

Namespaces
namespace	VRUT
Classes
class	VRUT::Environment
	Environment for registered parameters management class. More...
Defines
#define	REGISTER_PARAM(paramId, value)
	Register module's parameter with its default value using events.
#define	SET_PARAM(paramId, value)
	Set module's parameter new value using events.
#define	SET_DEFAULT_PARAM(paramId, value)
	Set module's parameter new value and defaut value using events.
#define	IS_PARAM(_evt, _paramID)   Parameter::ParameterIdentificator::FromEvent(_evt) == _paramID
	Compare parameter ID in the event _evt whith _paramID.
#define	UPDATE_PARAM_FROM_EVENT_STRING(paramId, target, event)
#define	UPDATE_PARAM_FROM_EVENT_INT(paramId, target, event)
#define	UPDATE_PARAM_FROM_EVENT_LONG(paramId, target, event)
#define	UPDATE_PARAM_FROM_EVENT_UNSIGNED(paramId, target, event)
#define	UPDATE_PARAM_FROM_EVENT_ID(paramId, target, event)
#define	UPDATE_PARAM_FROM_EVENT_FLOAT(paramId, target, event)
#define	UPDATE_PARAM_FROM_EVENT_BOOL(paramId, target, event)

---

Define Documentation

#define IS_PARAM	(	_evt,
		_paramID		)	Parameter::ParameterIdentificator::FromEvent(_evt) == _paramID

Compare parameter ID in the event _evt whith _paramID.

Definition at line 42 of file environment.h.

#define REGISTER_PARAM	(	paramId,
		value		)

Value:

{ wxCommandEvent paramEvt = Event::GET_EVT_PARAM_REGISTER(paramId, value); \
         PostToKernel(paramEvt); }

Register module's parameter with its default value using events.

Definition at line 22 of file environment.h.

#define SET_DEFAULT_PARAM	(	paramId,
		value		)

Value:

{ wxCommandEvent paramEvt = Event::GET_EVT_PARAM_SET_DO(paramId, value, true); \
         PostToKernel(paramEvt); }

Set module's parameter new value and defaut value using events.

Definition at line 36 of file environment.h.

#define SET_PARAM	(	paramId,
		value		)

Value:

{ wxCommandEvent paramEvt = Event::GET_EVT_PARAM_SET_DO(paramId, value, false); \
         PostToKernel(paramEvt); }

Set module's parameter new value using events.

Definition at line 29 of file environment.h.

#define UPDATE_PARAM_FROM_EVENT_BOOL	(	paramId,
		target,
		event		)

Value:

{ \
              if (IS_PARAM(event, paramId)) \
                     target = isTrue(((wxString *)event.GetClientData())->AfterFirst('=')); \
       }

Check if event is to update given parameter and update it accordingly - bool version Use when processing EVT_PARAM_SET event only

Definition at line 138 of file environment.h.

#define UPDATE_PARAM_FROM_EVENT_FLOAT	(	paramId,
		target,
		event		)

Value:

{ \
              if (IS_PARAM(event, paramId)) \
              { \
                     double val = 0; \
                     if (((wxString *)event.GetClientData())->AfterFirst('=').ToDouble(&val)) \
                            target = float(val); \
                     else \
                            LOGERROR(wxT("<Param>Invalid parameter type")); \
              } \
       }

Check if event is to update given parameter and update it accordingly - float version Use when processing EVT_PARAM_SET event only

Definition at line 122 of file environment.h.

#define UPDATE_PARAM_FROM_EVENT_ID	(	paramId,
		target,
		event		)

Value:

{ \
              if (IS_PARAM(event, paramId)) \
              { \
                     long val = 0; \
                     if (((wxString *)event.GetClientData())->AfterFirst('=').ToLong(&val)) \
                            target = VRUT::_ID(val); \
                     else \
                            LOGERROR(wxT("<Param>Invalid parameter type")); \
              } \
       }

Check if event is to update given parameter and update it accordingly - general ID version Use when processing EVT_PARAM_SET event only

Definition at line 106 of file environment.h.

#define UPDATE_PARAM_FROM_EVENT_INT	(	paramId,
		target,
		event		)

Value:

{ \
              if (IS_PARAM(event, paramId)) \
              { \
                     long val = 0; \
                     if (((wxString *)event.GetClientData())->AfterFirst('=').ToLong(&val)) \
                            target = int(val); \
                     else \
                            LOGERROR(wxT("<Param>Invalid parameter type")); \
              } \
       }

Check if event is to update given parameter and update it accordingly - integer version Use when processing EVT_PARAM_SET event only

Definition at line 58 of file environment.h.

#define UPDATE_PARAM_FROM_EVENT_LONG	(	paramId,
		target,
		event		)

Value:

{ \
              if (IS_PARAM(event, paramId)) \
              { \
                     long val = 0; \
                     if (((wxString *)event.GetClientData())->AfterFirst('=').ToLong(&val)) \
                            target = val; \
                     else \
                            LOGERROR(wxT("<Param>Invalid parameter type")); \
              } \
       }

Check if event is to update given parameter and update it accordingly - long version Use when processing EVT_PARAM_SET event only

Definition at line 74 of file environment.h.

#define UPDATE_PARAM_FROM_EVENT_STRING	(	paramId,
		target,
		event		)

Value:

{ \
              if (IS_PARAM(event, paramId)) \
                     target = ((wxString *)event.GetClientData())->AfterFirst('='); \
       }

Check if event is to update given parameter and update it accordingly - wxString version Use when processing EVT_PARAM_SET event only

Definition at line 48 of file environment.h.

#define UPDATE_PARAM_FROM_EVENT_UNSIGNED	(	paramId,
		target,
		event		)

Value:

{ \
              if (IS_PARAM(event, paramId)) \
              { \
                     long val = 0; \
                     if (((wxString *)event.GetClientData())->AfterFirst('=').ToLong(&val)) \
                            target = unsigned(val); \
                     else \
                            LOGERROR(wxT("<Param>Invalid parameter type")); \
              } \
       }

Check if event is to update given parameter and update it accordingly - unsigned version Use when processing EVT_PARAM_SET event only

Definition at line 90 of file environment.h.