Source/System/Dynamics/VRMLAnimation/OSGVRMLNormalInterpolatorBase.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 VRMLNormalInterpolator
  49  **                                                                         **
  50  *****************************************************************************
  51 \*****************************************************************************/
  52
  53
  54 #ifndef _OSGVRMLNORMALINTERPOLATORBASE_H_
  55 #define _OSGVRMLNORMALINTERPOLATORBASE_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 "OSGVecFields.h"               // KeyValue type
  69
  70 #include "OSGVRMLNormalInterpolatorFields.h"
  71
  72 OSG_BEGIN_NAMESPACE
  73
  74
  75 class VRMLNormalInterpolator;
  76
  77 //! \brief VRMLNormalInterpolator Base Class.
  78
  79 class OSG_DYNAMICS_DLLMAPPING VRMLNormalInterpolatorBase : 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(VRMLNormalInterpolator);
  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 MFVec3f           MFKeyValueType;
 110     typedef MFVec3f           MFOutValueType;
 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                   MFVec3f             *editMFKeyValue       (void);
 137             const MFVec3f             *getMFKeyValue        (void) const;
 138
 139                   MFVec3f             *editMFOutValue       (void);
 140             const MFVec3f             *getMFOutValue        (void) const;
 141
 142
 143             MFVec3f            ::reference       editKeyValue       (const UInt32 index);
 144             const Vec3f               &getKeyValue        (const UInt32 index) const;
 145
 146             MFVec3f            ::reference       editOutValue       (const UInt32 index);
 147             const Vec3f               &getOutValue        (const UInt32 index) const;
 148
 149     /*! \}                                                                 */
 150     /*---------------------------------------------------------------------*/
 151     /*! \name                    Field Set                                 */
 152     /*! \{                                                                 */
 153
 154
 155     /*! \}                                                                 */
 156     /*---------------------------------------------------------------------*/
 157     /*! \name                Ptr MField Set                                */
 158     /*! \{                                                                 */
 159
 160     /*! \}                                                                 */
 161     /*---------------------------------------------------------------------*/
 162     /*! \name                   Binary Access                              */
 163     /*! \{                                                                 */
 164
 165     virtual SizeT  getBinSize (ConstFieldMaskArg  whichField);
 166     virtual void   copyToBin  (BinaryDataHandler &pMem,
 167                                ConstFieldMaskArg  whichField);
 168     virtual void   copyFromBin(BinaryDataHandler &pMem,
 169                                ConstFieldMaskArg  whichField);
 170
 171
 172     /*! \}                                                                 */
 173     /*---------------------------------------------------------------------*/
 174     /*! \name                   Construction                               */
 175     /*! \{                                                                 */
 176
 177     static  VRMLNormalInterpolatorTransitPtr  create          (void);
 178     static  VRMLNormalInterpolator           *createEmpty     (void);
 179
 180     static  VRMLNormalInterpolatorTransitPtr  createLocal     (
 181                                                BitVector bFlags = FCLocal::All);
 182
 183     static  VRMLNormalInterpolator            *createEmptyLocal(
 184                                               BitVector bFlags = FCLocal::All);
 185
 186     static  VRMLNormalInterpolatorTransitPtr  createDependent  (BitVector bFlags);
 187
 188     /*! \}                                                                 */
 189     /*---------------------------------------------------------------------*/
 190     /*! \name                       Copy                                   */
 191     /*! \{                                                                 */
 192
 193     virtual FieldContainerTransitPtr shallowCopy     (void) const;
 194     virtual FieldContainerTransitPtr shallowCopyLocal(
 195                                        BitVector bFlags = FCLocal::All) const;
 196     virtual FieldContainerTransitPtr shallowCopyDependent(
 197                                                       BitVector bFlags) const;
 198
 199     /*! \}                                                                 */
 200     /*=========================  PROTECTED  ===============================*/
 201
 202   protected:
 203
 204     static TypeObject _type;
 205
 206     static       void   classDescInserter(TypeObject &oType);
 207     static const Char8 *getClassname     (void             );
 208
 209     /*---------------------------------------------------------------------*/
 210     /*! \name                      Fields                                  */
 211     /*! \{                                                                 */
 212
 213     MFVec3f           _mfKeyValue;
 214     MFVec3f           _mfOutValue;
 215
 216     /*! \}                                                                 */
 217     /*---------------------------------------------------------------------*/
 218     /*! \name                   Constructors                               */
 219     /*! \{                                                                 */
 220
 221     VRMLNormalInterpolatorBase(void);
 222     VRMLNormalInterpolatorBase(const VRMLNormalInterpolatorBase &source);
 223
 224     /*! \}                                                                 */
 225     /*---------------------------------------------------------------------*/
 226     /*! \name                   Destructors                                */
 227     /*! \{                                                                 */
 228
 229     virtual ~VRMLNormalInterpolatorBase(void);
 230
 231     /*! \}                                                                 */
 232     /*---------------------------------------------------------------------*/
 233     /*! \name                     onCreate                                */
 234     /*! \{                                                                 */
 235
 236
 237     /*! \}                                                                 */
 238     /*---------------------------------------------------------------------*/
 239     /*! \name                    Generic Field Access                      */
 240     /*! \{                                                                 */
 241
 242      GetFieldHandlePtr  getHandleKeyValue        (void) const;
 243      EditFieldHandlePtr editHandleKeyValue       (void);
 244      GetFieldHandlePtr  getHandleOutValue        (void) const;
 245      EditFieldHandlePtr editHandleOutValue       (void);
 246
 247     /*! \}                                                                 */
 248     /*---------------------------------------------------------------------*/
 249     /*! \name                       Sync                                   */
 250     /*! \{                                                                 */
 251
 252 #ifdef OSG_MT_CPTR_ASPECT
 253     virtual void execSyncV(      FieldContainer    &oFrom,
 254                                  ConstFieldMaskArg  whichField,
 255                                  AspectOffsetStore &oOffsets,
 256                                  ConstFieldMaskArg  syncMode  ,
 257                            const UInt32             uiSyncInfo);
 258
 259             void execSync (      VRMLNormalInterpolatorBase *pFrom,
 260                                  ConstFieldMaskArg  whichField,
 261                                  AspectOffsetStore &oOffsets,
 262                                  ConstFieldMaskArg  syncMode  ,
 263                            const UInt32             uiSyncInfo);
 264 #endif
 265
 266     /*! \}                                                                 */
 267     /*---------------------------------------------------------------------*/
 268     /*! \name                       Edit                                   */
 269     /*! \{                                                                 */
 270
 271     /*! \}                                                                 */
 272     /*---------------------------------------------------------------------*/
 273     /*! \name                     Aspect Create                            */
 274     /*! \{                                                                 */
 275
 276 #ifdef OSG_MT_CPTR_ASPECT
 277     virtual FieldContainer *createAspectCopy(
 278                                     const FieldContainer *pRefAspect) const;
 279 #endif
 280
 281     /*! \}                                                                 */
 282     /*---------------------------------------------------------------------*/
 283     /*! \name                       Edit                                   */
 284     /*! \{                                                                 */
 285     /*! \}                                                                 */
 286     /*---------------------------------------------------------------------*/
 287     /*! \name                       Sync                                   */
 288     /*! \{                                                                 */
 289
 290     virtual void resolveLinks(void);
 291
 292     /*! \}                                                                 */
 293     /*==========================  PRIVATE  ================================*/
 294
 295   private:
 296     /*---------------------------------------------------------------------*/
 297
 298     // prohibit default functions (move to 'public' if you need one)
 299     void operator =(const VRMLNormalInterpolatorBase &source);
 300 };
 301
 302 typedef VRMLNormalInterpolatorBase *VRMLNormalInterpolatorBaseP;
 303
 304 typedef CoredNodeRefPtr  <VRMLNormalInterpolator> VRMLNormalInterpolatorNodeRefPtr;
 305 typedef CoredNodeMTRefPtr<VRMLNormalInterpolator> VRMLNormalInterpolatorNodeMTRefPtr;
 306
 307 OSG_END_NAMESPACE
 308
 309 #endif /* _OSGVRMLNORMALINTERPOLATORBASE_H_ */