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