Source/Contrib/ComplexSceneManager/VRMLNodes/OSGSelectValueEmitter.inl

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-2006 by the OpenSG Forum                 *
   6  *                                                                           *
   7  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
   8  *                                                                           *
   9 \*---------------------------------------------------------------------------*/
  10 /*---------------------------------------------------------------------------*\
  11  *                                License                                    *
  12  *                                                                           *
  13  * This library is free software; you can redistribute it and/or modify it   *
  14  * under the terms of the GNU Library General Public License as published    *
  15  * by the Free Software Foundation, version 2.                               *
  16  *                                                                           *
  17  * This library is distributed in the hope that it will be useful, but       *
  18  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  20  * Library General Public License for more details.                          *
  21  *                                                                           *
  22  * You should have received a copy of the GNU Library General Public         *
  23  * License along with this library; if not, write to the Free Software       *
  24  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  25  *                                                                           *
  26 \*---------------------------------------------------------------------------*/
  27 /*---------------------------------------------------------------------------*\
  28  *                                Changes                                    *
  29  *                                                                           *
  30  *                                                                           *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35 \*---------------------------------------------------------------------------*/
  36
  37 OSG_BEGIN_NAMESPACE
  38
  39 template<class Desc> inline
  40 UInt32 SelectSValueEmitter<Desc>::getContainerSize(void) const
  41 {
  42     return sizeof(Self);
  43 }
  44
  45 template<class Desc> inline
  46 typename SelectSValueEmitter<Desc>::SFChoiceType *
  47     SelectSValueEmitter<Desc>::editSFChoice(void)
  48 {
  49     editSField(ChoiceFieldMask);
  50
  51     return &_sfChoice;
  52 }
  53
  54 template<class Desc> inline
  55 const typename SelectSValueEmitter<Desc>::SFChoiceType *
  56     SelectSValueEmitter<Desc>::getSFChoice(void) const
  57 {
  58     return &_sfChoice;
  59 }
  60
  61 template<class Desc> inline
  62 typename SelectSValueEmitter<Desc>::ChoiceType &
  63     SelectSValueEmitter<Desc>::editChoice(void)
  64 {
  65     editSField(ChoiceFieldMask);
  66
  67     return _sfChoice.getValue();
  68 }
  69
  70 template<class Desc> inline
  71 typename SelectSValueEmitter<Desc>::ChoiceType
  72     SelectSValueEmitter<Desc>::getChoice(void) const
  73 {
  74     return _sfChoice.getValue();
  75 }
  76
  77 template<class Desc> inline
  78 typename SelectSValueEmitter<Desc>::MFChoiceValuesType *
  79     SelectSValueEmitter<Desc>::editMFChoiceValues(void)
  80 {
  81     editMField(ChoiceValuesFieldMask, _mfChoiceValues);
  82
  83     return &_mfChoiceValues;
  84 }
  85
  86 template<class Desc> inline
  87 const typename SelectSValueEmitter<Desc>::MFChoiceValuesType *
  88     SelectSValueEmitter<Desc>::getMFChoiceValues(void) const
  89 {
  90     return &_mfChoiceValues;
  91 }
  92
  93 template<class Desc> inline
  94 typename SelectSValueEmitter<Desc>::ChoiceValuesType &
  95     SelectSValueEmitter<Desc>::editChoiceValue(const UInt32 index)
  96 {
  97     editMField(ChoiceValuesFieldMask, _mfChoiceValues);
  98
  99     return _mfChoiceValues[index];
 100 }
 101
 102 template<class Desc> inline
 103 typename SelectSValueEmitter<Desc>::ChoiceValuesType
 104     SelectSValueEmitter<Desc>::getChoiceValue(const UInt32 index) const
 105 {
 106     return _mfChoiceValues[index];
 107 }
 108
 109 template<class Desc> inline
 110 typename SelectSValueEmitter<Desc>::SFValueType *
 111     SelectSValueEmitter<Desc>::editSFValue(void)
 112 {
 113     editSField(ValueFieldMask);
 114
 115     return &_sfValue;
 116 }
 117
 118 template<class Desc> inline
 119 const typename SelectSValueEmitter<Desc>::SFValueType *
 120     SelectSValueEmitter<Desc>::getSFValue(void) const
 121 {
 122     return &_sfValue;
 123 }
 124
 125 //! Get the value of the Real32Counter::_sfValue field.
 126
 127 template<class Desc> inline
 128 typename SelectSValueEmitter<Desc>::ValueType &
 129     SelectSValueEmitter<Desc>::editValue(void)
 130 {
 131     editSField(ValueFieldMask);
 132
 133     return _sfValue.getValue();
 134 }
 135
 136 //! Get the value of the Real32Counter::_sfValue field.
 137 template<class Desc> inline
 138 typename SelectSValueEmitter<Desc>::ValueType
 139     SelectSValueEmitter<Desc>::getValue(void) const
 140 {
 141     return _sfValue.getValue();
 142 }
 143
 144 template<class Desc> inline
 145 void SelectSValueEmitter<Desc>::setChoice(const ChoiceType choice)
 146 {
 147     editSField(ChoiceFieldMask);
 148
 149     _sfChoice.setValue(choice);
 150 }
 151
 152 //! Set the value of the Real32Counter::_sfValue field.
 153 template<class Desc> inline
 154 void SelectSValueEmitter<Desc>::setValue(const ValueType value)
 155 {
 156     editSField(ValueFieldMask);
 157
 158     _sfValue.setValue(value);
 159 }
 160
 161 template<class Desc> inline
 162 SFBool *SelectSValueEmitter<Desc>::editSFIgnoreNextChange(void)
 163 {
 164     editSField(IgnoreNextChangeFieldMask);
 165
 166     return &_sfIgnoreNextChange;
 167 }
 168
 169 template<class Desc> inline
 170 const SFBool *SelectSValueEmitter<Desc>::getSFIgnoreNextChange (void) const
 171 {
 172     return &_sfIgnoreNextChange;
 173 }
 174
 175 /*----------------------------- class specific ----------------------------*/
 176
 177 template<class Desc> inline
 178 void SelectSValueEmitter<Desc>::changed(ConstFieldMaskArg whichField,
 179                                         UInt32            origin,
 180                                         BitVector         details)
 181 {
 182     if(0x0000 != (whichField & TriggerFieldMask))
 183     {
 184         editSField(ValueFieldMask);
 185     }
 186
 187     if(0x0000 != (whichField & (ChoiceFieldMask | ChoiceValuesFieldMask)))
 188     {
 189         if(_sfChoice.getValue() < _mfChoiceValues.size())
 190         {
 191             setValue(Desc::convert(_mfChoiceValues[_sfChoice.getValue()]));
 192         }
 193     }
 194
 195     if(0x0000 != (whichField & IgnoreNextChangeFieldMask))
 196     {
 197         if(_sfIgnoreNextChange.getValue() == false)
 198         {
 199             Inherited::changed(whichField, origin, details);
 200         }
 201     }
 202     else
 203     {
 204         Inherited::changed(whichField, origin, details);
 205     }
 206 }
 207
 208 /*------------------------------ access -----------------------------------*/
 209 template<class Desc> inline
 210 SizeT SelectSValueEmitter<Desc>::getBinSize(ConstFieldMaskArg whichField)
 211 {
 212     SizeT returnValue = Inherited::getBinSize(whichField);
 213
 214     if(FieldBits::NoField != (ChoiceFieldMask & whichField))
 215     {
 216         returnValue += _sfChoice.getBinSize();
 217     }
 218
 219     if(FieldBits::NoField != (ChoiceValuesFieldMask & whichField))
 220     {
 221         returnValue += _mfChoiceValues.getBinSize();
 222     }
 223
 224     if(FieldBits::NoField != (ValueFieldMask & whichField))
 225     {
 226         returnValue += _sfValue.getBinSize();
 227     }
 228
 229
 230     return returnValue;
 231 }
 232
 233 template<class Desc> inline
 234 void SelectSValueEmitter<Desc>::copyToBin(BinaryDataHandler &pMem,
 235                                     ConstFieldMaskArg  whichField)
 236 {
 237     Inherited::copyToBin(pMem, whichField);
 238
 239     if(FieldBits::NoField != (ChoiceFieldMask & whichField))
 240     {
 241         _sfChoice.copyToBin(pMem);
 242     }
 243
 244     if(FieldBits::NoField != (ChoiceValuesFieldMask & whichField))
 245     {
 246         _mfChoiceValues.copyToBin(pMem);
 247     }
 248
 249     if(FieldBits::NoField != (ValueFieldMask & whichField))
 250     {
 251         _sfValue.copyToBin(pMem);
 252     }
 253 }
 254
 255 template<class Desc> inline
 256 void SelectSValueEmitter<Desc>::copyFromBin(BinaryDataHandler &pMem,
 257                                             ConstFieldMaskArg  whichField)
 258 {
 259     Inherited::copyFromBin(pMem, whichField);
 260
 261     if(FieldBits::NoField != (ChoiceFieldMask & whichField))
 262     {
 263         _sfChoice.copyFromBin(pMem);
 264     }
 265
 266     if(FieldBits::NoField != (ChoiceValuesFieldMask & whichField))
 267     {
 268         _mfChoiceValues.copyFromBin(pMem);
 269     }
 270
 271     if(FieldBits::NoField != (ValueFieldMask & whichField))
 272     {
 273         _sfValue.copyFromBin(pMem);
 274     }
 275 }
 276
 277
 278 //! create a new instance of the class
 279 template<class Desc> inline
 280 typename SelectSValueEmitter<Desc>::ObjTransitPtr
 281     SelectSValueEmitter<Desc>::createLocal(BitVector bFlags)
 282 {
 283     ObjTransitPtr fc;
 284
 285     if(getClassType().getPrototype() != NULL)
 286     {
 287         FieldContainerTransitPtr tmpPtr =
 288             getClassType().getPrototype()-> shallowCopyLocal(bFlags);
 289
 290         fc = dynamic_pointer_cast<Self>(tmpPtr);
 291     }
 292
 293     return fc;
 294 }
 295
 296 //! create a new instance of the class
 297 template<class Desc> inline
 298 typename SelectSValueEmitter<Desc>::ObjTransitPtr
 299     SelectSValueEmitter<Desc>::createDependent(BitVector bFlags)
 300 {
 301     ObjTransitPtr fc;
 302
 303     if(getClassType().getPrototype() != NULL)
 304     {
 305         FieldContainerTransitPtr tmpPtr =
 306             getClassType().getPrototype()-> shallowCopyDependent(bFlags);
 307
 308         fc = dynamic_pointer_cast<Self>(tmpPtr);
 309     }
 310
 311     return fc;
 312 }
 313
 314 //! create a new instance of the class
 315 template<class Desc> inline
 316 typename SelectSValueEmitter<Desc>::ObjTransitPtr
 317     SelectSValueEmitter<Desc>::create(void)
 318 {
 319     return createLocal();
 320 }
 321
 322 template<class Desc> inline
 323 typename SelectSValueEmitter<Desc>::Self *
 324     SelectSValueEmitter<Desc>::createEmptyLocal(BitVector bFlags)
 325 {
 326     Self *returnValue;
 327
 328     newPtr<Self>(returnValue, bFlags);
 329
 330     returnValue->_pFieldFlags->_bNamespaceMask &= ~bFlags;
 331
 332     return returnValue;
 333 }
 334
 335 //! create an empty new instance of the class, do not copy the prototype
 336 template<class Desc> inline
 337 typename SelectSValueEmitter<Desc>::Self *
 338     SelectSValueEmitter<Desc>::createEmpty(void)
 339 {
 340     return createEmptyLocal();
 341 }
 342
 343
 344 template<class Desc> inline
 345 FieldContainerTransitPtr
 346     SelectSValueEmitter<Desc>::shallowCopyLocal(BitVector bFlags) const
 347 {
 348     Self *tmpPtr;
 349
 350     newPtr(tmpPtr, dynamic_cast<const Self *>(this), bFlags);
 351
 352     FieldContainerTransitPtr returnValue(tmpPtr);
 353
 354     tmpPtr->_pFieldFlags->_bNamespaceMask &= ~bFlags;
 355
 356     return returnValue;
 357 }
 358
 359 template<class Desc> inline
 360 FieldContainerTransitPtr
 361     SelectSValueEmitter<Desc>::shallowCopyDependent(BitVector bFlags) const
 362 {
 363     Self *tmpPtr;
 364
 365     newPtr(tmpPtr, dynamic_cast<const Self *>(this), ~bFlags);
 366
 367     FieldContainerTransitPtr returnValue(tmpPtr);
 368
 369     tmpPtr->_pFieldFlags->_bNamespaceMask = bFlags;
 370
 371     return returnValue;
 372 }
 373
 374 template<class Desc> inline
 375 FieldContainerTransitPtr SelectSValueEmitter<Desc>::shallowCopy(void) const
 376 {
 377     return shallowCopyLocal();
 378 }
 379
 380
 381 template<class Desc> inline
 382 const Char8 *SelectSValueEmitter<Desc>::getClassname(void)
 383 {
 384     return Desc::getClassname();
 385 }
 386
 387 /*------------------------- constructors ----------------------------------*/
 388
 389 template<class Desc> inline
 390 SelectSValueEmitter<Desc>::SelectSValueEmitter(void) :
 391      Inherited         (                  ),
 392     _sfTrigger         (                  ),
 393     _sfChoice          (                  ),
 394     _mfChoiceValues    (                  ),
 395     _sfValue           (Desc::getDefault()),
 396     _sfIgnoreNextChange(false             )
 397 {
 398 }
 399
 400 template<class Desc> inline
 401 SelectSValueEmitter<Desc>::SelectSValueEmitter(
 402     const SelectSValueEmitter &source) :
 403
 404      Inherited         (source                    ),
 405     _sfTrigger         (source._sfTrigger         ),
 406     _sfChoice          (source._sfChoice          ),
 407     _mfChoiceValues    (source._mfChoiceValues    ),
 408     _sfValue           (source._sfValue           ),
 409     _sfIgnoreNextChange(source._sfIgnoreNextChange)
 410 {
 411 }
 412
 413
 414 /*-------------------------- destructors ----------------------------------*/
 415
 416 template<class Desc> inline
 417 SelectSValueEmitter<Desc>::~SelectSValueEmitter(void)
 418 {
 419 }
 420
 421 template<class Desc> inline
 422 GetFieldHandlePtr  SelectSValueEmitter<Desc>::getHandleChoice(void) const
 423 {
 424     typename SFChoiceType::GetHandlePtr returnValue(
 425         new typename SFChoiceType::GetHandle(
 426              &_sfChoice,
 427              this->getType().getFieldDesc(ChoiceFieldId),
 428              const_cast<Self *>(this)));
 429
 430     return returnValue;
 431 }
 432
 433 template<class Desc> inline
 434 EditFieldHandlePtr SelectSValueEmitter<Desc>::editHandleChoice(void)
 435 {
 436     typename SFChoiceType::EditHandlePtr returnValue(
 437         new typename SFChoiceType::EditHandle(
 438              &_sfChoice,
 439              this->getType().getFieldDesc(ChoiceFieldId),
 440              this));
 441
 442
 443     editSField(ChoiceFieldMask);
 444
 445     return returnValue;
 446 }
 447
 448 template<class Desc> inline
 449 GetFieldHandlePtr  SelectSValueEmitter<Desc>::getHandleChoiceValues(void) const
 450 {
 451     typename MFChoiceValuesType::GetHandlePtr returnValue(
 452         new typename MFChoiceValuesType::GetHandle(
 453              &_mfChoiceValues,
 454              this->getType().getFieldDesc(ChoiceValuesFieldId),
 455              const_cast<Self *>(this)));
 456
 457     return returnValue;
 458 }
 459
 460 template<class Desc> inline
 461 EditFieldHandlePtr SelectSValueEmitter<Desc>::editHandleChoiceValues(void)
 462 {
 463     typename MFChoiceValuesType::EditHandlePtr returnValue(
 464         new typename MFChoiceValuesType::EditHandle(
 465              &_mfChoiceValues,
 466              this->getType().getFieldDesc(ChoiceValuesFieldId),
 467              this));
 468
 469
 470     editMField(ChoiceValuesFieldMask, _mfChoiceValues);
 471
 472     return returnValue;
 473 }
 474
 475 template<class Desc> inline
 476 GetFieldHandlePtr SelectSValueEmitter<Desc>::getHandleValue(void) const
 477 {
 478     typename SFValueType::GetHandlePtr returnValue(
 479         new typename SFValueType::GetHandle(
 480              &_sfValue,
 481              this->getType().getFieldDesc(ValueFieldId),
 482              const_cast<Self *>(this)));
 483
 484     return returnValue;
 485 }
 486
 487 template<class Desc> inline
 488 EditFieldHandlePtr SelectSValueEmitter<Desc>::editHandleValue(void)
 489 {
 490     typename SFValueType::EditHandlePtr returnValue(
 491         new typename SFValueType::EditHandle(
 492              &_sfValue,
 493              this->getType().getFieldDesc(ValueFieldId),
 494              this));
 495
 496
 497     editSField(ValueFieldMask);
 498
 499     return returnValue;
 500 }
 501
 502 template<class Desc> inline
 503 GetFieldHandlePtr
 504     SelectSValueEmitter<Desc>::getHandleIgnoreNextChange (void) const
 505 {
 506     typename SFBool::GetHandlePtr returnValue(
 507         new typename SFBool::GetHandle(
 508              &_sfIgnoreNextChange,
 509              this->getType().getFieldDesc(IgnoreNextChangeFieldId),
 510              const_cast<Self *>(this)));
 511
 512     return returnValue;
 513 }
 514
 515 template<class Desc> inline
 516 EditFieldHandlePtr SelectSValueEmitter<Desc>::editHandleIgnoreNextChange(void)
 517 {
 518     typename SFBool::EditHandlePtr returnValue(
 519         new typename SFBool::EditHandle(
 520              &_sfIgnoreNextChange,
 521              this->getType().getFieldDesc(IgnoreNextChangeFieldId),
 522              this));
 523
 524
 525     editSField(IgnoreNextChangeFieldMask);
 526
 527     return returnValue;
 528 }
 529
 530 #ifdef OSG_MT_CPTR_ASPECT
 531 template<class Desc> inline
 532 void SelectSValueEmitter<Desc>::execSync (      Self              *pFrom,
 533                                                 ConstFieldMaskArg  whichField,
 534                                                 AspectOffsetStore &oOffsets,
 535                                                 ConstFieldMaskArg  syncMode,
 536                                           const UInt32             uiSyncInfo)
 537 {
 538     Inherited::execSync(pFrom, whichField, oOffsets, syncMode, uiSyncInfo);
 539
 540     if(FieldBits::NoField != (ChoiceFieldMask & whichField))
 541         _sfChoice.syncWith(pFrom->_sfChoice);
 542
 543     if(FieldBits::NoField != (ChoiceValuesFieldMask & whichField))
 544     {
 545         _mfChoiceValues.syncWith(pFrom->_mfChoiceValues,
 546                                  syncMode,
 547                                  uiSyncInfo,
 548                                  oOffsets);
 549     }
 550
 551     if(FieldBits::NoField != (ValueFieldMask & whichField))
 552         _sfValue.syncWith(pFrom->_sfValue);
 553 }
 554
 555 template<class Desc> inline
 556 void SelectSValueEmitter<Desc>::execSyncV(      FieldContainer    &oFrom,
 557                                                 ConstFieldMaskArg  whichField,
 558                                                 AspectOffsetStore &oOffsets,
 559                                                 ConstFieldMaskArg  syncMode,
 560                                           const UInt32             uiSyncInfo)
 561 {
 562     Self *pThis = static_cast<Self *>(this);
 563
 564     pThis->execSync(static_cast<Self *>(&oFrom),
 565                     whichField,
 566                     oOffsets,
 567                     syncMode,
 568                     uiSyncInfo);
 569 }
 570
 571
 572 template<class Desc> inline
 573 FieldContainer *SelectSValueEmitter<Desc>::createAspectCopy(
 574     const FieldContainer *pRefAspect) const
 575 {
 576     Self *returnValue;
 577
 578     newAspectCopy(returnValue,
 579                   dynamic_cast<const Self *>(pRefAspect),
 580                   dynamic_cast<const Self *>(this));
 581
 582     return returnValue;
 583 }
 584
 585 #endif
 586
 587 template<class Desc> inline
 588 void SelectSValueEmitter<Desc>::resolveLinks(void)
 589 {
 590     Inherited::resolveLinks();
 591
 592
 593 }
 594
 595 template<class Desc> inline
 596 void SelectSValueEmitter<Desc>::initMethod(InitPhase ePhase)
 597 {
 598     Inherited::initMethod(ePhase);
 599
 600     if(ePhase == TypeObject::SystemPost)
 601     {
 602     }
 603 }
 604 OSG_END_NAMESPACE
 605