Source/System/Dynamics/VRMLAnimation/OSGVRMLScalarInterpolatorBase.cpp

   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 #include <cstdlib>
  54 #include <cstdio>
  55
  56 #ifdef WIN32
  57 #pragma warning(disable: 4355) // turn off 'this' : used in base member initializer list warning
  58 #pragma warning(disable: 4290) // disable exception specification warning
  59 #endif
  60
  61 #include "OSGConfig.h"
  62
  63
  64
  65
  66 #include "OSGVRMLScalarInterpolatorBase.h"
  67 #include "OSGVRMLScalarInterpolator.h"
  68
  69 #include <boost/bind.hpp>
  70
  71 OSG_BEGIN_NAMESPACE
  72
  73 /***************************************************************************\
  74  *                            Description                                  *
  75 \***************************************************************************/
  76
  77 /*! \class OSG::VRMLScalarInterpolator
  78
  79  */
  80
  81 /***************************************************************************\
  82  *                        Field Documentation                              *
  83 \***************************************************************************/
  84
  85 /*! \var Real32          VRMLScalarInterpolatorBase::_mfKeyValue
  86
  87 */
  88
  89 /*! \var Real32          VRMLScalarInterpolatorBase::_sfOutValue
  90     This is VRML's value field.
  91 */
  92
  93
  94 /***************************************************************************\
  95  *                      FieldType/FieldTrait Instantiation                 *
  96 \***************************************************************************/
  97
  98 #if !defined(OSG_DO_DOC) || defined(OSG_DOC_DEV)
  99 PointerType FieldTraits<VRMLScalarInterpolator *, nsOSG>::_type(
 100     "VRMLScalarInterpolatorPtr",
 101     "VRMLInterpolatorPtr",
 102     VRMLScalarInterpolator::getClassType(),
 103     nsOSG);
 104 #endif
 105
 106 OSG_FIELDTRAITS_GETTYPE_NS(VRMLScalarInterpolator *, nsOSG)
 107
 108 /***************************************************************************\
 109  *                         Field Description                               *
 110 \***************************************************************************/
 111
 112 void VRMLScalarInterpolatorBase::classDescInserter(TypeObject &oType)
 113 {
 114     FieldDescriptionBase *pDesc = NULL;
 115
 116
 117     pDesc = new MFReal32::Description(
 118         MFReal32::getClassType(),
 119         "keyValue",
 120         "",
 121         KeyValueFieldId, KeyValueFieldMask,
 122         false,
 123         (Field::FStdAccess | Field::FThreadLocal),
 124         static_cast<FieldEditMethodSig>(&VRMLScalarInterpolator::editHandleKeyValue),
 125         static_cast<FieldGetMethodSig >(&VRMLScalarInterpolator::getHandleKeyValue));
 126
 127     oType.addInitialDesc(pDesc);
 128
 129     pDesc = new SFReal32::Description(
 130         SFReal32::getClassType(),
 131         "outValue",
 132         "This is VRML's value field.\n",
 133         OutValueFieldId, OutValueFieldMask,
 134         true,
 135         (Field::FStdAccess | Field::FThreadLocal),
 136         static_cast<FieldEditMethodSig>(&VRMLScalarInterpolator::editHandleOutValue),
 137         static_cast<FieldGetMethodSig >(&VRMLScalarInterpolator::getHandleOutValue));
 138
 139     oType.addInitialDesc(pDesc);
 140 }
 141
 142
 143 VRMLScalarInterpolatorBase::TypeObject VRMLScalarInterpolatorBase::_type(
 144     VRMLScalarInterpolatorBase::getClassname(),
 145     Inherited::getClassname(),
 146     "NULL",
 147     nsOSG, //Namespace
 148     reinterpret_cast<PrototypeCreateF>(&VRMLScalarInterpolatorBase::createEmptyLocal),
 149     reinterpret_cast<InitContainerF>(&VRMLScalarInterpolator::initMethod),
 150     reinterpret_cast<ExitContainerF>(&VRMLScalarInterpolator::exitMethod),
 151     reinterpret_cast<InitalInsertDescFunc>(
 152         reinterpret_cast<void *>(&VRMLScalarInterpolator::classDescInserter)),
 153     false,
 154     0,
 155     "<?xml version=\"1.0\"?>\n"
 156     "\n"
 157     "<FieldContainer\n"
 158     "    name=\"VRMLScalarInterpolator\"\n"
 159     "    parent=\"VRMLInterpolator\"\n"
 160     "    library=\"Dynamics\"\n"
 161     "    pointerfieldtypes=\"none\"\n"
 162     "    structure=\"concrete\"\n"
 163     "    systemcomponent=\"true\"\n"
 164     "    parentsystemcomponent=\"true\"\n"
 165     "    decoratable=\"false\"\n"
 166     "    useLocalIncludes=\"false\"\n"
 167     "    isNodeCore=\"true\"\n"
 168     "    isBundle=\"false\"\n"
 169     "    parentFields=\"none\"\n"
 170     "    docGroupBase=\"GrpDynamicsVRMLAnimation\"\n"
 171     "    >\n"
 172     "    <Field\n"
 173     "        name=\"keyValue\"\n"
 174     "        type=\"Real32\"\n"
 175     "        cardinality=\"multi\"\n"
 176     "        visibility=\"external\"\n"
 177     "        access=\"public\"\n"
 178     "        defaultValue=\"\"\n"
 179     "        fieldFlags=\"FStdAccess, FThreadLocal\"\n"
 180     "        >\n"
 181     "    </Field>\n"
 182     "    <Field\n"
 183     "        name=\"outValue\"\n"
 184     "        type=\"Real32\"\n"
 185     "        cardinality=\"single\"\n"
 186     "        visibility=\"internal\"\n"
 187     "        access=\"public\"\n"
 188     "        defaultValue=\"\"\n"
 189     "        fieldFlags=\"FStdAccess, FThreadLocal\"\n"
 190     "        >\n"
 191     "        This is VRML's value field.\n"
 192     "    </Field>\n"
 193     "</FieldContainer>\n",
 194     ""
 195     );
 196
 197 /*------------------------------ get -----------------------------------*/
 198
 199 FieldContainerType &VRMLScalarInterpolatorBase::getType(void)
 200 {
 201     return _type;
 202 }
 203
 204 const FieldContainerType &VRMLScalarInterpolatorBase::getType(void) const
 205 {
 206     return _type;
 207 }
 208
 209 UInt32 VRMLScalarInterpolatorBase::getContainerSize(void) const
 210 {
 211     return sizeof(VRMLScalarInterpolator);
 212 }
 213
 214 /*------------------------- decorator get ------------------------------*/
 215
 216
 217 MFReal32 *VRMLScalarInterpolatorBase::editMFKeyValue(void)
 218 {
 219     editMField(KeyValueFieldMask, _mfKeyValue);
 220
 221     return &_mfKeyValue;
 222 }
 223
 224 const MFReal32 *VRMLScalarInterpolatorBase::getMFKeyValue(void) const
 225 {
 226     return &_mfKeyValue;
 227 }
 228
 229
 230 SFReal32 *VRMLScalarInterpolatorBase::editSFOutValue(void)
 231 {
 232     editSField(OutValueFieldMask);
 233
 234     return &_sfOutValue;
 235 }
 236
 237 const SFReal32 *VRMLScalarInterpolatorBase::getSFOutValue(void) const
 238 {
 239     return &_sfOutValue;
 240 }
 241
 242
 243
 244
 245
 246
 247 /*------------------------------ access -----------------------------------*/
 248
 249 SizeT VRMLScalarInterpolatorBase::getBinSize(ConstFieldMaskArg whichField)
 250 {
 251     SizeT returnValue = Inherited::getBinSize(whichField);
 252
 253     if(FieldBits::NoField != (KeyValueFieldMask & whichField))
 254     {
 255         returnValue += _mfKeyValue.getBinSize();
 256     }
 257     if(FieldBits::NoField != (OutValueFieldMask & whichField))
 258     {
 259         returnValue += _sfOutValue.getBinSize();
 260     }
 261
 262     return returnValue;
 263 }
 264
 265 void VRMLScalarInterpolatorBase::copyToBin(BinaryDataHandler &pMem,
 266                                   ConstFieldMaskArg  whichField)
 267 {
 268     Inherited::copyToBin(pMem, whichField);
 269
 270     if(FieldBits::NoField != (KeyValueFieldMask & whichField))
 271     {
 272         _mfKeyValue.copyToBin(pMem);
 273     }
 274     if(FieldBits::NoField != (OutValueFieldMask & whichField))
 275     {
 276         _sfOutValue.copyToBin(pMem);
 277     }
 278 }
 279
 280 void VRMLScalarInterpolatorBase::copyFromBin(BinaryDataHandler &pMem,
 281                                     ConstFieldMaskArg  whichField)
 282 {
 283     Inherited::copyFromBin(pMem, whichField);
 284
 285     if(FieldBits::NoField != (KeyValueFieldMask & whichField))
 286     {
 287         editMField(KeyValueFieldMask, _mfKeyValue);
 288         _mfKeyValue.copyFromBin(pMem);
 289     }
 290     if(FieldBits::NoField != (OutValueFieldMask & whichField))
 291     {
 292         editSField(OutValueFieldMask);
 293         _sfOutValue.copyFromBin(pMem);
 294     }
 295 }
 296
 297 //! create a new instance of the class
 298 VRMLScalarInterpolatorTransitPtr VRMLScalarInterpolatorBase::createLocal(BitVector bFlags)
 299 {
 300     VRMLScalarInterpolatorTransitPtr fc;
 301
 302     if(getClassType().getPrototype() != NULL)
 303     {
 304         FieldContainerTransitPtr tmpPtr =
 305             getClassType().getPrototype()-> shallowCopyLocal(bFlags);
 306
 307         fc = dynamic_pointer_cast<VRMLScalarInterpolator>(tmpPtr);
 308     }
 309
 310     return fc;
 311 }
 312
 313 //! create a new instance of the class, copy the container flags
 314 VRMLScalarInterpolatorTransitPtr VRMLScalarInterpolatorBase::createDependent(BitVector bFlags)
 315 {
 316     VRMLScalarInterpolatorTransitPtr fc;
 317
 318     if(getClassType().getPrototype() != NULL)
 319     {
 320         FieldContainerTransitPtr tmpPtr =
 321             getClassType().getPrototype()-> shallowCopyDependent(bFlags);
 322
 323         fc = dynamic_pointer_cast<VRMLScalarInterpolator>(tmpPtr);
 324     }
 325
 326     return fc;
 327 }
 328
 329 //! create a new instance of the class
 330 VRMLScalarInterpolatorTransitPtr VRMLScalarInterpolatorBase::create(void)
 331 {
 332     VRMLScalarInterpolatorTransitPtr fc;
 333
 334     if(getClassType().getPrototype() != NULL)
 335     {
 336         FieldContainerTransitPtr tmpPtr =
 337             getClassType().getPrototype()-> shallowCopy();
 338
 339         fc = dynamic_pointer_cast<VRMLScalarInterpolator>(tmpPtr);
 340     }
 341
 342     return fc;
 343 }
 344
 345 VRMLScalarInterpolator *VRMLScalarInterpolatorBase::createEmptyLocal(BitVector bFlags)
 346 {
 347     VRMLScalarInterpolator *returnValue;
 348
 349     newPtr<VRMLScalarInterpolator>(returnValue, bFlags);
 350
 351     returnValue->_pFieldFlags->_bNamespaceMask &= ~bFlags;
 352
 353     return returnValue;
 354 }
 355
 356 //! create an empty new instance of the class, do not copy the prototype
 357 VRMLScalarInterpolator *VRMLScalarInterpolatorBase::createEmpty(void)
 358 {
 359     VRMLScalarInterpolator *returnValue;
 360
 361     newPtr<VRMLScalarInterpolator>(returnValue, Thread::getCurrentLocalFlags());
 362
 363     returnValue->_pFieldFlags->_bNamespaceMask &=
 364         ~Thread::getCurrentLocalFlags();
 365
 366     return returnValue;
 367 }
 368
 369
 370 FieldContainerTransitPtr VRMLScalarInterpolatorBase::shallowCopyLocal(
 371     BitVector bFlags) const
 372 {
 373     VRMLScalarInterpolator *tmpPtr;
 374
 375     newPtr(tmpPtr, dynamic_cast<const VRMLScalarInterpolator *>(this), bFlags);
 376
 377     FieldContainerTransitPtr returnValue(tmpPtr);
 378
 379     tmpPtr->_pFieldFlags->_bNamespaceMask &= ~bFlags;
 380
 381     return returnValue;
 382 }
 383
 384 FieldContainerTransitPtr VRMLScalarInterpolatorBase::shallowCopyDependent(
 385     BitVector bFlags) const
 386 {
 387     VRMLScalarInterpolator *tmpPtr;
 388
 389     newPtr(tmpPtr, dynamic_cast<const VRMLScalarInterpolator *>(this), ~bFlags);
 390
 391     FieldContainerTransitPtr returnValue(tmpPtr);
 392
 393     tmpPtr->_pFieldFlags->_bNamespaceMask = bFlags;
 394
 395     return returnValue;
 396 }
 397
 398 FieldContainerTransitPtr VRMLScalarInterpolatorBase::shallowCopy(void) const
 399 {
 400     VRMLScalarInterpolator *tmpPtr;
 401
 402     newPtr(tmpPtr,
 403            dynamic_cast<const VRMLScalarInterpolator *>(this),
 404            Thread::getCurrentLocalFlags());
 405
 406     tmpPtr->_pFieldFlags->_bNamespaceMask &= ~Thread::getCurrentLocalFlags();
 407
 408     FieldContainerTransitPtr returnValue(tmpPtr);
 409
 410     return returnValue;
 411 }
 412
 413
 414
 415
 416 /*------------------------- constructors ----------------------------------*/
 417
 418 VRMLScalarInterpolatorBase::VRMLScalarInterpolatorBase(void) :
 419     Inherited(),
 420     _mfKeyValue               (),
 421     _sfOutValue               ()
 422 {
 423 }
 424
 425 VRMLScalarInterpolatorBase::VRMLScalarInterpolatorBase(const VRMLScalarInterpolatorBase &source) :
 426     Inherited(source),
 427     _mfKeyValue               (source._mfKeyValue               ),
 428     _sfOutValue               (source._sfOutValue               )
 429 {
 430 }
 431
 432
 433 /*-------------------------- destructors ----------------------------------*/
 434
 435 VRMLScalarInterpolatorBase::~VRMLScalarInterpolatorBase(void)
 436 {
 437 }
 438
 439
 440 GetFieldHandlePtr VRMLScalarInterpolatorBase::getHandleKeyValue        (void) const
 441 {
 442     MFReal32::GetHandlePtr returnValue(
 443         new  MFReal32::GetHandle(
 444              &_mfKeyValue,
 445              this->getType().getFieldDesc(KeyValueFieldId),
 446              const_cast<VRMLScalarInterpolatorBase *>(this)));
 447
 448     return returnValue;
 449 }
 450
 451 EditFieldHandlePtr VRMLScalarInterpolatorBase::editHandleKeyValue       (void)
 452 {
 453     MFReal32::EditHandlePtr returnValue(
 454         new  MFReal32::EditHandle(
 455              &_mfKeyValue,
 456              this->getType().getFieldDesc(KeyValueFieldId),
 457              this));
 458
 459
 460     editMField(KeyValueFieldMask, _mfKeyValue);
 461
 462     return returnValue;
 463 }
 464
 465 GetFieldHandlePtr VRMLScalarInterpolatorBase::getHandleOutValue        (void) const
 466 {
 467     SFReal32::GetHandlePtr returnValue(
 468         new  SFReal32::GetHandle(
 469              &_sfOutValue,
 470              this->getType().getFieldDesc(OutValueFieldId),
 471              const_cast<VRMLScalarInterpolatorBase *>(this)));
 472
 473     return returnValue;
 474 }
 475
 476 EditFieldHandlePtr VRMLScalarInterpolatorBase::editHandleOutValue       (void)
 477 {
 478     SFReal32::EditHandlePtr returnValue(
 479         new  SFReal32::EditHandle(
 480              &_sfOutValue,
 481              this->getType().getFieldDesc(OutValueFieldId),
 482              this));
 483
 484
 485     editSField(OutValueFieldMask);
 486
 487     return returnValue;
 488 }
 489
 490
 491 #ifdef OSG_MT_CPTR_ASPECT
 492 void VRMLScalarInterpolatorBase::execSyncV(      FieldContainer    &oFrom,
 493                                         ConstFieldMaskArg  whichField,
 494                                         AspectOffsetStore &oOffsets,
 495                                         ConstFieldMaskArg  syncMode,
 496                                   const UInt32             uiSyncInfo)
 497 {
 498     VRMLScalarInterpolator *pThis = static_cast<VRMLScalarInterpolator *>(this);
 499
 500     pThis->execSync(static_cast<VRMLScalarInterpolator *>(&oFrom),
 501                     whichField,
 502                     oOffsets,
 503                     syncMode,
 504                     uiSyncInfo);
 505 }
 506 #endif
 507
 508
 509 #ifdef OSG_MT_CPTR_ASPECT
 510 FieldContainer *VRMLScalarInterpolatorBase::createAspectCopy(
 511     const FieldContainer *pRefAspect) const
 512 {
 513     VRMLScalarInterpolator *returnValue;
 514
 515     newAspectCopy(returnValue,
 516                   dynamic_cast<const VRMLScalarInterpolator *>(pRefAspect),
 517                   dynamic_cast<const VRMLScalarInterpolator *>(this));
 518
 519     return returnValue;
 520 }
 521 #endif
 522
 523 void VRMLScalarInterpolatorBase::resolveLinks(void)
 524 {
 525     Inherited::resolveLinks();
 526
 527 #ifdef OSG_MT_CPTR_ASPECT
 528     AspectOffsetStore oOffsets;
 529
 530     _pAspectStore->fillOffsetArray(oOffsets, this);
 531 #endif
 532
 533 #ifdef OSG_MT_CPTR_ASPECT
 534     _mfKeyValue.terminateShare(Thread::getCurrentAspect(),
 535                                       oOffsets);
 536 #endif
 537 }
 538
 539
 540 OSG_END_NAMESPACE