Source/Base/FieldContainer/Attachments/OSGGlobalsAttachment.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 _OSGGLOBALSATTACHMENT_H_
  40 #define _OSGGLOBALSATTACHMENT_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGGlobalsAttachmentBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 /*! \brief GlobalsAttachment class. See \ref
  50            PageBaseGlobalsAttachment for a description.
  51
  52     \ingroup GrpBaseFieldContainerAttachments
  53     \ingroup GrpLibOSGBase
  54     \includebasedoc
  55  */
  56
  57 class OSG_BASE_DLLMAPPING GlobalsAttachment : public GlobalsAttachmentBase
  58 {
  59   protected:
  60
  61     /*==========================  PUBLIC  =================================*/
  62
  63   public:
  64
  65     typedef GlobalsAttachmentBase Inherited;
  66     typedef GlobalsAttachment     Self;
  67
  68     /*---------------------------------------------------------------------*/
  69     /*! \name                      Sync                                    */
  70     /*! \{                                                                 */
  71
  72     virtual void changed(ConstFieldMaskArg whichField,
  73                          UInt32            origin,
  74                          BitVector         details    );
  75
  76     /*! \}                                                                 */
  77     /*---------------------------------------------------------------------*/
  78     /*! \name                     Output                                   */
  79     /*! \{                                                                 */
  80
  81     virtual void dump(      UInt32     uiIndent = 0,
  82                       const BitVector  bvFlags  = 0) const;
  83
  84     /*! \}                                                                 */
  85     /*=========================  PROTECTED  ===============================*/
  86
  87   protected:
  88
  89     // Variables should all be in GlobalsAttachmentBase.
  90
  91     /*---------------------------------------------------------------------*/
  92     /*! \name                  Constructors                                */
  93     /*! \{                                                                 */
  94
  95     GlobalsAttachment(void);
  96     GlobalsAttachment(const GlobalsAttachment &source);
  97
  98     /*! \}                                                                 */
  99     /*---------------------------------------------------------------------*/
 100     /*! \name                   Destructors                                */
 101     /*! \{                                                                 */
 102
 103     virtual ~GlobalsAttachment(void);
 104
 105     /*! \}                                                                 */
 106     /*---------------------------------------------------------------------*/
 107     /*! \name                      Init                                    */
 108     /*! \{                                                                 */
 109
 110     static void initMethod(InitPhase ePhase);
 111
 112     /*! \}                                                                 */
 113     /*==========================  PRIVATE  ================================*/
 114
 115   private:
 116
 117     friend class FieldContainer;
 118     friend class GlobalsAttachmentBase;
 119
 120     // prohibit default functions (move to 'public' if you need one)
 121     void operator =(const GlobalsAttachment &source);
 122 };
 123
 124 typedef GlobalsAttachment *GlobalsAttachmentP;
 125
 126 OSG_END_NAMESPACE
 127
 128 #include "OSGGlobalsAttachmentBase.inl"
 129 #include "OSGGlobalsAttachment.inl"
 130
 131 #endif /* _OSGGLOBALSATTACHMENT_H_ */