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