Source/Contrib/ComplexSceneManager/Helper/OSGCSMStatisticsForegroundBase.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-2013 by the OpenSG Forum                 *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  * contact: dirk@opensg.org, gerrit.voss@vossg.org, carsten_neumann@gmx.net  *
  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 /*****************************************************************************\
  40  *****************************************************************************
  41  **                                                                         **
  42  **                  This file is automatically generated.                  **
  43  **                                                                         **
  44  **          Any changes made to this file WILL be lost when it is          **
  45  **           regenerated, which can become necessary at any time.          **
  46  **                                                                         **
  47  **     Do not change this file, changes should be done in the derived      **
  48  **     class CSMStatisticsForeground
  49  **                                                                         **
  50  *****************************************************************************
  51 \*****************************************************************************/
  52
  53
  54 #ifndef _OSGCSMSTATISTICSFOREGROUNDBASE_H_
  55 #define _OSGCSMSTATISTICSFOREGROUNDBASE_H_
  56 #ifdef __sgi
  57 #pragma once
  58 #endif
  59
  60
  61 #include "OSGConfig.h"
  62 #include "OSGContribCSMDef.h"
  63
  64 //#include "OSGBaseTypes.h"
  65
  66 #include "OSGForeground.h" // Parent
  67
  68 #include "OSGSysFields.h"               // Size type
  69 #include "OSGBaseFields.h"              // Color type
  70
  71 #include "OSGCSMStatisticsForegroundFields.h"
  72
  73 OSG_BEGIN_NAMESPACE
  74
  75
  76 class CSMStatisticsForeground;
  77
  78 //! \brief CSMStatisticsForeground Base Class.
  79
  80 class OSG_CONTRIBCSM_DLLMAPPING CSMStatisticsForegroundBase : public Foreground
  81 {
  82   public:
  83
  84     typedef Foreground Inherited;
  85     typedef Foreground ParentContainer;
  86
  87     typedef Inherited::TypeObject TypeObject;
  88     typedef TypeObject::InitPhase InitPhase;
  89
  90     OSG_GEN_INTERNALPTR(CSMStatisticsForeground);
  91
  92     /*==========================  PUBLIC  =================================*/
  93
  94   public:
  95
  96     enum
  97     {
  98         SizeFieldId = Inherited::NextFieldId,
  99         ColorFieldId = SizeFieldId + 1,
 100         BgColorFieldId = ColorFieldId + 1,
 101         ElementsFieldId = BgColorFieldId + 1,
 102         NextFieldId = ElementsFieldId + 1
 103     };
 104
 105     static const OSG::BitVector SizeFieldMask =
 106         (TypeTraits<BitVector>::One << SizeFieldId);
 107     static const OSG::BitVector ColorFieldMask =
 108         (TypeTraits<BitVector>::One << ColorFieldId);
 109     static const OSG::BitVector BgColorFieldMask =
 110         (TypeTraits<BitVector>::One << BgColorFieldId);
 111     static const OSG::BitVector ElementsFieldMask =
 112         (TypeTraits<BitVector>::One << ElementsFieldId);
 113     static const OSG::BitVector NextFieldMask =
 114         (TypeTraits<BitVector>::One << NextFieldId);
 115
 116     typedef SFUInt32          SFSizeType;
 117     typedef SFColor4f         SFColorType;
 118     typedef SFColor4f         SFBgColorType;
 119     typedef MFString          MFElementsType;
 120
 121     /*---------------------------------------------------------------------*/
 122     /*! \name                    Class Get                                 */
 123     /*! \{                                                                 */
 124
 125     static FieldContainerType &getClassType   (void);
 126     static UInt32              getClassTypeId (void);
 127     static UInt16              getClassGroupId(void);
 128
 129     /*! \}                                                                 */
 130     /*---------------------------------------------------------------------*/
 131     /*! \name                FieldContainer Get                            */
 132     /*! \{                                                                 */
 133
 134     virtual       FieldContainerType &getType         (void);
 135     virtual const FieldContainerType &getType         (void) const;
 136
 137     virtual       UInt32              getContainerSize(void) const;
 138
 139     /*! \}                                                                 */
 140     /*---------------------------------------------------------------------*/
 141     /*! \name                    Field Get                                 */
 142     /*! \{                                                                 */
 143
 144
 145                   SFUInt32            *editSFSize           (void);
 146             const SFUInt32            *getSFSize            (void) const;
 147
 148                   SFColor4f           *editSFColor          (void);
 149             const SFColor4f           *getSFColor           (void) const;
 150
 151                   SFColor4f           *editSFBgColor        (void);
 152             const SFColor4f           *getSFBgColor         (void) const;
 153
 154                   MFString            *editMFElements       (void);
 155             const MFString            *getMFElements        (void) const;
 156
 157
 158                   UInt32              &editSize           (void);
 159                   UInt32               getSize            (void) const;
 160
 161                   Color4f             &editColor          (void);
 162             const Color4f             &getColor           (void) const;
 163
 164                   Color4f             &editBgColor        (void);
 165             const Color4f             &getBgColor         (void) const;
 166
 167             MFString           ::reference       editElements       (const UInt32 index);
 168             const std::string         &getElements        (const UInt32 index) const;
 169
 170     /*! \}                                                                 */
 171     /*---------------------------------------------------------------------*/
 172     /*! \name                    Field Set                                 */
 173     /*! \{                                                                 */
 174
 175             void setSize           (const UInt32 value);
 176             void setColor          (const Color4f &value);
 177             void setBgColor        (const Color4f &value);
 178
 179     /*! \}                                                                 */
 180     /*---------------------------------------------------------------------*/
 181     /*! \name                Ptr MField Set                                */
 182     /*! \{                                                                 */
 183
 184     /*! \}                                                                 */
 185     /*---------------------------------------------------------------------*/
 186     /*! \name                   Binary Access                              */
 187     /*! \{                                                                 */
 188
 189     virtual SizeT  getBinSize (ConstFieldMaskArg  whichField);
 190     virtual void   copyToBin  (BinaryDataHandler &pMem,
 191                                ConstFieldMaskArg  whichField);
 192     virtual void   copyFromBin(BinaryDataHandler &pMem,
 193                                ConstFieldMaskArg  whichField);
 194
 195
 196     /*! \}                                                                 */
 197     /*---------------------------------------------------------------------*/
 198     /*! \name                   Construction                               */
 199     /*! \{                                                                 */
 200
 201     static  CSMStatisticsForegroundTransitPtr  create          (void);
 202     static  CSMStatisticsForeground           *createEmpty     (void);
 203
 204     static  CSMStatisticsForegroundTransitPtr  createLocal     (
 205                                                BitVector bFlags = FCLocal::All);
 206
 207     static  CSMStatisticsForeground            *createEmptyLocal(
 208                                               BitVector bFlags = FCLocal::All);
 209
 210     static  CSMStatisticsForegroundTransitPtr  createDependent  (BitVector bFlags);
 211
 212     /*! \}                                                                 */
 213     /*---------------------------------------------------------------------*/
 214     /*! \name                       Copy                                   */
 215     /*! \{                                                                 */
 216
 217     virtual FieldContainerTransitPtr shallowCopy     (void) const;
 218     virtual FieldContainerTransitPtr shallowCopyLocal(
 219                                        BitVector bFlags = FCLocal::All) const;
 220     virtual FieldContainerTransitPtr shallowCopyDependent(
 221                                                       BitVector bFlags) const;
 222
 223     /*! \}                                                                 */
 224     /*=========================  PROTECTED  ===============================*/
 225
 226   protected:
 227
 228     static TypeObject _type;
 229
 230     static       void   classDescInserter(TypeObject &oType);
 231     static const Char8 *getClassname     (void             );
 232
 233     /*---------------------------------------------------------------------*/
 234     /*! \name                      Fields                                  */
 235     /*! \{                                                                 */
 236
 237     SFUInt32          _sfSize;
 238     SFColor4f         _sfColor;
 239     SFColor4f         _sfBgColor;
 240     MFString          _mfElements;
 241
 242     /*! \}                                                                 */
 243     /*---------------------------------------------------------------------*/
 244     /*! \name                   Constructors                               */
 245     /*! \{                                                                 */
 246
 247     CSMStatisticsForegroundBase(void);
 248     CSMStatisticsForegroundBase(const CSMStatisticsForegroundBase &source);
 249
 250     /*! \}                                                                 */
 251     /*---------------------------------------------------------------------*/
 252     /*! \name                   Destructors                                */
 253     /*! \{                                                                 */
 254
 255     virtual ~CSMStatisticsForegroundBase(void);
 256
 257     /*! \}                                                                 */
 258     /*---------------------------------------------------------------------*/
 259     /*! \name                     onCreate                                */
 260     /*! \{                                                                 */
 261
 262
 263     /*! \}                                                                 */
 264     /*---------------------------------------------------------------------*/
 265     /*! \name                    Generic Field Access                      */
 266     /*! \{                                                                 */
 267
 268      GetFieldHandlePtr  getHandleSize            (void) const;
 269      EditFieldHandlePtr editHandleSize           (void);
 270      GetFieldHandlePtr  getHandleColor           (void) const;
 271      EditFieldHandlePtr editHandleColor          (void);
 272      GetFieldHandlePtr  getHandleBgColor         (void) const;
 273      EditFieldHandlePtr editHandleBgColor        (void);
 274      GetFieldHandlePtr  getHandleElements        (void) const;
 275      EditFieldHandlePtr editHandleElements       (void);
 276
 277     /*! \}                                                                 */
 278     /*---------------------------------------------------------------------*/
 279     /*! \name                       Sync                                   */
 280     /*! \{                                                                 */
 281
 282 #ifdef OSG_MT_CPTR_ASPECT
 283     virtual void execSyncV(      FieldContainer    &oFrom,
 284                                  ConstFieldMaskArg  whichField,
 285                                  AspectOffsetStore &oOffsets,
 286                                  ConstFieldMaskArg  syncMode  ,
 287                            const UInt32             uiSyncInfo);
 288
 289             void execSync (      CSMStatisticsForegroundBase *pFrom,
 290                                  ConstFieldMaskArg  whichField,
 291                                  AspectOffsetStore &oOffsets,
 292                                  ConstFieldMaskArg  syncMode  ,
 293                            const UInt32             uiSyncInfo);
 294 #endif
 295
 296     /*! \}                                                                 */
 297     /*---------------------------------------------------------------------*/
 298     /*! \name                       Edit                                   */
 299     /*! \{                                                                 */
 300
 301     /*! \}                                                                 */
 302     /*---------------------------------------------------------------------*/
 303     /*! \name                     Aspect Create                            */
 304     /*! \{                                                                 */
 305
 306 #ifdef OSG_MT_CPTR_ASPECT
 307     virtual FieldContainer *createAspectCopy(
 308                                     const FieldContainer *pRefAspect) const;
 309 #endif
 310
 311     /*! \}                                                                 */
 312     /*---------------------------------------------------------------------*/
 313     /*! \name                       Edit                                   */
 314     /*! \{                                                                 */
 315     /*! \}                                                                 */
 316     /*---------------------------------------------------------------------*/
 317     /*! \name                       Sync                                   */
 318     /*! \{                                                                 */
 319
 320     virtual void resolveLinks(void);
 321
 322     /*! \}                                                                 */
 323     /*==========================  PRIVATE  ================================*/
 324
 325   private:
 326     /*---------------------------------------------------------------------*/
 327
 328     // prohibit default functions (move to 'public' if you need one)
 329     void operator =(const CSMStatisticsForegroundBase &source);
 330 };
 331
 332 typedef CSMStatisticsForegroundBase *CSMStatisticsForegroundBaseP;
 333
 334 OSG_END_NAMESPACE
 335
 336 #endif /* _OSGCSMSTATISTICSFOREGROUNDBASE_H_ */