Open Inventor Reference
MeVis/ThirdParty/Sources/Inventor/inventor/lib/database/include/Inventor/events/SoSubEvent.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-94   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  |      This file defines some macros that implement things common to
00048  |      many subclasses of SoEvent. They may be used to make SoEvent
00049  |      subclassing easier. In all of the macros, the "className"
00050  |      parameter refers to the name of the event subclass.
00051  |
00052  |   Defined macros:
00053  |
00054  |      Within class header:
00055  |
00056  |              SO_EVENT_HEADER(className)
00057  |
00058  |      Within class source:
00059  |
00060  |          At file scope:
00061  |
00062  |              SO_EVENT_SOURCE(className)
00063  |
00064  |          Class initialization (initClass):
00065  |
00066  |              SO_EVENT_INIT_CLASS()
00067  |
00068  |
00069  |   Author(s)          : David Mott
00070  |
00071  ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
00072  _______________________________________________________________________
00073  */
00074 
00075 #ifndef  _SO_SUB_EVENT_
00076 #define  _SO_SUB_EVENT_
00077 
00078 #include <Inventor/events/SoEvent.h>
00079 
00080 
00084 
00090 
00096 
00097 #define SO_EVENT_HEADER()                                                     \
00098   public:                                                                     \
00099     static SoType       getClassTypeId()        /* Returns class type id */   \
00100                                     { return classTypeId; }                   \
00101     virtual SoType      getTypeId() const;      /* Returns type id      */    \
00102   private:                                                                    \
00103     static SoType       classTypeId             /* Type id              */
00104 
00105 
00110 
00115 
00116 #define SO__EVENT_VARS(className)                                             \
00117     SoType              className::classTypeId
00118 
00119 
00124 
00125 #define SO__EVENT_METHODS(className)                                          \
00126                                                                               \
00127     SoType                                                                    \
00128     className::getTypeId() const                                              \
00129     {                                                                         \
00130         return classTypeId;                                                   \
00131     }
00132 
00133 
00139 
00140 #define SO_EVENT_SOURCE(className)                                            \
00141     SO__EVENT_VARS(className);                                                \
00142     SO__EVENT_METHODS(className)
00143 
00144 
00152 
00153 #define SO_EVENT_INIT_CLASS(className,parentClass)                            \
00154     classTypeId =                                                             \
00155         SoType::createType(parentClass::getClassTypeId(),                     \
00156                    SO__QUOTE(className))
00157 
00158 
00159 
00160 
00161 #endif /* _SO_SUB_EVENT_ */
00162