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