SoNotification.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:
 |      Definition of (internal) SoNotRec and SoNotList classes, which
 |      handle notification propagation through instances of classes
 |      derived from SoBase.
 |
 |   Author(s)          : Paul S. Strauss, Nick Thompson
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */
 
#ifndef  _SO_NOTIFICATION_
#define  _SO_NOTIFICATION_
 
#include <Inventor/SbBasic.h>
 
class SoBase;
class SoField;

 
SoINTERNAL class INVENTOR_API SoNotRec {
 
  public:

    enum Type {
        CONTAINER,              
        PARENT,                 
        SENSOR,                 
        FIELD,                  
        ENGINE                  
    };

    SoNotRec(SoBase *b)                 { base = b; }

    void                setType(SoNotRec::Type t)       { type = t;     }

    SoBase *            getBase() const                 { return base;  }
    SoNotRec::Type      getType() const                 { return type;  }
    const SoNotRec *    getPrevious() const             { return previous; }

    void                setPrevious(SoNotRec *prev)     { previous = prev; }

    void                print(FILE *fp) const;
 
  private:
 
    SoBase              *base;          
    Type                type;           
    const SoNotRec      *previous;      
};

 
SoINTERNAL class SoNotList {
 
  public:
    SoNotList();

    SoNotList(const SoNotList *copyFrom)                { *this = *copyFrom; }

    void                append(SoNotRec *rec);

    void                append(SoNotRec *rec, SoField *field);

    void                setLastType(SoNotRec::Type t)
        {
            last->setType(t);
            if (t == SoNotRec::FIELD || t == SoNotRec::ENGINE)
                firstAtNode = NULL;
        }

    SoNotRec *          getFirstRec() const             { return first; }
    SoNotRec *          getLastRec() const              { return last;  }

    SoNotRec *          getFirstRecAtNode() const       { return firstAtNode; }

    SoField *           getLastField() const            { return lastField; }

    SbNodeIdType            getTimeStamp() const            { return timeStamp; }

    void                print(FILE *fp) const;
 
  private:
    SoNotRec            *first, *last;  
    SoNotRec            *firstAtNode;   
    SoField             *lastField;     
    SbNodeIdType          timeStamp;      
};
 
#endif /* _SO_NOTIFICATION_ */