SoDataSensor.h

Go to the documentation of this file.

/*
 *
 *  Copyright (C) 2000 Silicon Graphics, Inc.  All Rights Reserved. 
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  Further, this software is distributed without any warranty that it is
 *  free of the rightful claim of any third person regarding infringement
 *  or the like.  Any license provided herein, whether implied or
 *  otherwise, applies only to this software file.  Patent licenses, if
 *  any, provided herein do not apply to combinations of this program with
 *  other software, or any other product whatsoever.
 * 
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
 *  Mountain View, CA  94043, or:
 * 
 *  http://www.sgi.com 
 * 
 *  For further information regarding this notice, see: 
 * 
 *  http://oss.sgi.com/projects/GenInfo/NoticeExplan/
 *
 */
 
 
/*
 * Copyright (C) 1990,91,92   Silicon Graphics, Inc.
 *
 _______________________________________________________________________
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 |
 |   $Revision: 1.1.1.1 $
 |
 |   Description:
 |      Abstract base class for sensors that attach to some part of a
 |      scene graph and detect changes to it. A data sensor is scheduled
 |      when a change is made to the thing to which it is attached. This
 |      change is detected via the notification mechanism.
 |
 |   Author(s)          : Nick Thompson, Gavin Bell, Paul Strauss
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */
 
#ifndef  _SO_DATA_SENSOR_
#define  _SO_DATA_SENSOR_
 
class SoBase;
class SoNode;
class SoPath;
class SoNotList;
 
#include <Inventor/sensors/SoDelayQueueSensor.h>


 
class INVENTOR_API SoDataSensor : public SoDelayQueueSensor {
 
  public:
    SoDataSensor();
    SoDataSensor(SoSensorCB *func, void *data);

    virtual ~SoDataSensor();

    void                setDeleteCallback(SoSensorCB *f, void *data = NULL)
        { deleteFunc = f; deleteData = data; }

    SoNode *            getTriggerNode() const;

    SoField *           getTriggerField() const;
    
    SoPath *            getTriggerPath() const;

    void                setTriggerPathFlag(bool flag) { doTrigPath = flag; }
    bool                getTriggerPathFlag() const      { return doTrigPath; }

    virtual void unschedule();
 
  SoINTERNAL public:
    virtual void trigger();

    virtual void        notify(SoNotList *list);

    virtual void        dyingReference() = 0;
 
  protected:
    void                invokeDeleteCallback();
 
  private:
    SoSensorCB          *deleteFunc;    
    void                *deleteData;    
    SoNode              *trigNode;      
    SoField             *trigField;     
    SoPath              *trigPath;      
    bool                doTrigPath;     
};
 
#endif  /* _SO_DATA_SENSOR_ */