MeVis/Foundation/Sources/ML/include/mlFieldSensor.h

Go to the documentation of this file.

// **InsertLicense** code
//------------------------------------------------------------------------------------
//------------------------------------------------------------------------------------
#ifndef __mlFieldSensor_H
#define __mlFieldSensor_H

//ML-includes
#ifndef __mlInitSystemML_H
#include "mlInitSystemML.h"
#endif

ML_START_NAMESPACE

class Field;

//------------------------------------------------------------------------------------
//------------------------------------------------------------------------------------
class MLEXPORT FieldSensor
{

public:

  enum Strength { NO_NOTIFICATION = 0, 
                  NO_CHANGE       = 1, 
                  CHANGED         = 2  
                };                

  FieldSensor(MLSensorCB* callbackFunction, void* userData);

  virtual ~FieldSensor();

  void     callback(Strength notificationStrength=CHANGED);

  void     attachField(Field* field);

  void     detachField();

  Field* getField() const;

  Strength getNotificationStrength() const;

private:
  friend class Field;

  void     attachFieldInternal(Field* field);

  Field*        _attachedField;

  MLSensorCB*   _callbackFunc;

  void*         _userData;

  Strength      _notificationStrength;
};


ML_END_NAMESPACE

#endif // __mlFieldSensor_H