Source/System/NodeCores/Groups/Misc/OSGSwitchBase.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 Switch!
  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 "OSGSwitchBase.h"
  67 #include "OSGSwitch.h"
  68
  69 #include <boost/bind.hpp>
  70
  71 OSG_BEGIN_NAMESPACE
  72
  73 /***************************************************************************\
  74  *                            Description                                  *
  75 \***************************************************************************/
  76
  77 /*! \class OSG::Switch
  78     This core allows selection of different subtrees with the \c choice field.
  79     Depending on its value either all, none or only the specified child is
  80     enabled.
  81  */
  82
  83 /***************************************************************************\
  84  *                        Field Documentation                              *
  85 \***************************************************************************/
  86
  87 /*! \var Int32           SwitchBase::_sfChoice
  88
  89 */
  90
  91
  92 /***************************************************************************\
  93  *                      FieldType/FieldTrait Instantiation                 *
  94 \***************************************************************************/
  95
  96 #if !defined(OSG_DO_DOC) || defined(OSG_DOC_DEV)
  97 PointerType FieldTraits<Switch *, nsOSG>::_type(
  98     "SwitchPtr",
  99     "GroupPtr",
 100     Switch::getClassType(),
 101     nsOSG);
 102 #endif
 103
 104 OSG_FIELDTRAITS_GETTYPE_NS(Switch *, nsOSG)
 105
 106 OSG_EXPORT_PTR_SFIELD_FULL(PointerSField,
 107                            Switch *,
 108                            nsOSG)
 109
 110 OSG_EXPORT_PTR_MFIELD_FULL(PointerMField,
 111                            Switch *,
 112                            nsOSG)
 113
 114 /***************************************************************************\
 115  *                         Field Description                               *
 116 \***************************************************************************/
 117
 118 void SwitchBase::classDescInserter(TypeObject &oType)
 119 {
 120     FieldDescriptionBase *pDesc = NULL;
 121
 122
 123     pDesc = new SFInt32::Description(
 124         SFInt32::getClassType(),
 125         "choice",
 126         "",
 127         ChoiceFieldId, ChoiceFieldMask,
 128         false,
 129         (Field::SFDefaultFlags | Field::FStdAccess),
 130         static_cast<FieldEditMethodSig>(&Switch::editHandleChoice),
 131         static_cast<FieldGetMethodSig >(&Switch::getHandleChoice));
 132
 133     oType.addInitialDesc(pDesc);
 134 }
 135
 136
 137 SwitchBase::TypeObject SwitchBase::_type(
 138     SwitchBase::getClassname(),
 139     Inherited::getClassname(),
 140     "NULL",
 141     nsOSG, //Namespace
 142     reinterpret_cast<PrototypeCreateF>(&SwitchBase::createEmptyLocal),
 143     reinterpret_cast<InitContainerF>(&Switch::initMethod),
 144     reinterpret_cast<ExitContainerF>(&Switch::exitMethod),
 145     reinterpret_cast<InitalInsertDescFunc>(
 146         reinterpret_cast<void *>(&Switch::classDescInserter)),
 147     false,
 148     0,
 149     "<?xml version=\"1.0\"?>\n"
 150     "\n"
 151     "<FieldContainer\n"
 152     "   name=\"Switch\"\n"
 153     "   parent=\"Group\"\n"
 154     "   library=\"Group\"\n"
 155     "   pointerfieldtypes=\"both\"\n"
 156     "   structure=\"concrete\"\n"
 157     "   systemcomponent=\"true\"\n"
 158     "   parentsystemcomponent=\"true\"\n"
 159     "   decoratable=\"false\"\n"
 160     "   isNodeCore=\"true\"\n"
 161     "   docGroupBase=\"GrpGroupMisc\"\n"
 162     "   >\n"
 163     "  This core allows selection of different subtrees with the \\c choice field.\n"
 164     "  Depending on its value either all, none or only the specified child is\n"
 165     "  enabled.\n"
 166     "  <Field\n"
 167     "\t name=\"choice\"\n"
 168     "\t type=\"Int32\"\n"
 169     "\t cardinality=\"single\"\n"
 170     "\t visibility=\"external\"\n"
 171     "\t defaultValue=\"-1\"\n"
 172     "\t access=\"public\"\n"
 173     "\t >\n"
 174     "  </Field>\n"
 175     "</FieldContainer>\n",
 176     "This core allows selection of different subtrees with the \\c choice field.\n"
 177     "Depending on its value either all, none or only the specified child is\n"
 178     "enabled.\n"
 179     );
 180
 181 /*------------------------------ get -----------------------------------*/
 182
 183 FieldContainerType &SwitchBase::getType(void)
 184 {
 185     return _type;
 186 }
 187
 188 const FieldContainerType &SwitchBase::getType(void) const
 189 {
 190     return _type;
 191 }
 192
 193 UInt32 SwitchBase::getContainerSize(void) const
 194 {
 195     return sizeof(Switch);
 196 }
 197
 198 /*------------------------- decorator get ------------------------------*/
 199
 200
 201 SFInt32 *SwitchBase::editSFChoice(void)
 202 {
 203     editSField(ChoiceFieldMask);
 204
 205     return &_sfChoice;
 206 }
 207
 208 const SFInt32 *SwitchBase::getSFChoice(void) const
 209 {
 210     return &_sfChoice;
 211 }
 212
 213
 214
 215
 216
 217
 218 /*------------------------------ access -----------------------------------*/
 219
 220 SizeT SwitchBase::getBinSize(ConstFieldMaskArg whichField)
 221 {
 222     SizeT returnValue = Inherited::getBinSize(whichField);
 223
 224     if(FieldBits::NoField != (ChoiceFieldMask & whichField))
 225     {
 226         returnValue += _sfChoice.getBinSize();
 227     }
 228
 229     return returnValue;
 230 }
 231
 232 void SwitchBase::copyToBin(BinaryDataHandler &pMem,
 233                                   ConstFieldMaskArg  whichField)
 234 {
 235     Inherited::copyToBin(pMem, whichField);
 236
 237     if(FieldBits::NoField != (ChoiceFieldMask & whichField))
 238     {
 239         _sfChoice.copyToBin(pMem);
 240     }
 241 }
 242
 243 void SwitchBase::copyFromBin(BinaryDataHandler &pMem,
 244                                     ConstFieldMaskArg  whichField)
 245 {
 246     Inherited::copyFromBin(pMem, whichField);
 247
 248     if(FieldBits::NoField != (ChoiceFieldMask & whichField))
 249     {
 250         editSField(ChoiceFieldMask);
 251         _sfChoice.copyFromBin(pMem);
 252     }
 253 }
 254
 255 //! create a new instance of the class
 256 SwitchTransitPtr SwitchBase::createLocal(BitVector bFlags)
 257 {
 258     SwitchTransitPtr fc;
 259
 260     if(getClassType().getPrototype() != NULL)
 261     {
 262         FieldContainerTransitPtr tmpPtr =
 263             getClassType().getPrototype()-> shallowCopyLocal(bFlags);
 264
 265         fc = dynamic_pointer_cast<Switch>(tmpPtr);
 266     }
 267
 268     return fc;
 269 }
 270
 271 //! create a new instance of the class, copy the container flags
 272 SwitchTransitPtr SwitchBase::createDependent(BitVector bFlags)
 273 {
 274     SwitchTransitPtr fc;
 275
 276     if(getClassType().getPrototype() != NULL)
 277     {
 278         FieldContainerTransitPtr tmpPtr =
 279             getClassType().getPrototype()-> shallowCopyDependent(bFlags);
 280
 281         fc = dynamic_pointer_cast<Switch>(tmpPtr);
 282     }
 283
 284     return fc;
 285 }
 286
 287 //! create a new instance of the class
 288 SwitchTransitPtr SwitchBase::create(void)
 289 {
 290     SwitchTransitPtr fc;
 291
 292     if(getClassType().getPrototype() != NULL)
 293     {
 294         FieldContainerTransitPtr tmpPtr =
 295             getClassType().getPrototype()-> shallowCopy();
 296
 297         fc = dynamic_pointer_cast<Switch>(tmpPtr);
 298     }
 299
 300     return fc;
 301 }
 302
 303 Switch *SwitchBase::createEmptyLocal(BitVector bFlags)
 304 {
 305     Switch *returnValue;
 306
 307     newPtr<Switch>(returnValue, bFlags);
 308
 309     returnValue->_pFieldFlags->_bNamespaceMask &= ~bFlags;
 310
 311     return returnValue;
 312 }
 313
 314 //! create an empty new instance of the class, do not copy the prototype
 315 Switch *SwitchBase::createEmpty(void)
 316 {
 317     Switch *returnValue;
 318
 319     newPtr<Switch>(returnValue, Thread::getCurrentLocalFlags());
 320
 321     returnValue->_pFieldFlags->_bNamespaceMask &=
 322         ~Thread::getCurrentLocalFlags();
 323
 324     return returnValue;
 325 }
 326
 327
 328 FieldContainerTransitPtr SwitchBase::shallowCopyLocal(
 329     BitVector bFlags) const
 330 {
 331     Switch *tmpPtr;
 332
 333     newPtr(tmpPtr, dynamic_cast<const Switch *>(this), bFlags);
 334
 335     FieldContainerTransitPtr returnValue(tmpPtr);
 336
 337     tmpPtr->_pFieldFlags->_bNamespaceMask &= ~bFlags;
 338
 339     return returnValue;
 340 }
 341
 342 FieldContainerTransitPtr SwitchBase::shallowCopyDependent(
 343     BitVector bFlags) const
 344 {
 345     Switch *tmpPtr;
 346
 347     newPtr(tmpPtr, dynamic_cast<const Switch *>(this), ~bFlags);
 348
 349     FieldContainerTransitPtr returnValue(tmpPtr);
 350
 351     tmpPtr->_pFieldFlags->_bNamespaceMask = bFlags;
 352
 353     return returnValue;
 354 }
 355
 356 FieldContainerTransitPtr SwitchBase::shallowCopy(void) const
 357 {
 358     Switch *tmpPtr;
 359
 360     newPtr(tmpPtr,
 361            dynamic_cast<const Switch *>(this),
 362            Thread::getCurrentLocalFlags());
 363
 364     tmpPtr->_pFieldFlags->_bNamespaceMask &= ~Thread::getCurrentLocalFlags();
 365
 366     FieldContainerTransitPtr returnValue(tmpPtr);
 367
 368     return returnValue;
 369 }
 370
 371
 372
 373
 374 /*------------------------- constructors ----------------------------------*/
 375
 376 SwitchBase::SwitchBase(void) :
 377     Inherited(),
 378     _sfChoice                 (Int32(-1))
 379 {
 380 }
 381
 382 SwitchBase::SwitchBase(const SwitchBase &source) :
 383     Inherited(source),
 384     _sfChoice                 (source._sfChoice                 )
 385 {
 386 }
 387
 388
 389 /*-------------------------- destructors ----------------------------------*/
 390
 391 SwitchBase::~SwitchBase(void)
 392 {
 393 }
 394
 395
 396 GetFieldHandlePtr SwitchBase::getHandleChoice          (void) const
 397 {
 398     SFInt32::GetHandlePtr returnValue(
 399         new  SFInt32::GetHandle(
 400              &_sfChoice,
 401              this->getType().getFieldDesc(ChoiceFieldId),
 402              const_cast<SwitchBase *>(this)));
 403
 404     return returnValue;
 405 }
 406
 407 EditFieldHandlePtr SwitchBase::editHandleChoice         (void)
 408 {
 409     SFInt32::EditHandlePtr returnValue(
 410         new  SFInt32::EditHandle(
 411              &_sfChoice,
 412              this->getType().getFieldDesc(ChoiceFieldId),
 413              this));
 414
 415
 416     editSField(ChoiceFieldMask);
 417
 418     return returnValue;
 419 }
 420
 421
 422 #ifdef OSG_MT_CPTR_ASPECT
 423 void SwitchBase::execSyncV(      FieldContainer    &oFrom,
 424                                         ConstFieldMaskArg  whichField,
 425                                         AspectOffsetStore &oOffsets,
 426                                         ConstFieldMaskArg  syncMode,
 427                                   const UInt32             uiSyncInfo)
 428 {
 429     Switch *pThis = static_cast<Switch *>(this);
 430
 431     pThis->execSync(static_cast<Switch *>(&oFrom),
 432                     whichField,
 433                     oOffsets,
 434                     syncMode,
 435                     uiSyncInfo);
 436 }
 437 #endif
 438
 439
 440 #ifdef OSG_MT_CPTR_ASPECT
 441 FieldContainer *SwitchBase::createAspectCopy(
 442     const FieldContainer *pRefAspect) const
 443 {
 444     Switch *returnValue;
 445
 446     newAspectCopy(returnValue,
 447                   dynamic_cast<const Switch *>(pRefAspect),
 448                   dynamic_cast<const Switch *>(this));
 449
 450     return returnValue;
 451 }
 452 #endif
 453
 454 void SwitchBase::resolveLinks(void)
 455 {
 456     Inherited::resolveLinks();
 457
 458
 459 }
 460
 461
 462 OSG_END_NAMESPACE