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