Source/System/NodeCores/Groups/Misc/OSGVisitSubTree.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 _OSGVISITSUBTREE_H_
  40 #define _OSGVISITSUBTREE_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGVisitSubTreeBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 /*! VisitSubTree
  50     \ingroup GrpGroupMiscObj
  51     \ingroup GrpLibOSGGroup
  52     \includebasedoc
  53  */
  54
  55 class OSG_GROUP_DLLMAPPING VisitSubTree : public VisitSubTreeBase
  56 {
  57     /*==========================  PUBLIC  =================================*/
  58
  59   public:
  60
  61     enum TravMaskMode
  62     {
  63         AndTravMask     = 0x0001,
  64         OrTravMask      = 0x0002,
  65         ReplaceTravMask = 0x0003
  66     };
  67
  68     /*---------------------------------------------------------------------*/
  69     /*! \name                       Sync                                   */
  70     /*! \{                                                                 */
  71
  72     virtual void changed(ConstFieldMaskArg whichField,
  73                          UInt32            origin,
  74                          BitVector         detail);
  75
  76     /*! \}                                                                 */
  77     /*---------------------------------------------------------------------*/
  78     /*! \name                        Dump                                  */
  79     /*! \{                                                                 */
  80
  81     void  setSubTreeRoot(Node * const value);
  82     Node *getSubTreeRoot(void              ) const;
  83
  84     /*! \}                                                                 */
  85     /*---------------------------------------------------------------------*/
  86     /*! \name                        Dump                                  */
  87     /*! \{                                                                 */
  88
  89     virtual void dump(      UInt32    uiIndent = 0,
  90                       const BitVector bvFlags  = 0) const;
  91
  92     /*! \}                                                                 */
  93     /*=========================  PROTECTED  ===============================*/
  94
  95   protected:
  96
  97     typedef VisitSubTreeBase Inherited;
  98
  99     /*---------------------------------------------------------------------*/
 100     /*! \name                   Constructors                               */
 101     /*! \{                                                                 */
 102
 103     VisitSubTree(void);
 104     VisitSubTree(const VisitSubTree &source);
 105
 106     /*! \}                                                                 */
 107     /*---------------------------------------------------------------------*/
 108     /*! \name                   Destructors                                */
 109     /*! \{                                                                 */
 110
 111     virtual ~VisitSubTree(void);
 112
 113     /*! \}                                                                 */
 114     /*---------------------------------------------------------------------*/
 115     /*! \name                   Draw                                       */
 116     /*! \{                                                                 */
 117
 118     Action::ResultE renderEnter(Action *action);
 119     Action::ResultE renderLeave(Action *action);
 120
 121     /*! \}                                                                 */
 122     /*---------------------------------------------------------------------*/
 123     /*! \name                   Intersect                                  */
 124     /*! \{                                                                 */
 125
 126     Action::ResultE intersectEnter(Action *action);
 127
 128     /*! \}                                                                 */
 129     /*---------------------------------------------------------------------*/
 130     /*! \name                      Init                                    */
 131     /*! \{                                                                 */
 132
 133     static void initMethod(InitPhase ePhase);
 134
 135     /*! \}                                                                 */
 136     /*---------------------------------------------------------------------*/
 137     /*! \name                      NodeCore Specific                       */
 138     /*! \{                                                                 */
 139
 140     void adjustVolume(Volume            &volume    );
 141
 142     void rootChanged (FieldContainer    *pFC,
 143                       ConstFieldMaskArg  whichField,
 144                       UInt32             origin    );
 145
 146     /*! \}                                                                 */
 147     /*==========================  PRIVATE  ================================*/
 148
 149   private:
 150
 151     friend class FieldContainer;
 152     friend class VisitSubTreeBase;
 153
 154     /*---------------------------------------------------------------------*/
 155     /*! \name                   thread local                               */
 156     /*! \{                                                                 */
 157
 158     /*! \}                                                                 */
 159     /*---------------------------------------------------------------------*/
 160     /*! \name                    load thread                               */
 161     /*! \{                                                                 */
 162
 163     /*! \}                                                                 */
 164     /*---------------------------------------------------------------------*/
 165
 166     /*!\brief prohibit default function (move to 'public' if needed) */
 167     void operator =(const VisitSubTree &source);
 168 };
 169
 170 typedef VisitSubTree              *VisitSubTreeP;
 171
 172 OSG_END_NAMESPACE
 173
 174 #include "OSGVisitSubTreeBase.inl"
 175 #include "OSGVisitSubTree.inl"
 176
 177 #endif /* _OSGVISITSUBTREE_H_ */