Open Inventor Reference
MeVis/ThirdParty/Sources/Inventor/inventor/lib/database/include/Inventor/misc/SoNotification.h
Go to the documentation of this file.
00001 /*
00002  *
00003  *  Copyright (C) 2000 Silicon Graphics, Inc.  All Rights Reserved. 
00004  *
00005  *  This library is free software; you can redistribute it and/or
00006  *  modify it under the terms of the GNU Lesser General Public
00007  *  License as published by the Free Software Foundation; either
00008  *  version 2.1 of the License, or (at your option) any later version.
00009  *
00010  *  This library is distributed in the hope that it will be useful,
00011  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00012  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013  *  Lesser General Public License for more details.
00014  *
00015  *  Further, this software is distributed without any warranty that it is
00016  *  free of the rightful claim of any third person regarding infringement
00017  *  or the like.  Any license provided herein, whether implied or
00018  *  otherwise, applies only to this software file.  Patent licenses, if
00019  *  any, provided herein do not apply to combinations of this program with
00020  *  other software, or any other product whatsoever.
00021  * 
00022  *  You should have received a copy of the GNU Lesser General Public
00023  *  License along with this library; if not, write to the Free Software
00024  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00025  *
00026  *  Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
00027  *  Mountain View, CA  94043, or:
00028  * 
00029  *  http://www.sgi.com 
00030  * 
00031  *  For further information regarding this notice, see: 
00032  * 
00033  *  http://oss.sgi.com/projects/GenInfo/NoticeExplan/
00034  *
00035  */
00036 
00037 
00038 /*
00039  * Copyright (C) 1990,91,92   Silicon Graphics, Inc.
00040  *
00041  _______________________________________________________________________
00042  ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
00043  |
00044  |   $Revision: 1.1.1.1 $
00045  |
00046  |   Description:
00047  |      Definition of (internal) SoNotRec and SoNotList classes, which
00048  |      handle notification propagation through instances of classes
00049  |      derived from SoBase.
00050  |
00051  |   Author(s)          : Paul S. Strauss, Nick Thompson
00052  |
00053  ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
00054  _______________________________________________________________________
00055  */
00056 
00057 #ifndef  _SO_NOTIFICATION_
00058 #define  _SO_NOTIFICATION_
00059 
00060 #include <Inventor/SbBasic.h>
00061 
00062 class SoBase;
00063 class SoField;
00064 
00096 
00097 SoINTERNAL class INVENTOR_API SoNotRec {
00098 
00099   public:
00100 
00106     enum Type {
00107         CONTAINER,              
00108         PARENT,                 
00109         SENSOR,                 
00110         FIELD,                  
00111         ENGINE                  
00112     };
00113 
00115     SoNotRec(SoBase *b)                 { base = b; }
00116 
00118     void                setType(SoNotRec::Type t)       { type = t;     }
00119 
00121     SoBase *            getBase() const                 { return base;  }
00122     SoNotRec::Type      getType() const                 { return type;  }
00123     const SoNotRec *    getPrevious() const             { return previous; }
00124 
00126     void                setPrevious(SoNotRec *prev)     { previous = prev; }
00127 
00129     void                print(FILE *fp) const;
00130 
00131   private:
00132 
00133     SoBase              *base;          
00134     Type                type;           
00135     const SoNotRec      *previous;      
00136 };
00137 
00152 
00153 SoINTERNAL class SoNotList {
00154 
00155   public:
00157     SoNotList();
00158 
00160     SoNotList(const SoNotList *copyFrom)                { *this = *copyFrom; }
00161 
00163     void                append(SoNotRec *rec);
00164 
00167     void                append(SoNotRec *rec, SoField *field);
00168 
00170     void                setLastType(SoNotRec::Type t)
00171         {
00172             last->setType(t);
00175             if (t == SoNotRec::FIELD || t == SoNotRec::ENGINE)
00176                 firstAtNode = NULL;
00177         }
00178 
00180     SoNotRec *          getFirstRec() const             { return first; }
00181     SoNotRec *          getLastRec() const              { return last;  }
00182 
00187     SoNotRec *          getFirstRecAtNode() const       { return firstAtNode; }
00188 
00191     SoField *           getLastField() const            { return lastField; }
00192 
00195     uint32_t            getTimeStamp() const            { return timeStamp; }
00196 
00198     void                print(FILE *fp) const;
00199 
00200   private:
00201     SoNotRec            *first, *last;  
00202     SoNotRec            *firstAtNode;   
00203     SoField             *lastField;     
00204     uint32_t            timeStamp;      
00205 };
00206 
00207 #endif /* _SO_NOTIFICATION_ */