Source/System/Dynamics/VRMLAnimation/OSGVRMLScalarInterpolatorBase.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 VRMLScalarInterpolator
  49  **                                                                         **
  50  *****************************************************************************
  51 \*****************************************************************************/
  52
  53
  54 #ifndef _OSGVRMLSCALARINTERPOLATORBASE_H_
  55 #define _OSGVRMLSCALARINTERPOLATORBASE_H_
  56 #ifdef __sgi
  57 #pragma once
  58 #endif
  59
  60
  61 #include "OSGConfig.h"
  62 #include "OSGDynamicsDef.h"
  63
  64 //#include "OSGBaseTypes.h"
  65
  66 #include "OSGVRMLInterpolator.h" // Parent
  67
  68 #include "OSGSysFields.h"               // KeyValue type
  69
  70 #include "OSGVRMLScalarInterpolatorFields.h"
  71
  72 OSG_BEGIN_NAMESPACE
  73
  74
  75 class VRMLScalarInterpolator;
  76
  77 //! \brief VRMLScalarInterpolator Base Class.
  78
  79 class OSG_DYNAMICS_DLLMAPPING VRMLScalarInterpolatorBase : public VRMLInterpolator
  80 {
  81   public:
  82
  83     typedef VRMLInterpolator Inherited;
  84     typedef VRMLInterpolator ParentContainer;
  85
  86     typedef Inherited::TypeObject TypeObject;
  87     typedef TypeObject::InitPhase InitPhase;
  88
  89     OSG_GEN_INTERNALPTR(VRMLScalarInterpolator);
  90
  91     /*==========================  PUBLIC  =================================*/
  92
  93   public:
  94
  95     enum
  96     {
  97         KeyValueFieldId = Inherited::NextFieldId,
  98         OutValueFieldId = KeyValueFieldId + 1,
  99         NextFieldId = OutValueFieldId + 1
 100     };
 101
 102     static const OSG::BitVector KeyValueFieldMask =
 103         (TypeTraits<BitVector>::One << KeyValueFieldId);
 104     static const OSG::BitVector OutValueFieldMask =
 105         (TypeTraits<BitVector>::One << OutValueFieldId);
 106     static const OSG::BitVector NextFieldMask =
 107         (TypeTraits<BitVector>::One << NextFieldId);
 108
 109     typedef MFReal32          MFKeyValueType;
 110     typedef SFReal32          SFOutValueType;
 111
 112     /*---------------------------------------------------------------------*/
 113     /*! \name                    Class Get                                 */
 114     /*! \{                                                                 */
 115
 116     static FieldContainerType &getClassType   (void);
 117     static UInt32              getClassTypeId (void);
 118     static UInt16              getClassGroupId(void);
 119
 120     /*! \}                                                                 */
 121     /*---------------------------------------------------------------------*/
 122     /*! \name                FieldContainer Get                            */
 123     /*! \{                                                                 */
 124
 125     virtual       FieldContainerType &getType         (void);
 126     virtual const FieldContainerType &getType         (void) const;
 127
 128     virtual       UInt32              getContainerSize(void) const;
 129
 130     /*! \}                                                                 */
 131     /*---------------------------------------------------------------------*/
 132     /*! \name                    Field Get                                 */
 133     /*! \{                                                                 */
 134
 135
 136                   MFReal32            *editMFKeyValue       (void);
 137             const MFReal32            *getMFKeyValue        (void) const;
 138
 139                   SFReal32            *editSFOutValue       (void);
 140             const SFReal32            *getSFOutValue        (void) const;
 141
 142
 143             MFReal32           ::reference       editKeyValue       (const UInt32 index);
 144                   Real32               getKeyValue        (const UInt32 index) const;
 145
 146                   Real32              &editOutValue       (void);
 147                   Real32               getOutValue        (void) const;
 148
 149     /*! \}                                                                 */
 150     /*---------------------------------------------------------------------*/
 151     /*! \name                    Field Set                                 */
 152     /*! \{                                                                 */
 153
 154             void setOutValue       (const Real32 value);
 155
 156     /*! \}                                                                 */
 157     /*---------------------------------------------------------------------*/
 158     /*! \name                Ptr MField Set                                */
 159     /*! \{                                                                 */
 160
 161     /*! \}                                                                 */
 162     /*---------------------------------------------------------------------*/
 163     /*! \name                   Binary Access                              */
 164     /*! \{                                                                 */
 165
 166     virtual SizeT  getBinSize (ConstFieldMaskArg  whichField);
 167     virtual void   copyToBin  (BinaryDataHandler &pMem,
 168                                ConstFieldMaskArg  whichField);
 169     virtual void   copyFromBin(BinaryDataHandler &pMem,
 170                                ConstFieldMaskArg  whichField);
 171
 172
 173     /*! \}                                                                 */
 174     /*---------------------------------------------------------------------*/
 175     /*! \name                   Construction                               */
 176     /*! \{                                                                 */
 177
 178     static  VRMLScalarInterpolatorTransitPtr  create          (void);
 179     static  VRMLScalarInterpolator           *createEmpty     (void);
 180
 181     static  VRMLScalarInterpolatorTransitPtr  createLocal     (
 182                                                BitVector bFlags = FCLocal::All);
 183
 184     static  VRMLScalarInterpolator            *createEmptyLocal(
 185                                               BitVector bFlags = FCLocal::All);
 186
 187     static  VRMLScalarInterpolatorTransitPtr  createDependent  (BitVector bFlags);
 188
 189     /*! \}                                                                 */
 190     /*---------------------------------------------------------------------*/
 191     /*! \name                       Copy                                   */
 192     /*! \{                                                                 */
 193
 194     virtual FieldContainerTransitPtr shallowCopy     (void) const;
 195     virtual FieldContainerTransitPtr shallowCopyLocal(
 196                                        BitVector bFlags = FCLocal::All) const;
 197     virtual FieldContainerTransitPtr shallowCopyDependent(
 198                                                       BitVector bFlags) const;
 199
 200     /*! \}                                                                 */
 201     /*=========================  PROTECTED  ===============================*/
 202
 203   protected:
 204
 205     static TypeObject _type;
 206
 207     static       void   classDescInserter(TypeObject &oType);
 208     static const Char8 *getClassname     (void             );
 209
 210     /*---------------------------------------------------------------------*/
 211     /*! \name                      Fields                                  */
 212     /*! \{                                                                 */
 213
 214     MFReal32          _mfKeyValue;
 215     SFReal32          _sfOutValue;
 216
 217     /*! \}                                                                 */
 218     /*---------------------------------------------------------------------*/
 219     /*! \name                   Constructors                               */
 220     /*! \{                                                                 */
 221
 222     VRMLScalarInterpolatorBase(void);
 223     VRMLScalarInterpolatorBase(const VRMLScalarInterpolatorBase &source);
 224
 225     /*! \}                                                                 */
 226     /*---------------------------------------------------------------------*/
 227     /*! \name                   Destructors                                */
 228     /*! \{                                                                 */
 229
 230     virtual ~VRMLScalarInterpolatorBase(void);
 231
 232     /*! \}                                                                 */
 233     /*---------------------------------------------------------------------*/
 234     /*! \name                     onCreate                                */
 235     /*! \{                                                                 */
 236
 237
 238     /*! \}                                                                 */
 239     /*---------------------------------------------------------------------*/
 240     /*! \name                    Generic Field Access                      */
 241     /*! \{                                                                 */
 242
 243      GetFieldHandlePtr  getHandleKeyValue        (void) const;
 244      EditFieldHandlePtr editHandleKeyValue       (void);
 245      GetFieldHandlePtr  getHandleOutValue        (void) const;
 246      EditFieldHandlePtr editHandleOutValue       (void);
 247
 248     /*! \}                                                                 */
 249     /*---------------------------------------------------------------------*/
 250     /*! \name                       Sync                                   */
 251     /*! \{                                                                 */
 252
 253 #ifdef OSG_MT_CPTR_ASPECT
 254     virtual void execSyncV(      FieldContainer    &oFrom,
 255                                  ConstFieldMaskArg  whichField,
 256                                  AspectOffsetStore &oOffsets,
 257                                  ConstFieldMaskArg  syncMode  ,
 258                            const UInt32             uiSyncInfo);
 259
 260             void execSync (      VRMLScalarInterpolatorBase *pFrom,
 261                                  ConstFieldMaskArg  whichField,
 262                                  AspectOffsetStore &oOffsets,
 263                                  ConstFieldMaskArg  syncMode  ,
 264                            const UInt32             uiSyncInfo);
 265 #endif
 266
 267     /*! \}                                                                 */
 268     /*---------------------------------------------------------------------*/
 269     /*! \name                       Edit                                   */
 270     /*! \{                                                                 */
 271
 272     /*! \}                                                                 */
 273     /*---------------------------------------------------------------------*/
 274     /*! \name                     Aspect Create                            */
 275     /*! \{                                                                 */
 276
 277 #ifdef OSG_MT_CPTR_ASPECT
 278     virtual FieldContainer *createAspectCopy(
 279                                     const FieldContainer *pRefAspect) const;
 280 #endif
 281
 282     /*! \}                                                                 */
 283     /*---------------------------------------------------------------------*/
 284     /*! \name                       Edit                                   */
 285     /*! \{                                                                 */
 286     /*! \}                                                                 */
 287     /*---------------------------------------------------------------------*/
 288     /*! \name                       Sync                                   */
 289     /*! \{                                                                 */
 290
 291     virtual void resolveLinks(void);
 292
 293     /*! \}                                                                 */
 294     /*==========================  PRIVATE  ================================*/
 295
 296   private:
 297     /*---------------------------------------------------------------------*/
 298
 299     // prohibit default functions (move to 'public' if you need one)
 300     void operator =(const VRMLScalarInterpolatorBase &source);
 301 };
 302
 303 typedef VRMLScalarInterpolatorBase *VRMLScalarInterpolatorBaseP;
 304
 305 typedef CoredNodeRefPtr  <VRMLScalarInterpolator> VRMLScalarInterpolatorNodeRefPtr;
 306 typedef CoredNodeMTRefPtr<VRMLScalarInterpolator> VRMLScalarInterpolatorNodeMTRefPtr;
 307
 308 OSG_END_NAMESPACE
 309
 310 #endif /* _OSGVRMLSCALARINTERPOLATORBASE_H_ */