SoDataSensor.h

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : Nick Thompson (MMM yyyy)
** Modified by : Gavin Bell (MMM yyyy)
** Modified by : Paul Strauss (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** 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-2023 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_DATA_SENSOR_
#define  _SO_DATA_SENSOR_
 
class SoBase;
class SoNode;
class SoPath;
class SoNotList;
 
#include <Inventor/sensors/SoDelayQueueSensor.h>
#include <Inventor/threads/SbThreadStorage.h>
#include <Inventor/threads/SbThreadSpinlock.h>
#include <Inventor/STL/list>
 
#ifdef _WIN32
#pragma warning(push)
#pragma warning(disable:4251)
#endif
 
class  SoDataSensor : public SoDelayQueueSensor {
 
 public:
  enum ChangeType {
    UNSPECIFIED,
    GROUP_ADD_CHILD,
    GROUP_INSERT_CHILD,
    GROUP_REPLACE_CHILD,
    GROUP_REMOVE_CHILD,
    GROUP_REMOVE_ALL_CHILDREN,
    FIELD_MULTIVALUE
  };
 
  SoDataSensor();
  SoDataSensor(SoSensorCB *func, void *data);
 
  // Destructor
#ifndef HIDDEN_FROM_DOC
  virtual ~SoDataSensor();
#endif // HIDDEN_FROM_DOC
 
  void                setDeleteCallback(SoSensorCB *f, void *data = NULL)
    { deleteFunc = f; deleteData = data; }
 
  SoNode *            getTriggerNode() const;
 
  SoField *           getTriggerField() const;
    
  SoPath *            getTriggerPath() const;
 
  void setTriggerPathFlag(SbBool flag)
  { doTrigPath = flag; }
 
  void setTriggerFastEditInfoFlag(SbBool flag)
  { doTrigFastEditInfo = flag; }
 
  SbBool getTriggerPathFlag() const
  { return doTrigPath; }
 
  SbBool getTriggerFastEditInfoFlag() const
  { return doTrigFastEditInfo; }
 
  ChangeType getTriggerType() const;
 
  SoNode* getTriggerChild() const;
 
  int getTriggerChildIndex() const;
 
  int getTriggerMFieldStartIndex() const;
 
  int getTriggerMFieldNumValues() const;
 
  int getTriggerFastEditInfo() const;
 
  // Override unschedule() to reset trigNode and trigPath.
  virtual void unschedule();
 
 private:
  // Override trigger to reset trigNode and trigPath, if
  // necessary.
  virtual void trigger();
 
  // Propagates modification notification through an instance. By
  // default, this schedules the sensor to be triggered and saves
  // some information from the notification list for use by the
  // callback function.  Called by SoBase.
  virtual void        notify(SoNotList *list);
 
  // This is called when the base (path, field, node, whatever) is
  // deleted. All subclasses must implement this to do the right
  // thing.
  virtual void        dyingReference() = 0;
 
  // delete the list of dataSensor in the pending list
  static void clearPendingDeleteList();
 
  // add an SoDataSensor to the pending delete list
  static void addToPendingDeleteList(SoDataSensor* dataSensor);
 
 private:
  // Invokes the delete callback
  void                invokeDeleteCallback();
 
 private:
   SoSensorCB* deleteFunc;    // CB and data for when attached SoBase
   void* deleteData;    // is about to be deleted
 
   class SoDataSensorData
   {
   public:
     SoDataSensorData()
     {
       reset();
     }
     void reset()
     {
       trigNode   = NULL;
       trigField  = NULL;
       trigPath   = NULL;
 
       trigChildIndex = -1;
       trigChild = NULL;
       trigMFieldStartIndex = -1;
       trigMFieldNumValues = -1;
       m_flag.trigChangeType = UNSPECIFIED;
       m_flag.trigFromFastEdit = 0;
     }
     // usefull for debug
     bool isEmpty() const
     {
       return (trigNode==NULL) && (trigField==NULL) && (trigPath==NULL) && (m_flag.trigChangeType==UNSPECIFIED);
     }
 
     void setTriggerType(ChangeType changeType)
     {
       //assert(changeType< (1<<31));
       m_flag.trigChangeType = changeType;
     }
 
     ChangeType getTriggerType() const
     { return (ChangeType)(m_flag.trigChangeType); }
 
     void setTriggerFromFastEdit(bool flag)
     { m_flag.trigFromFastEdit = flag; }
 
     bool isTriggerFromFastEdit() const
     { return m_flag.trigFromFastEdit; }
 
   public:
     // members
     SoNode* trigNode;      // Node that triggered sensor
     SoField* trigField;    // Field that triggered sensor
     SoPath* trigPath;      // Path to trigNode
     SoNode* trigChild;        // changed child (if parent is SoGroup)
     int trigChildIndex;       // index of changed child in group (if parent is SoGroup)
     int trigMFieldStartIndex; // index of the first value which change in the MField
     int trigMFieldNumValues;  // num of values which change in the MField
  private:
     struct {
        unsigned int trigChangeType   : 31;
        unsigned int trigFromFastEdit : 1;
     } m_flag;
   };
 
   // Store the current notification info (common to all threads)
   // Doing multiple notification before trigger is managed will result in only the last 
   // notification to be triggered
   // any access read/write to this member should be lock/unlock protected.
   // as we cannot lock/unlock the trigger() method which use this member in readMode,
   // we copy m_notifyData in m_triggerNotifyData (with a specific lock) in order to keep
   // trigger call safe.
   SoDataSensorData m_notifyData;
 
   SoDataSensorData m_triggerNotifyData;
   SbThreadSpinlock m_triggerNotifyDataMutex;
 
  bool doTrigPath;          // Whether to compute trigger path
  bool doTrigFastEditInfo;  // Whether to compute fastEditInfo
 
  // manage pending delete list
  static SbThreadSpinlock s_pendingDeleteListMutex;
  static std::list<SoDataSensor*> s_pendingDeleteList;
 
};
 
#ifdef _WIN32
#pragma warning(pop)
#endif
 
#endif  /* _SO_DATA_SENSOR_ */