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