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