Source/System/NodeCores/Groups/Misc/OSGMultiSwitch.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-2006 by the OpenSG Forum                 *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
  10  *                                                                           *
  11 \*---------------------------------------------------------------------------*/
  12 /*---------------------------------------------------------------------------*\
  13  *                                License                                    *
  14  *                                                                           *
  15  * This library is free software; you can redistribute it and/or modify it   *
  16  * under the terms of the GNU Library General Public License as published    *
  17  * by the Free Software Foundation, version 2.                               *
  18  *                                                                           *
  19  * This library is distributed in the hope that it will be useful, but       *
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  22  * Library General Public License for more details.                          *
  23  *                                                                           *
  24  * You should have received a copy of the GNU Library General Public         *
  25  * License along with this library; if not, write to the Free Software       *
  26  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  27  *                                                                           *
  28 \*---------------------------------------------------------------------------*/
  29 /*---------------------------------------------------------------------------*\
  30  *                                Changes                                    *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35  *                                                                           *
  36  *                                                                           *
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef _OSGMULTISWITCH_H_
  40 #define _OSGMULTISWITCH_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGMultiSwitchBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 /*! \brief MultiSwitch class. See \ref
  50            PageSystemMultiSwitch for a description.
  51     \ingroup GrpGroupMiscObj
  52     \ingroup GrpLibOSGGroup
  53     \includebasedoc
  54  */
  55
  56 class OSG_GROUP_DLLMAPPING MultiSwitch : public MultiSwitchBase
  57 {
  58   protected:
  59
  60     /*==========================  PUBLIC  =================================*/
  61   public:
  62     /*---------------------------------------------------------------------*/
  63     /*! \name                    Types                                     */
  64     /*! \{                                                                 */
  65
  66     typedef MultiSwitchBase Inherited;
  67     typedef MultiSwitch     Self;
  68
  69     /*! \}                                                                 */
  70     /*---------------------------------------------------------------------*/
  71     /*! \name                  Constants                                   */
  72     /*! \{                                                                 */
  73
  74     enum
  75     {
  76         ALL     = -3,
  77         NONE    = -2,
  78         CHOICES = -1
  79     };
  80
  81     void setBitfield(BitVector childMask);
  82
  83     /*! \}                                                                 */
  84     /*---------------------------------------------------------------------*/
  85     /*! \name                      Sync                                    */
  86     /*! \{                                                                 */
  87
  88     virtual void changed(ConstFieldMaskArg whichField,
  89                          UInt32            origin,
  90                          BitVector         details    );
  91
  92     /*! \}                                                                 */
  93     /*---------------------------------------------------------------------*/
  94     /*! \name                     Output                                   */
  95     /*! \{                                                                 */
  96
  97     virtual void dump(      UInt32     uiIndent = 0,
  98                       const BitVector  bvFlags  = 0) const;
  99
 100     /*! \}                                                                 */
 101     /*=========================  PROTECTED  ===============================*/
 102
 103   protected:
 104
 105     // Variables should all be in MultiSwitchBase.
 106
 107     /*---------------------------------------------------------------------*/
 108     /*! \name                  Constructors                                */
 109     /*! \{                                                                 */
 110
 111     MultiSwitch(void);
 112     MultiSwitch(const MultiSwitch &source);
 113
 114     /*! \}                                                                 */
 115     /*---------------------------------------------------------------------*/
 116     /*! \name                   Destructors                                */
 117     /*! \{                                                                 */
 118
 119     virtual ~MultiSwitch(void);
 120
 121     /*! \}                                                                 */
 122     /*---------------------------------------------------------------------*/
 123     /*! \name                   Draw                                       */
 124     /*! \{                                                                 */
 125
 126     Action::ResultE renderEnter(Action *action);
 127     Action::ResultE renderLeave(Action *action);
 128
 129     /*! \}                                                                 */
 130     /*---------------------------------------------------------------------*/
 131     /*! \name                 Intersect                                    */
 132     /*! \{                                                                 */
 133
 134     Action::ResultE intersectEnter(Action *action);
 135
 136     /*! \}                                                                 */
 137     /*---------------------------------------------------------------------*/
 138     /*! \name                      Init                                    */
 139     /*! \{                                                                 */
 140
 141     static void initMethod(InitPhase ePhase);
 142
 143     /*! \}                                                                 */
 144     /*==========================  PRIVATE  ================================*/
 145
 146   private:
 147
 148     friend class FieldContainer;
 149     friend class MultiSwitchBase;
 150
 151     // prohibit default functions (move to 'public' if you need one)
 152     void operator =(const MultiSwitch &source);
 153 };
 154
 155 typedef MultiSwitch *MultiSwitchP;
 156
 157 OSG_END_NAMESPACE
 158
 159 #include "OSGMultiSwitchBase.inl"
 160 #include "OSGMultiSwitch.inl"
 161
 162 #endif /* _OSGMULTISWITCH_H_ */