SoListSensor.h

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : Nicolas DAGUISE (Aug 2007)
**=======================================================================*/
 
 
#ifndef  _SO_LIST_SENSOR_
#define  _SO_LIST_SENSOR_
 
class SoBaseList;
class SoNotList;
 
#include <Inventor/sensors/SoSensor.h>
 
class  SoListSensor : public SoSensor
{
 public:
  enum ChangeType
  {
    UNSPECIFIED,
    APPEND,
    INSERT,
    SET,
    REMOVE,
    TRUNCATE,
    COPY,
    TOUCH
  };
 
  SoListSensor();
 
  SoListSensor(SoSensorCB* func, void* data);
 
  virtual ~SoListSensor();
 
  void attach(SoBaseList* list);
 
  void detach();
 
  SoBaseList* getAttachedList() const { return m_list; }
 
  void setDeleteCallback( SoSensorCB *f, void *data = NULL )
  {
    m_deleteFunc = f;
    m_deleteData = data;
  }
 
  ChangeType getTriggerType() const;
 
  int getTriggerIndex() const;
 
 private:
 
  // Override trigger to reset trigNode and trigPath, if
  // necessary.
  virtual void trigger();
 
  // Called by the attached list when it is about to be deleted
  virtual void dyingReference();
 
    // Schedules the sensor for triggering at the appropriate time
  virtual void schedule() {};
 
  // Unschedules sensor to keep it from being triggered
  virtual void unschedule() {};
 
  // This returns TRUE if this sensor should precede sensor s in
  // whichever queue this sensor would be in.
  virtual SbBool isBefore(const SoSensor*) const { return false; }
 
 private:
  // Invokes the delete callback
  void invokeDeleteCallback();
 
 private:
 
  SoSensorCB *m_deleteFunc;    // CB and data for when attached
  void *m_deleteData;          // is about to be deleted
  ChangeType m_trigType;
  int m_trigIndex;
  SoBaseList* m_list;
};
 
#endif  // _SO_LIST_SENSOR_