Source/Contrib/ComplexSceneManager/VRMLNodes/OSGValueAccumulator.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 _OSGVALUEACCUMULATOR_H_
  40 #define _OSGVALUEACCUMULATOR_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45
  46 #include "OSGConfig.h"
  47 #include "OSGContribCSMDef.h"
  48
  49 #include "OSGCounter.h" // Parent
  50
  51 #include "OSGSysFields.h" // Step type
  52 #include "OSGBaseFields.h"
  53 #include "OSGMathFields.h"
  54 #include "OSGVecFields.h"
  55
  56 OSG_BEGIN_NAMESPACE
  57
  58 //! \brief Real32Counter Base Class.
  59
  60 template<class Desc>
  61 class SValueAccumulator : public NodeCore
  62 {
  63   public:
  64
  65     typedef NodeCore          Inherited;
  66     typedef NodeCore          ParentContainer;
  67     typedef SValueAccumulator Self;
  68
  69     typedef Inherited::TypeObject TypeObject;
  70     typedef TypeObject::InitPhase InitPhase;
  71
  72     OSG_GEN_INTERNALPTR(Self);
  73
  74     /*==========================  PUBLIC  =================================*/
  75
  76   public:
  77
  78     enum
  79     {
  80         ValueFieldId        = Inherited::NextFieldId,
  81         RhsFieldId          = ValueFieldId + 1,
  82         NextFieldId         = RhsFieldId + 1
  83     };
  84
  85     static const OSG::BitVector ValueFieldMask =
  86         (TypeTraits<BitVector>::One << ValueFieldId);
  87
  88     static const OSG::BitVector RhsFieldMask =
  89         (TypeTraits<BitVector>::One << RhsFieldId);
  90
  91     typedef typename Desc::SFValueType       SFValueType;
  92     typedef typename SFValueType::StoredType ValueType;
  93
  94     /*---------------------------------------------------------------------*/
  95     /*! \name                    Class Get                                 */
  96     /*! \{                                                                 */
  97
  98     static       FieldContainerType &getClassType   (void);
  99     static       UInt32              getClassTypeId (void);
 100     static       UInt16              getClassGroupId(void);
 101     static const Char8              *getClassname   (void);
 102
 103     /*! \}                                                                 */
 104     /*---------------------------------------------------------------------*/
 105     /*! \name                FieldContainer Get                            */
 106     /*! \{                                                                 */
 107
 108     virtual       FieldContainerType &getType         (void);
 109     virtual const FieldContainerType &getType         (void) const;
 110
 111     virtual       UInt32              getContainerSize(void) const;
 112
 113     /*! \}                                                                 */
 114     /*---------------------------------------------------------------------*/
 115     /*! \name                    Field Get                                 */
 116     /*! \{                                                                 */
 117
 118
 119           SFValueType *editSFValue         (void);
 120     const SFValueType *getSFValue          (void) const;
 121
 122           ValueType   &editValue           (void);
 123           ValueType    getValue            (void) const;
 124
 125           SFValueType *editSFRhs           (void);
 126     const SFValueType *getSFRhs            (void) const;
 127
 128           ValueType   &editRhs             (void);
 129           ValueType    getRhs              (void) const;
 130
 131     /*! \}                                                                 */
 132     /*---------------------------------------------------------------------*/
 133     /*! \name                    Field Set                                 */
 134     /*! \{                                                                 */
 135
 136     void setValue(const ValueType value);
 137     void setRhs  (const ValueType value);
 138
 139     /*! \}                                                                 */
 140     /*---------------------------------------------------------------------*/
 141     /*! \name                Ptr MField Set                                */
 142     /*! \{                                                                 */
 143
 144     virtual void changed(ConstFieldMaskArg whichField,
 145                          UInt32            origin,
 146                          BitVector         details    );
 147
 148     /*! \}                                                                 */
 149     /*---------------------------------------------------------------------*/
 150     /*! \name                   Binary Access                              */
 151     /*! \{                                                                 */
 152
 153     virtual SizeT  getBinSize (ConstFieldMaskArg  whichField);
 154     virtual void   copyToBin  (BinaryDataHandler &pMem,
 155                                ConstFieldMaskArg  whichField);
 156     virtual void   copyFromBin(BinaryDataHandler &pMem,
 157                                ConstFieldMaskArg  whichField);
 158
 159
 160     /*! \}                                                                 */
 161     /*---------------------------------------------------------------------*/
 162     /*! \name                   Construction                               */
 163     /*! \{                                                                 */
 164
 165     static  ObjTransitPtr  create          (void                           );
 166     static  Self          *createEmpty     (void                           );
 167
 168     static  ObjTransitPtr  createLocal     (BitVector bFlags = FCLocal::All);
 169     static  ObjTransitPtr  createDependent (BitVector bFlags = FCLocal::All);
 170
 171     static  Self          *createEmptyLocal(BitVector bFlags = FCLocal::All);
 172
 173     /*! \}                                                                 */
 174     /*---------------------------------------------------------------------*/
 175     /*! \name                       Copy                                   */
 176     /*! \{                                                                 */
 177
 178     virtual FieldContainerTransitPtr shallowCopy     (void) const;
 179     virtual FieldContainerTransitPtr shallowCopyLocal(
 180                                        BitVector bFlags = FCLocal::All) const;
 181     virtual FieldContainerTransitPtr shallowCopyDependent(
 182                                        BitVector bFlags               ) const;
 183
 184     /*! \}                                                                 */
 185     /*=========================  PROTECTED  ===============================*/
 186
 187   protected:
 188
 189     static TypeObject _type;
 190
 191     static void classDescInserter(TypeObject &oType);
 192
 193     /*---------------------------------------------------------------------*/
 194     /*! \name                      Fields                                  */
 195     /*! \{                                                                 */
 196
 197     SFValueType _sfValue;
 198     SFValueType _sfRhs;
 199
 200     /*! \}                                                                 */
 201     /*---------------------------------------------------------------------*/
 202     /*! \name                   Constructors                               */
 203     /*! \{                                                                 */
 204
 205     SValueAccumulator(void);
 206     SValueAccumulator(const SValueAccumulator &source);
 207
 208     /*! \}                                                                 */
 209     /*---------------------------------------------------------------------*/
 210     /*! \name                   Destructors                                */
 211     /*! \{                                                                 */
 212
 213     virtual ~SValueAccumulator(void);
 214
 215     /*! \}                                                                 */
 216     /*---------------------------------------------------------------------*/
 217     /*! \name                     onCreate                                */
 218     /*! \{                                                                 */
 219
 220     /*! \}                                                                 */
 221     /*---------------------------------------------------------------------*/
 222     /*! \name                    Generic Field Access                      */
 223     /*! \{                                                                 */
 224
 225     GetFieldHandlePtr  getHandleValue          (void) const;
 226     EditFieldHandlePtr editHandleValue         (void);
 227
 228     GetFieldHandlePtr  getHandleRhs            (void) const;
 229     EditFieldHandlePtr editHandleRhs           (void);
 230
 231
 232     /*! \}                                                                 */
 233     /*---------------------------------------------------------------------*/
 234     /*! \name                       Sync                                   */
 235     /*! \{                                                                 */
 236
 237 #ifdef OSG_MT_CPTR_ASPECT
 238     virtual void execSyncV(      FieldContainer    &oFrom,
 239                                  ConstFieldMaskArg  whichField,
 240                                  AspectOffsetStore &oOffsets,
 241                                  ConstFieldMaskArg  syncMode  ,
 242                            const UInt32             uiSyncInfo);
 243
 244             void execSync (      Self              *pFrom,
 245                                  ConstFieldMaskArg  whichField,
 246                                  AspectOffsetStore &oOffsets,
 247                                  ConstFieldMaskArg  syncMode  ,
 248                            const UInt32             uiSyncInfo);
 249 #endif
 250
 251     /*! \}                                                                 */
 252     /*---------------------------------------------------------------------*/
 253     /*! \name                       Edit                                   */
 254     /*! \{                                                                 */
 255
 256     /*! \}                                                                 */
 257     /*---------------------------------------------------------------------*/
 258     /*! \name                     Aspect Create                            */
 259     /*! \{                                                                 */
 260
 261 #ifdef OSG_MT_CPTR_ASPECT
 262     virtual FieldContainer *createAspectCopy(
 263                                       const FieldContainer *pRefAspect) const;
 264 #endif
 265
 266     /*! \}                                                                 */
 267     /*---------------------------------------------------------------------*/
 268     /*! \name                       Edit                                   */
 269     /*! \{                                                                 */
 270     /*! \}                                                                 */
 271     /*---------------------------------------------------------------------*/
 272     /*! \name                       Sync                                   */
 273     /*! \{                                                                 */
 274
 275     virtual void resolveLinks(void);
 276
 277     /*! \}                                                                 */
 278     /*---------------------------------------------------------------------*/
 279     /*! \name                      Init                                    */
 280     /*! \{                                                                 */
 281
 282     static void initMethod(InitPhase ePhase);
 283
 284     /*! \}                                                                 */
 285     /*==========================  PRIVATE  ================================*/
 286
 287   private:
 288
 289     friend class FieldContainer;
 290
 291     /*---------------------------------------------------------------------*/
 292
 293     // prohibit default functions (move to 'public' if you need one)
 294     void operator =(const SValueAccumulator &source);
 295 };
 296
 297 #if 0
 298 struct Int32EmitterDesc
 299 {
 300     typedef SFInt32 SFValueType;
 301
 302     static const Char8 *getClassname(void)
 303     {
 304         return "Int32Emitter";
 305     }
 306
 307     static Int32 getDefault(void)
 308     {
 309         return 0;
 310     }
 311 };
 312 #endif
 313
 314 struct Real32AccumulatorDesc
 315 {
 316     typedef SFReal32 SFValueType;
 317
 318     static const Char8 *getClassname(void)
 319     {
 320         return "Real32Accumulator";
 321     }
 322
 323     static Real32 getDefault(void)
 324     {
 325         return 0.f;
 326     }
 327
 328     static void accumulate(      Real32 &result,
 329                            const Real32  rhs   )
 330     {
 331         result += rhs;
 332     }
 333 };
 334
 335 struct Vec2fAccumulatorDesc
 336 {
 337     typedef SFVec2f SFValueType;
 338
 339     static const Char8 *getClassname(void)
 340     {
 341         return "Vec2fAccumulator";
 342     }
 343
 344     static Vec2f getDefault(void)
 345     {
 346         return Vec2f(0.f, 0.f);
 347     }
 348
 349     static void accumulate(      Vec2f &result,
 350                            const Vec2f  rhs   )
 351     {
 352         result += rhs;
 353
 354         fprintf(stderr, "step : %f %f, res : %f %f\n",
 355                 rhs[0],
 356                 rhs[1],
 357                 result[0],
 358                 result[1]);
 359     }
 360 };
 361
 362 struct MatrixAccumulatorDesc
 363 {
 364     typedef SFMatrix SFValueType;
 365
 366     static const Char8 *getClassname(void)
 367     {
 368         return "MatrixAccumulator";
 369     }
 370
 371     static Matrix getDefault(void)
 372     {
 373         Matrix m;
 374
 375         m.setIdentity();
 376
 377         return m;
 378     }
 379
 380     static void accumulate(      Matrix &result,
 381                            const Matrix &rhs   )
 382     {
 383         result.add(rhs);
 384     }
 385 };
 386
 387 //typedef SValueEmitter<Int32EmitterDesc > Int32Emitter;
 388 typedef SValueAccumulator<Real32AccumulatorDesc> Real32Accumulator;
 389 typedef SValueAccumulator<Vec2fAccumulatorDesc > Vec2fAccumulator;
 390 typedef SValueAccumulator<MatrixAccumulatorDesc> MatrixAccumulator;
 391
 392 OSG_END_NAMESPACE
 393
 394 #include "OSGValueAccumulator.inl"
 395
 396 #endif /* _OSGVALUEACCUMULATOR_H_ */