Source/System/Dynamics/VRMLAnimation/OSGVRMLInterpolatorBase.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 VRMLInterpolator!
  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 "OSGVRMLInterpolatorBase.h"
  67 #include "OSGVRMLInterpolator.h"
  68
  69 #include <boost/bind.hpp>
  70
  71 OSG_BEGIN_NAMESPACE
  72
  73 /***************************************************************************\
  74  *                            Description                                  *
  75 \***************************************************************************/
  76
  77 /*! \class OSG::VRMLInterpolator
  78
  79  */
  80
  81 /***************************************************************************\
  82  *                        Field Documentation                              *
  83 \***************************************************************************/
  84
  85 /*! \var Real32          VRMLInterpolatorBase::_sfInValue
  86     This is VRML's fraction field.
  87 */
  88
  89 /*! \var Real32          VRMLInterpolatorBase::_mfKey
  90
  91 */
  92
  93 /*! \var UInt32          VRMLInterpolatorBase::_mfResortIndex
  94
  95 */
  96
  97
  98 /***************************************************************************\
  99  *                      FieldType/FieldTrait Instantiation                 *
 100 \***************************************************************************/
 101
 102 #if !defined(OSG_DO_DOC) || defined(OSG_DOC_DEV)
 103 PointerType FieldTraits<VRMLInterpolator *, nsOSG>::_type(
 104     "VRMLInterpolatorPtr",
 105     "NodeCorePtr",
 106     VRMLInterpolator::getClassType(),
 107     nsOSG);
 108 #endif
 109
 110 OSG_FIELDTRAITS_GETTYPE_NS(VRMLInterpolator *, nsOSG)
 111
 112 /***************************************************************************\
 113  *                         Field Description                               *
 114 \***************************************************************************/
 115
 116 void VRMLInterpolatorBase::classDescInserter(TypeObject &oType)
 117 {
 118     FieldDescriptionBase *pDesc = NULL;
 119
 120
 121     pDesc = new SFReal32::Description(
 122         SFReal32::getClassType(),
 123         "inValue",
 124         "This is VRML's fraction field.\n",
 125         InValueFieldId, InValueFieldMask,
 126         true,
 127         (Field::FStdAccess | Field::FThreadLocal),
 128         static_cast<FieldEditMethodSig>(&VRMLInterpolator::editHandleInValue),
 129         static_cast<FieldGetMethodSig >(&VRMLInterpolator::getHandleInValue));
 130
 131     oType.addInitialDesc(pDesc);
 132
 133     pDesc = new MFReal32::Description(
 134         MFReal32::getClassType(),
 135         "key",
 136         "",
 137         KeyFieldId, KeyFieldMask,
 138         false,
 139         (Field::FStdAccess | Field::FThreadLocal),
 140         static_cast<FieldEditMethodSig>(&VRMLInterpolator::editHandleKey),
 141         static_cast<FieldGetMethodSig >(&VRMLInterpolator::getHandleKey));
 142
 143     oType.addInitialDesc(pDesc);
 144
 145     pDesc = new MFUInt32::Description(
 146         MFUInt32::getClassType(),
 147         "resortIndex",
 148         "",
 149         ResortIndexFieldId, ResortIndexFieldMask,
 150         false,
 151         (Field::FStdAccess | Field::FThreadLocal),
 152         static_cast<FieldEditMethodSig>(&VRMLInterpolator::editHandleResortIndex),
 153         static_cast<FieldGetMethodSig >(&VRMLInterpolator::getHandleResortIndex));
 154
 155     oType.addInitialDesc(pDesc);
 156 }
 157
 158
 159 VRMLInterpolatorBase::TypeObject VRMLInterpolatorBase::_type(
 160     VRMLInterpolatorBase::getClassname(),
 161     Inherited::getClassname(),
 162     "NULL",
 163     nsOSG, //Namespace
 164     reinterpret_cast<PrototypeCreateF>(&VRMLInterpolatorBase::createEmptyLocal),
 165     reinterpret_cast<InitContainerF>(&VRMLInterpolator::initMethod),
 166     reinterpret_cast<ExitContainerF>(&VRMLInterpolator::exitMethod),
 167     reinterpret_cast<InitalInsertDescFunc>(
 168         reinterpret_cast<void *>(&VRMLInterpolator::classDescInserter)),
 169     false,
 170     ResortIndexFieldMask,
 171     "<?xml version=\"1.0\"?>\n"
 172     "\n"
 173     "<FieldContainer\n"
 174     "    name=\"VRMLInterpolator\"\n"
 175     "    parent=\"NodeCore\"\n"
 176     "    library=\"Dynamics\"\n"
 177     "    pointerfieldtypes=\"none\"\n"
 178     "    structure=\"concrete\"\n"
 179     "    systemcomponent=\"true\"\n"
 180     "    parentsystemcomponent=\"true\"\n"
 181     "    decoratable=\"false\"\n"
 182     "    useLocalIncludes=\"false\"\n"
 183     "    isNodeCore=\"true\"\n"
 184     "    isBundle=\"false\"\n"
 185     "    parentFields=\"none\"\n"
 186     "    fieldsUnmarkedOnCreate=\"ResortIndexFieldMask\"\n"
 187     "    docGroupBase=\"GrpDynamicsVRMLAnimation\"\n"
 188     "    >\n"
 189     "    <Field\n"
 190     "        name=\"inValue\"\n"
 191     "        type=\"Real32\"\n"
 192     "        cardinality=\"single\"\n"
 193     "        visibility=\"internal\"\n"
 194     "        access=\"public\"\n"
 195     "        defaultValue=\"0.f\"\n"
 196     "        fieldFlags=\"FStdAccess, FThreadLocal\"\n"
 197     "        >\n"
 198     "        This is VRML's fraction field.\n"
 199     "    </Field>\n"
 200     "    <Field\n"
 201     "        name=\"key\"\n"
 202     "        type=\"Real32\"\n"
 203     "        cardinality=\"multi\"\n"
 204     "        visibility=\"external\"\n"
 205     "        access=\"public\"\n"
 206     "        defaultValue=\"\"\n"
 207     "        fieldFlags=\"FStdAccess, FThreadLocal\"\n"
 208     "        >\n"
 209     "    </Field>\n"
 210     "    <Field\n"
 211     "        name=\"resortIndex\"\n"
 212     "        type=\"UInt32\"\n"
 213     "        cardinality=\"multi\"\n"
 214     "        visibility=\"external\"\n"
 215     "        access=\"public\"\n"
 216     "        defaultValue=\"\"\n"
 217     "        fieldFlags=\"FStdAccess, FThreadLocal\"\n"
 218     "        >\n"
 219     "    </Field>\n"
 220     "</FieldContainer>\n",
 221     ""
 222     );
 223
 224 /*------------------------------ get -----------------------------------*/
 225
 226 FieldContainerType &VRMLInterpolatorBase::getType(void)
 227 {
 228     return _type;
 229 }
 230
 231 const FieldContainerType &VRMLInterpolatorBase::getType(void) const
 232 {
 233     return _type;
 234 }
 235
 236 UInt32 VRMLInterpolatorBase::getContainerSize(void) const
 237 {
 238     return sizeof(VRMLInterpolator);
 239 }
 240
 241 /*------------------------- decorator get ------------------------------*/
 242
 243
 244 SFReal32 *VRMLInterpolatorBase::editSFInValue(void)
 245 {
 246     editSField(InValueFieldMask);
 247
 248     return &_sfInValue;
 249 }
 250
 251 const SFReal32 *VRMLInterpolatorBase::getSFInValue(void) const
 252 {
 253     return &_sfInValue;
 254 }
 255
 256
 257 MFReal32 *VRMLInterpolatorBase::editMFKey(void)
 258 {
 259     editMField(KeyFieldMask, _mfKey);
 260
 261     return &_mfKey;
 262 }
 263
 264 const MFReal32 *VRMLInterpolatorBase::getMFKey(void) const
 265 {
 266     return &_mfKey;
 267 }
 268
 269
 270 MFUInt32 *VRMLInterpolatorBase::editMFResortIndex(void)
 271 {
 272     editMField(ResortIndexFieldMask, _mfResortIndex);
 273
 274     return &_mfResortIndex;
 275 }
 276
 277 const MFUInt32 *VRMLInterpolatorBase::getMFResortIndex(void) const
 278 {
 279     return &_mfResortIndex;
 280 }
 281
 282
 283
 284
 285
 286
 287 /*------------------------------ access -----------------------------------*/
 288
 289 SizeT VRMLInterpolatorBase::getBinSize(ConstFieldMaskArg whichField)
 290 {
 291     SizeT returnValue = Inherited::getBinSize(whichField);
 292
 293     if(FieldBits::NoField != (InValueFieldMask & whichField))
 294     {
 295         returnValue += _sfInValue.getBinSize();
 296     }
 297     if(FieldBits::NoField != (KeyFieldMask & whichField))
 298     {
 299         returnValue += _mfKey.getBinSize();
 300     }
 301     if(FieldBits::NoField != (ResortIndexFieldMask & whichField))
 302     {
 303         returnValue += _mfResortIndex.getBinSize();
 304     }
 305
 306     return returnValue;
 307 }
 308
 309 void VRMLInterpolatorBase::copyToBin(BinaryDataHandler &pMem,
 310                                   ConstFieldMaskArg  whichField)
 311 {
 312     Inherited::copyToBin(pMem, whichField);
 313
 314     if(FieldBits::NoField != (InValueFieldMask & whichField))
 315     {
 316         _sfInValue.copyToBin(pMem);
 317     }
 318     if(FieldBits::NoField != (KeyFieldMask & whichField))
 319     {
 320         _mfKey.copyToBin(pMem);
 321     }
 322     if(FieldBits::NoField != (ResortIndexFieldMask & whichField))
 323     {
 324         _mfResortIndex.copyToBin(pMem);
 325     }
 326 }
 327
 328 void VRMLInterpolatorBase::copyFromBin(BinaryDataHandler &pMem,
 329                                     ConstFieldMaskArg  whichField)
 330 {
 331     Inherited::copyFromBin(pMem, whichField);
 332
 333     if(FieldBits::NoField != (InValueFieldMask & whichField))
 334     {
 335         editSField(InValueFieldMask);
 336         _sfInValue.copyFromBin(pMem);
 337     }
 338     if(FieldBits::NoField != (KeyFieldMask & whichField))
 339     {
 340         editMField(KeyFieldMask, _mfKey);
 341         _mfKey.copyFromBin(pMem);
 342     }
 343     if(FieldBits::NoField != (ResortIndexFieldMask & whichField))
 344     {
 345         editMField(ResortIndexFieldMask, _mfResortIndex);
 346         _mfResortIndex.copyFromBin(pMem);
 347     }
 348 }
 349
 350 //! create a new instance of the class
 351 VRMLInterpolatorTransitPtr VRMLInterpolatorBase::createLocal(BitVector bFlags)
 352 {
 353     VRMLInterpolatorTransitPtr fc;
 354
 355     if(getClassType().getPrototype() != NULL)
 356     {
 357         FieldContainerTransitPtr tmpPtr =
 358             getClassType().getPrototype()-> shallowCopyLocal(bFlags);
 359
 360         fc = dynamic_pointer_cast<VRMLInterpolator>(tmpPtr);
 361     }
 362
 363     return fc;
 364 }
 365
 366 //! create a new instance of the class, copy the container flags
 367 VRMLInterpolatorTransitPtr VRMLInterpolatorBase::createDependent(BitVector bFlags)
 368 {
 369     VRMLInterpolatorTransitPtr fc;
 370
 371     if(getClassType().getPrototype() != NULL)
 372     {
 373         FieldContainerTransitPtr tmpPtr =
 374             getClassType().getPrototype()-> shallowCopyDependent(bFlags);
 375
 376         fc = dynamic_pointer_cast<VRMLInterpolator>(tmpPtr);
 377     }
 378
 379     return fc;
 380 }
 381
 382 //! create a new instance of the class
 383 VRMLInterpolatorTransitPtr VRMLInterpolatorBase::create(void)
 384 {
 385     VRMLInterpolatorTransitPtr fc;
 386
 387     if(getClassType().getPrototype() != NULL)
 388     {
 389         FieldContainerTransitPtr tmpPtr =
 390             getClassType().getPrototype()-> shallowCopy();
 391
 392         fc = dynamic_pointer_cast<VRMLInterpolator>(tmpPtr);
 393     }
 394
 395     return fc;
 396 }
 397
 398 VRMLInterpolator *VRMLInterpolatorBase::createEmptyLocal(BitVector bFlags)
 399 {
 400     VRMLInterpolator *returnValue;
 401
 402     newPtr<VRMLInterpolator>(returnValue, bFlags);
 403
 404     returnValue->_pFieldFlags->_bNamespaceMask &= ~bFlags;
 405
 406     return returnValue;
 407 }
 408
 409 //! create an empty new instance of the class, do not copy the prototype
 410 VRMLInterpolator *VRMLInterpolatorBase::createEmpty(void)
 411 {
 412     VRMLInterpolator *returnValue;
 413
 414     newPtr<VRMLInterpolator>(returnValue, Thread::getCurrentLocalFlags());
 415
 416     returnValue->_pFieldFlags->_bNamespaceMask &=
 417         ~Thread::getCurrentLocalFlags();
 418
 419     return returnValue;
 420 }
 421
 422
 423 FieldContainerTransitPtr VRMLInterpolatorBase::shallowCopyLocal(
 424     BitVector bFlags) const
 425 {
 426     VRMLInterpolator *tmpPtr;
 427
 428     newPtr(tmpPtr, dynamic_cast<const VRMLInterpolator *>(this), bFlags);
 429
 430     FieldContainerTransitPtr returnValue(tmpPtr);
 431
 432     tmpPtr->_pFieldFlags->_bNamespaceMask &= ~bFlags;
 433
 434     return returnValue;
 435 }
 436
 437 FieldContainerTransitPtr VRMLInterpolatorBase::shallowCopyDependent(
 438     BitVector bFlags) const
 439 {
 440     VRMLInterpolator *tmpPtr;
 441
 442     newPtr(tmpPtr, dynamic_cast<const VRMLInterpolator *>(this), ~bFlags);
 443
 444     FieldContainerTransitPtr returnValue(tmpPtr);
 445
 446     tmpPtr->_pFieldFlags->_bNamespaceMask = bFlags;
 447
 448     return returnValue;
 449 }
 450
 451 FieldContainerTransitPtr VRMLInterpolatorBase::shallowCopy(void) const
 452 {
 453     VRMLInterpolator *tmpPtr;
 454
 455     newPtr(tmpPtr,
 456            dynamic_cast<const VRMLInterpolator *>(this),
 457            Thread::getCurrentLocalFlags());
 458
 459     tmpPtr->_pFieldFlags->_bNamespaceMask &= ~Thread::getCurrentLocalFlags();
 460
 461     FieldContainerTransitPtr returnValue(tmpPtr);
 462
 463     return returnValue;
 464 }
 465
 466
 467
 468
 469 /*------------------------- constructors ----------------------------------*/
 470
 471 VRMLInterpolatorBase::VRMLInterpolatorBase(void) :
 472     Inherited(),
 473     _sfInValue                (Real32(0.f)),
 474     _mfKey                    (),
 475     _mfResortIndex            ()
 476 {
 477 }
 478
 479 VRMLInterpolatorBase::VRMLInterpolatorBase(const VRMLInterpolatorBase &source) :
 480     Inherited(source),
 481     _sfInValue                (source._sfInValue                ),
 482     _mfKey                    (source._mfKey                    ),
 483     _mfResortIndex            (source._mfResortIndex            )
 484 {
 485 }
 486
 487
 488 /*-------------------------- destructors ----------------------------------*/
 489
 490 VRMLInterpolatorBase::~VRMLInterpolatorBase(void)
 491 {
 492 }
 493
 494
 495 GetFieldHandlePtr VRMLInterpolatorBase::getHandleInValue         (void) const
 496 {
 497     SFReal32::GetHandlePtr returnValue(
 498         new  SFReal32::GetHandle(
 499              &_sfInValue,
 500              this->getType().getFieldDesc(InValueFieldId),
 501              const_cast<VRMLInterpolatorBase *>(this)));
 502
 503     return returnValue;
 504 }
 505
 506 EditFieldHandlePtr VRMLInterpolatorBase::editHandleInValue        (void)
 507 {
 508     SFReal32::EditHandlePtr returnValue(
 509         new  SFReal32::EditHandle(
 510              &_sfInValue,
 511              this->getType().getFieldDesc(InValueFieldId),
 512              this));
 513
 514
 515     editSField(InValueFieldMask);
 516
 517     return returnValue;
 518 }
 519
 520 GetFieldHandlePtr VRMLInterpolatorBase::getHandleKey             (void) const
 521 {
 522     MFReal32::GetHandlePtr returnValue(
 523         new  MFReal32::GetHandle(
 524              &_mfKey,
 525              this->getType().getFieldDesc(KeyFieldId),
 526              const_cast<VRMLInterpolatorBase *>(this)));
 527
 528     return returnValue;
 529 }
 530
 531 EditFieldHandlePtr VRMLInterpolatorBase::editHandleKey            (void)
 532 {
 533     MFReal32::EditHandlePtr returnValue(
 534         new  MFReal32::EditHandle(
 535              &_mfKey,
 536              this->getType().getFieldDesc(KeyFieldId),
 537              this));
 538
 539
 540     editMField(KeyFieldMask, _mfKey);
 541
 542     return returnValue;
 543 }
 544
 545 GetFieldHandlePtr VRMLInterpolatorBase::getHandleResortIndex     (void) const
 546 {
 547     MFUInt32::GetHandlePtr returnValue(
 548         new  MFUInt32::GetHandle(
 549              &_mfResortIndex,
 550              this->getType().getFieldDesc(ResortIndexFieldId),
 551              const_cast<VRMLInterpolatorBase *>(this)));
 552
 553     return returnValue;
 554 }
 555
 556 EditFieldHandlePtr VRMLInterpolatorBase::editHandleResortIndex    (void)
 557 {
 558     MFUInt32::EditHandlePtr returnValue(
 559         new  MFUInt32::EditHandle(
 560              &_mfResortIndex,
 561              this->getType().getFieldDesc(ResortIndexFieldId),
 562              this));
 563
 564
 565     editMField(ResortIndexFieldMask, _mfResortIndex);
 566
 567     return returnValue;
 568 }
 569
 570
 571 #ifdef OSG_MT_CPTR_ASPECT
 572 void VRMLInterpolatorBase::execSyncV(      FieldContainer    &oFrom,
 573                                         ConstFieldMaskArg  whichField,
 574                                         AspectOffsetStore &oOffsets,
 575                                         ConstFieldMaskArg  syncMode,
 576                                   const UInt32             uiSyncInfo)
 577 {
 578     VRMLInterpolator *pThis = static_cast<VRMLInterpolator *>(this);
 579
 580     pThis->execSync(static_cast<VRMLInterpolator *>(&oFrom),
 581                     whichField,
 582                     oOffsets,
 583                     syncMode,
 584                     uiSyncInfo);
 585 }
 586 #endif
 587
 588
 589 #ifdef OSG_MT_CPTR_ASPECT
 590 FieldContainer *VRMLInterpolatorBase::createAspectCopy(
 591     const FieldContainer *pRefAspect) const
 592 {
 593     VRMLInterpolator *returnValue;
 594
 595     newAspectCopy(returnValue,
 596                   dynamic_cast<const VRMLInterpolator *>(pRefAspect),
 597                   dynamic_cast<const VRMLInterpolator *>(this));
 598
 599     return returnValue;
 600 }
 601 #endif
 602
 603 void VRMLInterpolatorBase::resolveLinks(void)
 604 {
 605     Inherited::resolveLinks();
 606
 607 #ifdef OSG_MT_CPTR_ASPECT
 608     AspectOffsetStore oOffsets;
 609
 610     _pAspectStore->fillOffsetArray(oOffsets, this);
 611 #endif
 612
 613 #ifdef OSG_MT_CPTR_ASPECT
 614     _mfKey.terminateShare(Thread::getCurrentAspect(),
 615                                       oOffsets);
 616 #endif
 617 #ifdef OSG_MT_CPTR_ASPECT
 618     _mfResortIndex.terminateShare(Thread::getCurrentAspect(),
 619                                       oOffsets);
 620 #endif
 621 }
 622
 623
 624 OSG_END_NAMESPACE