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

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *             Copyright (C) 2000-2002 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 _OSGSWITCH_H_
  40 #define _OSGSWITCH_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGSwitchBase.h"
  46 #include "OSGAction.h"
  47
  48 OSG_BEGIN_NAMESPACE
  49
  50 /*! \ingroup GrpGroupMiscObj
  51     \ingroup GrpLibOSGGroup
  52     \includebasedoc
  53  */
  54
  55 class OSG_GROUP_DLLMAPPING Switch : public SwitchBase
  56 {
  57     /*==========================  PUBLIC  =================================*/
  58
  59   public:
  60
  61     /*---------------------------------------------------------------------*/
  62     /*! \name                       Enum                                   */
  63     /*! \{                                                                 */
  64
  65     enum
  66     {
  67         ALL = -2, NONE = -1
  68     };
  69
  70     /*! \}                                                                 */
  71     /*---------------------------------------------------------------------*/
  72     /*! \name                       Sync                                   */
  73     /*! \{                                                                 */
  74
  75     virtual void changed(ConstFieldMaskArg whichField,
  76                          UInt32            origin,
  77                          BitVector         detail);
  78
  79     /*! \}                                                                 */
  80     /*---------------------------------------------------------------------*/
  81     /*! \name                        Dump                                  */
  82     /*! \{                                                                 */
  83
  84     virtual void dump(      UInt32    uiIndent = 0,
  85                       const BitVector bvFlags  = 0) const;
  86
  87     /*! \}                                                                 */
  88     /*=========================  PROTECTED  ===============================*/
  89
  90   protected:
  91
  92     typedef SwitchBase Inherited;
  93
  94     /*---------------------------------------------------------------------*/
  95     /*! \name                   Constructors                               */
  96     /*! \{                                                                 */
  97
  98     Switch(void);
  99     Switch(const Switch &source);
 100
 101     /*! \}                                                                 */
 102     /*---------------------------------------------------------------------*/
 103     /*! \name                   Destructors                                */
 104     /*! \{                                                                 */
 105
 106     virtual ~Switch(void);
 107
 108     /*! \}                                                                 */
 109     /*---------------------------------------------------------------------*/
 110     /*! \name                   Draw                                       */
 111     /*! \{                                                                 */
 112
 113     Action::ResultE renderEnter(Action *action);
 114     Action::ResultE renderLeave(Action *action);
 115
 116     /*! \}                                                                 */
 117     /*---------------------------------------------------------------------*/
 118     /*! \name                 Intersect                                    */
 119     /*! \{                                                                 */
 120
 121     Action::ResultE intersectEnter(Action *action);
 122
 123     /*! \}                                                                 */
 124     /*==========================  PRIVATE  ================================*/
 125
 126   private:
 127
 128     friend class FieldContainer;
 129     friend class SwitchBase;
 130
 131     /*---------------------------------------------------------------------*/
 132     /*! \name                   Class Specific                             */
 133     /*! \{                                                                 */
 134
 135     static void initMethod(InitPhase ePhase);
 136
 137     /*! \}                                                                 */
 138     /*---------------------------------------------------------------------*/
 139
 140     /*!\brief prohibit default function (move to 'public' if needed) */
 141     void operator =(const Switch &source);
 142 };
 143
 144 typedef Switch              *SwitchP;
 145
 146 OSG_END_NAMESPACE
 147
 148 #include "OSGSwitchBase.inl"
 149 #include "OSGSwitch.inl"
 150
 151 #endif /* _OSGSWITCH_H_ */