Source/Contrib/ComplexSceneManager/VRMLNodes/OSGValueEmitter.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 _OSGVALUEEMITTER_H_
  40 #define _OSGVALUEEMITTER_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 SValueEmitter : public NodeCore
  62 {
  63   public:
  64
  65     typedef NodeCore      Inherited;
  66     typedef NodeCore      ParentContainer;
  67     typedef SValueEmitter 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         TriggerFieldId          = Inherited::NextFieldId,
  81         ValueFieldId            = TriggerFieldId + 1,
  82         IgnoreNextChangeFieldId = ValueFieldId + 1,
  83         NextFieldId             = IgnoreNextChangeFieldId + 1
  84     };
  85
  86     static const OSG::BitVector TriggerFieldMask =
  87         (TypeTraits<BitVector>::One << TriggerFieldId);
  88
  89     static const OSG::BitVector ValueFieldMask =
  90         (TypeTraits<BitVector>::One << ValueFieldId);
  91
  92     static const OSG::BitVector IgnoreNextChangeFieldMask =
  93         (TypeTraits<BitVector>::One << IgnoreNextChangeFieldId);
  94
  95     typedef typename Desc::SFValueType       SFValueType;
  96     typedef typename SFValueType::StoredType ValueType;
  97
  98     /*---------------------------------------------------------------------*/
  99     /*! \name                    Class Get                                 */
 100     /*! \{                                                                 */
 101
 102     static       FieldContainerType &getClassType   (void);
 103     static       UInt32              getClassTypeId (void);
 104     static       UInt16              getClassGroupId(void);
 105     static const Char8              *getClassname   (void);
 106
 107     /*! \}                                                                 */
 108     /*---------------------------------------------------------------------*/
 109     /*! \name                FieldContainer Get                            */
 110     /*! \{                                                                 */
 111
 112     virtual       FieldContainerType &getType         (void);
 113     virtual const FieldContainerType &getType         (void) const;
 114
 115     virtual       UInt32              getContainerSize(void) const;
 116
 117     /*! \}                                                                 */
 118     /*---------------------------------------------------------------------*/
 119     /*! \name                    Field Get                                 */
 120     /*! \{                                                                 */
 121
 122
 123           SFValueType *editSFValue           (void);
 124     const SFValueType *getSFValue            (void) const;
 125
 126           ValueType   &editValue             (void);
 127           ValueType    getValue              (void) const;
 128
 129           SFBool      *editSFIgnoreNextChange(void);
 130     const SFBool      *getSFIgnoreNextChange (void) const;
 131
 132     /*! \}                                                                 */
 133     /*---------------------------------------------------------------------*/
 134     /*! \name                    Field Set                                 */
 135     /*! \{                                                                 */
 136
 137     void setValue(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     SFOSGAny    _sfTrigger;
 198     SFValueType _sfValue;
 199     SFBool      _sfIgnoreNextChange;
 200
 201     /*! \}                                                                 */
 202     /*---------------------------------------------------------------------*/
 203     /*! \name                   Constructors                               */
 204     /*! \{                                                                 */
 205
 206     SValueEmitter(void);
 207     SValueEmitter(const SValueEmitter &source);
 208
 209     /*! \}                                                                 */
 210     /*---------------------------------------------------------------------*/
 211     /*! \name                   Destructors                                */
 212     /*! \{                                                                 */
 213
 214     virtual ~SValueEmitter(void);
 215
 216     /*! \}                                                                 */
 217     /*---------------------------------------------------------------------*/
 218     /*! \name                     onCreate                                */
 219     /*! \{                                                                 */
 220
 221     /*! \}                                                                 */
 222     /*---------------------------------------------------------------------*/
 223     /*! \name                    Generic Field Access                      */
 224     /*! \{                                                                 */
 225
 226     GetFieldHandlePtr  getHandleTrigger          (void) const;
 227     EditFieldHandlePtr editHandleTrigger         (void);
 228
 229     GetFieldHandlePtr  getHandleValue            (void) const;
 230     EditFieldHandlePtr editHandleValue           (void);
 231
 232     GetFieldHandlePtr  getHandleIgnoreNextChange (void) const;
 233     EditFieldHandlePtr editHandleIgnoreNextChange(void);
 234
 235     /*! \}                                                                 */
 236     /*---------------------------------------------------------------------*/
 237     /*! \name                       Sync                                   */
 238     /*! \{                                                                 */
 239
 240 #ifdef OSG_MT_CPTR_ASPECT
 241     virtual void execSyncV(      FieldContainer    &oFrom,
 242                                  ConstFieldMaskArg  whichField,
 243                                  AspectOffsetStore &oOffsets,
 244                                  ConstFieldMaskArg  syncMode  ,
 245                            const UInt32             uiSyncInfo);
 246
 247             void execSync (      Self              *pFrom,
 248                                  ConstFieldMaskArg  whichField,
 249                                  AspectOffsetStore &oOffsets,
 250                                  ConstFieldMaskArg  syncMode  ,
 251                            const UInt32             uiSyncInfo);
 252 #endif
 253
 254     /*! \}                                                                 */
 255     /*---------------------------------------------------------------------*/
 256     /*! \name                       Edit                                   */
 257     /*! \{                                                                 */
 258
 259     /*! \}                                                                 */
 260     /*---------------------------------------------------------------------*/
 261     /*! \name                     Aspect Create                            */
 262     /*! \{                                                                 */
 263
 264 #ifdef OSG_MT_CPTR_ASPECT
 265     virtual FieldContainer *createAspectCopy(
 266                                       const FieldContainer *pRefAspect) const;
 267 #endif
 268
 269     /*! \}                                                                 */
 270     /*---------------------------------------------------------------------*/
 271     /*! \name                       Edit                                   */
 272     /*! \{                                                                 */
 273     /*! \}                                                                 */
 274     /*---------------------------------------------------------------------*/
 275     /*! \name                       Sync                                   */
 276     /*! \{                                                                 */
 277
 278     virtual void resolveLinks(void);
 279
 280     /*! \}                                                                 */
 281     /*---------------------------------------------------------------------*/
 282     /*! \name                      Init                                    */
 283     /*! \{                                                                 */
 284
 285     static void initMethod(InitPhase ePhase);
 286
 287     /*! \}                                                                 */
 288     /*==========================  PRIVATE  ================================*/
 289
 290   private:
 291
 292     friend class FieldContainer;
 293
 294     /*---------------------------------------------------------------------*/
 295
 296     // prohibit default functions (move to 'public' if you need one)
 297     void operator =(const SValueEmitter &source);
 298 };
 299
 300 struct BoolEmitterDesc
 301 {
 302     typedef SFBool SFValueType;
 303
 304     static const Char8 *getClassname(void)
 305     {
 306         return "BoolEmitter";
 307     }
 308
 309     static bool getDefault(void)
 310     {
 311         return true;
 312     }
 313 };
 314
 315 struct Int32EmitterDesc
 316 {
 317     typedef SFInt32 SFValueType;
 318
 319     static const Char8 *getClassname(void)
 320     {
 321         return "Int32Emitter";
 322     }
 323
 324     static Int32 getDefault(void)
 325     {
 326         return 0;
 327     }
 328 };
 329
 330 struct UInt32EmitterDesc
 331 {
 332     typedef SFUInt32 SFValueType;
 333
 334     static const Char8 *getClassname(void)
 335     {
 336         return "UInt32Emitter";
 337     }
 338
 339     static UInt32 getDefault(void)
 340     {
 341         return 0;
 342     }
 343 };
 344
 345 struct Real32EmitterDesc
 346 {
 347     typedef SFReal32 SFValueType;
 348
 349     static const Char8 *getClassname(void)
 350     {
 351         return "Real32Emitter";
 352     }
 353
 354     static Real32 getDefault(void)
 355     {
 356         return 0.f;
 357     }
 358 };
 359
 360 struct TimeEmitterDesc
 361 {
 362     typedef SFTime SFValueType;
 363
 364     static const Char8 *getClassname(void)
 365     {
 366         return "TimeEmitter";
 367     }
 368
 369     static Time getDefault(void)
 370     {
 371         return 0.f;
 372     }
 373 };
 374
 375 struct Vec2fEmitterDesc
 376 {
 377     typedef SFVec2f SFValueType;
 378
 379     static const Char8 *getClassname(void)
 380     {
 381         return "Vec2fEmitter";
 382     }
 383
 384     static Vec2f getDefault(void)
 385     {
 386         return Vec2f(0.f, 0.f);
 387     }
 388 };
 389
 390 struct Vec3fEmitterDesc
 391 {
 392     typedef SFVec3f SFValueType;
 393
 394     static const Char8 *getClassname(void)
 395     {
 396         return "Vec3fEmitter";
 397     }
 398
 399     static Vec3f getDefault(void)
 400     {
 401         return Vec3f(0.f, 0.f, 0.f);
 402     }
 403 };
 404
 405 struct StringEmitterDesc
 406 {
 407     typedef SFString SFValueType;
 408
 409     static const Char8 *getClassname(void)
 410     {
 411         return "StringEmitter";
 412     }
 413
 414     static std::string getDefault(void)
 415     {
 416         return std::string();
 417     }
 418 };
 419
 420 struct MatrixEmitterDesc
 421 {
 422     typedef SFMatrix SFValueType;
 423
 424     static const Char8 *getClassname(void)
 425     {
 426         return "MatrixEmitter";
 427     }
 428
 429     static Matrix getDefault(void)
 430     {
 431         Matrix m;
 432
 433         m.setIdentity();
 434
 435         return m;
 436     }
 437 };
 438
 439 typedef SValueEmitter<BoolEmitterDesc  > BoolEmitter;
 440 typedef SValueEmitter<Int32EmitterDesc > Int32Emitter;
 441 typedef SValueEmitter<UInt32EmitterDesc> UInt32Emitter;
 442 typedef SValueEmitter<Real32EmitterDesc> Real32Emitter;
 443 typedef SValueEmitter<TimeEmitterDesc  > TimeEmitter;
 444 typedef SValueEmitter<Vec2fEmitterDesc > Vec2fEmitter;
 445 typedef SValueEmitter<Vec3fEmitterDesc > Vec3fEmitter;
 446 typedef SValueEmitter<StringEmitterDesc> StringEmitter;
 447 typedef SValueEmitter<MatrixEmitterDesc> MatrixEmitter;
 448
 449 OSG_END_NAMESPACE
 450
 451 #include "OSGValueEmitter.inl"
 452
 453 #endif /* _OSGVALUEEMITTER_H_ */