Source/System/State/Base/OSGStateBase.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 /*****************************************************************************\
  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 State
  49  **                                                                         **
  50  *****************************************************************************
  51 \*****************************************************************************/
  52
  53
  54 #ifndef _OSGSTATEBASE_H_
  55 #define _OSGSTATEBASE_H_
  56 #ifdef __sgi
  57 #pragma once
  58 #endif
  59
  60
  61 #include "OSGConfig.h"
  62 #include "OSGSystemDef.h"
  63
  64 //#include "OSGBaseTypes.h"
  65
  66 #include "OSGFieldContainer.h" // Parent
  67
  68 #include "OSGStateChunkFields.h"        // Chunks type
  69
  70 #include "OSGStateFields.h"
  71
  72 OSG_BEGIN_NAMESPACE
  73
  74
  75 class State;
  76
  77 //! \brief State Base Class.
  78
  79 class OSG_SYSTEM_DLLMAPPING StateBase : public FieldContainer
  80 {
  81   public:
  82
  83     typedef FieldContainer Inherited;
  84     typedef FieldContainer ParentContainer;
  85
  86     typedef Inherited::TypeObject TypeObject;
  87     typedef TypeObject::InitPhase InitPhase;
  88
  89     OSG_GEN_INTERNALPTR(State);
  90
  91     /*==========================  PUBLIC  =================================*/
  92
  93   public:
  94
  95     enum
  96     {
  97         ChunksFieldId = Inherited::NextFieldId,
  98         NextFieldId = ChunksFieldId + 1
  99     };
 100
 101     static const OSG::BitVector ChunksFieldMask =
 102         (TypeTraits<BitVector>::One << ChunksFieldId);
 103     static const OSG::BitVector NextFieldMask =
 104         (TypeTraits<BitVector>::One << NextFieldId);
 105
 106     typedef MFUnrecStateChunkPtr MFChunksType;
 107
 108     /*---------------------------------------------------------------------*/
 109     /*! \name                    Class Get                                 */
 110     /*! \{                                                                 */
 111
 112     static FieldContainerType &getClassType   (void);
 113     static UInt32              getClassTypeId (void);
 114     static UInt16              getClassGroupId(void);
 115
 116     /*! \}                                                                 */
 117     /*---------------------------------------------------------------------*/
 118     /*! \name                FieldContainer Get                            */
 119     /*! \{                                                                 */
 120
 121     virtual       FieldContainerType &getType         (void);
 122     virtual const FieldContainerType &getType         (void) const;
 123
 124     virtual       UInt32              getContainerSize(void) const;
 125
 126     /*! \}                                                                 */
 127     /*---------------------------------------------------------------------*/
 128     /*! \name                   Binary Access                              */
 129     /*! \{                                                                 */
 130
 131     virtual SizeT  getBinSize (ConstFieldMaskArg  whichField);
 132     virtual void   copyToBin  (BinaryDataHandler &pMem,
 133                                ConstFieldMaskArg  whichField);
 134     virtual void   copyFromBin(BinaryDataHandler &pMem,
 135                                ConstFieldMaskArg  whichField);
 136
 137
 138     /*! \}                                                                 */
 139     /*---------------------------------------------------------------------*/
 140     /*! \name                   Construction                               */
 141     /*! \{                                                                 */
 142
 143     static  StateTransitPtr  create          (void);
 144     static  State           *createEmpty     (void);
 145
 146     static  StateTransitPtr  createLocal     (
 147                                                BitVector bFlags = FCLocal::All);
 148
 149     static  State            *createEmptyLocal(
 150                                               BitVector bFlags = FCLocal::All);
 151
 152     static  StateTransitPtr  createDependent  (BitVector bFlags);
 153
 154     /*! \}                                                                 */
 155     /*---------------------------------------------------------------------*/
 156     /*! \name                       Copy                                   */
 157     /*! \{                                                                 */
 158
 159     virtual FieldContainerTransitPtr shallowCopy     (void) const;
 160     virtual FieldContainerTransitPtr shallowCopyLocal(
 161                                        BitVector bFlags = FCLocal::All) const;
 162     virtual FieldContainerTransitPtr shallowCopyDependent(
 163                                                       BitVector bFlags) const;
 164
 165     /*! \}                                                                 */
 166     /*=========================  PROTECTED  ===============================*/
 167
 168   protected:
 169
 170     static TypeObject _type;
 171
 172     static       void   classDescInserter(TypeObject &oType);
 173     static const Char8 *getClassname     (void             );
 174
 175     /*---------------------------------------------------------------------*/
 176     /*! \name                      Fields                                  */
 177     /*! \{                                                                 */
 178
 179     MFUnrecStateChunkPtr _mfChunks;
 180
 181     /*! \}                                                                 */
 182     /*---------------------------------------------------------------------*/
 183     /*! \name                   Constructors                               */
 184     /*! \{                                                                 */
 185
 186     StateBase(void);
 187     StateBase(const StateBase &source);
 188
 189     /*! \}                                                                 */
 190     /*---------------------------------------------------------------------*/
 191     /*! \name                   Destructors                                */
 192     /*! \{                                                                 */
 193
 194     virtual ~StateBase(void);
 195
 196     /*! \}                                                                 */
 197     /*---------------------------------------------------------------------*/
 198     /*! \name                     onCreate                                */
 199     /*! \{                                                                 */
 200
 201
 202     /*! \}                                                                 */
 203     /*---------------------------------------------------------------------*/
 204     /*! \name                    Generic Field Access                      */
 205     /*! \{                                                                 */
 206
 207     GetFieldHandlePtr  getHandleChunks          (void) const;
 208     EditFieldHandlePtr editHandleChunks         (void);
 209
 210     /*! \}                                                                 */
 211     /*---------------------------------------------------------------------*/
 212     /*! \name                       Sync                                   */
 213     /*! \{                                                                 */
 214
 215 #ifdef OSG_MT_CPTR_ASPECT
 216     virtual void execSyncV(      FieldContainer    &oFrom,
 217                                  ConstFieldMaskArg  whichField,
 218                                  AspectOffsetStore &oOffsets,
 219                                  ConstFieldMaskArg  syncMode  ,
 220                            const UInt32             uiSyncInfo);
 221
 222             void execSync (      StateBase *pFrom,
 223                                  ConstFieldMaskArg  whichField,
 224                                  AspectOffsetStore &oOffsets,
 225                                  ConstFieldMaskArg  syncMode  ,
 226                            const UInt32             uiSyncInfo);
 227 #endif
 228
 229     /*! \}                                                                 */
 230     /*---------------------------------------------------------------------*/
 231     /*! \name                       Edit                                   */
 232     /*! \{                                                                 */
 233
 234     /*! \}                                                                 */
 235     /*---------------------------------------------------------------------*/
 236     /*! \name                     Aspect Create                            */
 237     /*! \{                                                                 */
 238
 239 #ifdef OSG_MT_CPTR_ASPECT
 240     virtual FieldContainer *createAspectCopy(
 241                                     const FieldContainer *pRefAspect) const;
 242 #endif
 243
 244     /*! \}                                                                 */
 245     /*---------------------------------------------------------------------*/
 246     /*! \name                       Edit                                   */
 247     /*! \{                                                                 */
 248     /*! \}                                                                 */
 249     /*---------------------------------------------------------------------*/
 250     /*! \name                       Sync                                   */
 251     /*! \{                                                                 */
 252
 253     virtual void resolveLinks(void);
 254
 255     /*! \}                                                                 */
 256     /*==========================  PRIVATE  ================================*/
 257
 258   private:
 259     /*---------------------------------------------------------------------*/
 260
 261     // prohibit default functions (move to 'public' if you need one)
 262     void operator =(const StateBase &source);
 263 };
 264
 265 typedef StateBase *StateBaseP;
 266
 267 OSG_END_NAMESPACE
 268
 269 #endif /* _OSGSTATEBASE_H_ */