Source/System/NodeCores/Groups/Base/OSGGroup.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 _OSGGROUP_H_
  40 #define _OSGGROUP_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGConfig.h"
  46 #include "OSGGroupBase.h"
  47 #include "OSGAction.h"
  48
  49 OSG_BEGIN_NAMESPACE
  50
  51 /*! \brief Group is the basic NodeCore for inner nodes in the tree.
  52     \ingroup GrpSystemNodeCoreGroupsCores
  53     \ingroup GrpLibOSGSystem
  54     \includebasedoc
  55  */
  56
  57 class OSG_SYSTEM_DLLMAPPING Group : public GroupBase
  58 {
  59     /*==========================  PUBLIC  =================================*/
  60
  61   public:
  62
  63     /*---------------------------------------------------------------------*/
  64     /*! \name                       Sync                                   */
  65     /*! \{                                                                 */
  66
  67     virtual void changed(ConstFieldMaskArg whichField,
  68                          UInt32            origin,
  69                          BitVector         detail);
  70
  71     /*! \}                                                                 */
  72     /*---------------------------------------------------------------------*/
  73     /*! \name                        Dump                                  */
  74     /*! \{                                                                 */
  75
  76     virtual void dump(      UInt32    uiIndent = 0,
  77                       const BitVector bvFlags  = 0) const;
  78
  79     /*! \}                                                                 */
  80     /*=========================  PROTECTED  ===============================*/
  81
  82   protected:
  83
  84     typedef GroupBase Inherited;
  85
  86     /*---------------------------------------------------------------------*/
  87     /*! \name                   Constructors                               */
  88     /*! \{                                                                 */
  89
  90     Group(void);
  91     Group(const Group &source);
  92
  93     /*! \}                                                                 */
  94     /*---------------------------------------------------------------------*/
  95     /*! \name                   Destructors                                */
  96     /*! \{                                                                 */
  97
  98     virtual ~Group(void);
  99
 100     /*! \}                                                                 */
 101     /*---------------------------------------------------------------------*/
 102     /*! \name                        Init                                  */
 103     /*! \{                                                                 */
 104
 105     static void initMethod(InitPhase ePhase);
 106
 107     /*! \}                                                                 */
 108     /*---------------------------------------------------------------------*/
 109     /*! \name                       Action Callbacks                       */
 110     /*! \{                                                                 */
 111
 112     Action::ResultE renderEnter   (Action *action);
 113     Action::ResultE renderLeave   (Action *action);
 114
 115     Action::ResultE intersectEnter(Action *action);
 116
 117     /*! \}                                                                 */
 118     /*==========================  PRIVATE  ================================*/
 119
 120   private:
 121
 122     friend class FieldContainer;
 123     friend class GroupBase;
 124
 125     /*---------------------------------------------------------------------*/
 126
 127     /*!\brief prohibit default function (move to 'public' if needed) */
 128     void operator =(const Group &source);
 129 };
 130
 131 typedef Group *GroupP;
 132
 133 OSG_END_NAMESPACE
 134
 135 #include "OSGGroupBase.inl"
 136 #include "OSGGroup.inl"
 137
 138 #endif /* _OSGGROUP_H_ */