Source/System/State/Shader/Variables/OSGShaderValueVariableBase.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 ShaderValueVariable!
  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 "OSGFieldContainer.h"          // Parents Class
  66
  67 #include "OSGShaderValueVariableBase.h"
  68 #include "OSGShaderValueVariable.h"
  69
  70 #include <boost/bind.hpp>
  71
  72 OSG_BEGIN_NAMESPACE
  73
  74 /***************************************************************************\
  75  *                            Description                                  *
  76 \***************************************************************************/
  77
  78 /*! \class OSG::ShaderValueVariable
  79
  80  */
  81
  82 /***************************************************************************\
  83  *                        Field Documentation                              *
  84 \***************************************************************************/
  85
  86 /*! \var UInt16          ShaderValueVariableBase::_mfVariableIdx
  87
  88 */
  89
  90 /*! \var FieldContainer * ShaderValueVariableBase::_mfParents
  91
  92 */
  93
  94 /*! \var UInt16          ShaderValueVariableBase::_mfExeVariableIdx
  95
  96 */
  97
  98 /*! \var FieldContainer * ShaderValueVariableBase::_mfExeParents
  99
 100 */
 101
 102
 103 /***************************************************************************\
 104  *                      FieldType/FieldTrait Instantiation                 *
 105 \***************************************************************************/
 106
 107 #if !defined(OSG_DO_DOC) || defined(OSG_DOC_DEV)
 108 PointerType FieldTraits<ShaderValueVariable *, nsOSG>::_type(
 109     "ShaderValueVariablePtr",
 110     "ShaderVariablePtr",
 111     ShaderValueVariable::getClassType(),
 112     nsOSG);
 113 #endif
 114
 115 OSG_FIELDTRAITS_GETTYPE_NS(ShaderValueVariable *, nsOSG)
 116
 117 OSG_EXPORT_PTR_SFIELD_FULL(PointerSField,
 118                            ShaderValueVariable *,
 119                            nsOSG)
 120
 121 OSG_EXPORT_PTR_MFIELD_FULL(PointerMField,
 122                            ShaderValueVariable *,
 123                            nsOSG)
 124
 125 /***************************************************************************\
 126  *                         Field Description                               *
 127 \***************************************************************************/
 128
 129 void ShaderValueVariableBase::classDescInserter(TypeObject &oType)
 130 {
 131     FieldDescriptionBase *pDesc = NULL;
 132
 133
 134     pDesc = new MFUInt16::Description(
 135         MFUInt16::getClassType(),
 136         "variableIdx",
 137         "",
 138         VariableIdxFieldId, VariableIdxFieldMask,
 139         true,
 140         (Field::MFDefaultFlags | Field::FStdAccess),
 141         static_cast     <FieldEditMethodSig>(&ShaderValueVariable::invalidEditField),
 142         static_cast     <FieldGetMethodSig >(&ShaderValueVariable::invalidGetField));
 143
 144     oType.addInitialDesc(pDesc);
 145
 146     pDesc = new MFParentFieldContainerPtr::Description(
 147         MFParentFieldContainerPtr::getClassType(),
 148         "parents",
 149         "",
 150         ParentsFieldId, ParentsFieldMask,
 151         true,
 152         (Field::FStdAccess),
 153         static_cast     <FieldEditMethodSig>(&ShaderValueVariable::invalidEditField),
 154         static_cast     <FieldGetMethodSig >(&ShaderValueVariable::invalidGetField));
 155
 156     oType.addInitialDesc(pDesc);
 157
 158     pDesc = new MFUInt16::Description(
 159         MFUInt16::getClassType(),
 160         "exeVariableIdx",
 161         "",
 162         ExeVariableIdxFieldId, ExeVariableIdxFieldMask,
 163         true,
 164         (Field::FClusterLocal),
 165         static_cast     <FieldEditMethodSig>(&ShaderValueVariable::invalidEditField),
 166         static_cast     <FieldGetMethodSig >(&ShaderValueVariable::invalidGetField));
 167
 168     oType.addInitialDesc(pDesc);
 169
 170     pDesc = new MFParentFieldContainerPtr::Description(
 171         MFParentFieldContainerPtr::getClassType(),
 172         "exeParents",
 173         "",
 174         ExeParentsFieldId, ExeParentsFieldMask,
 175         true,
 176         (Field::FStdAccess | Field::FClusterLocal),
 177         static_cast     <FieldEditMethodSig>(&ShaderValueVariable::invalidEditField),
 178         static_cast     <FieldGetMethodSig >(&ShaderValueVariable::invalidGetField));
 179
 180     oType.addInitialDesc(pDesc);
 181 }
 182
 183
 184 ShaderValueVariableBase::TypeObject ShaderValueVariableBase::_type(
 185     ShaderValueVariableBase::getClassname(),
 186     Inherited::getClassname(),
 187     "NULL",
 188     nsOSG, //Namespace
 189     NULL,
 190     reinterpret_cast<InitContainerF>(&ShaderValueVariable::initMethod),
 191     reinterpret_cast<ExitContainerF>(&ShaderValueVariable::exitMethod),
 192     reinterpret_cast<InitalInsertDescFunc>(
 193         reinterpret_cast<void *>(&ShaderValueVariable::classDescInserter)),
 194     false,
 195     0,
 196     "<?xml version=\"1.0\"?>\n"
 197     "\n"
 198     "<FieldContainer\n"
 199     "    name=\"ShaderValueVariable\"\n"
 200     "    parent=\"ShaderVariable\"\n"
 201     "    library=\"System\"\n"
 202     "    pointerfieldtypes=\"both\"\n"
 203     "    structure=\"abstract\"\n"
 204     "    systemcomponent=\"true\"\n"
 205     "    parentsystemcomponent=\"true\"\n"
 206     "    decoratable=\"false\"\n"
 207     "    useLocalIncludes=\"false\"\n"
 208     "    docGroupBase=\"GrpSystemShader\"\n"
 209     "    >\n"
 210     "    <Field\n"
 211     "        name=\"variableIdx\"\n"
 212     "        type=\"UInt16\"\n"
 213     "        cardinality=\"multi\"\n"
 214     "        visibility=\"internal\"\n"
 215     "        access=\"none\"\n"
 216     "        >\n"
 217     "    </Field>\n"
 218     "    <Field\n"
 219     "        name=\"parents\"\n"
 220     "        type=\"FieldContainer\"\n"
 221     "        cardinality=\"multi\"\n"
 222     "        visibility=\"internal\"\n"
 223     "        access=\"none\"\n"
 224     "        category=\"parentpointer\"\n"
 225     "        fieldFlags=\"FStdAccess\"\n"
 226     "        >\n"
 227     "    </Field>\n"
 228     "\n"
 229     "\n"
 230     "    <Field\n"
 231     "        name=\"exeVariableIdx\"\n"
 232     "        type=\"UInt16\"\n"
 233     "        cardinality=\"multi\"\n"
 234     "        visibility=\"internal\"\n"
 235     "        access=\"none\"\n"
 236     "        fieldFlags=\"FClusterLocal\"\n"
 237     "        >\n"
 238     "    </Field>\n"
 239     "    <Field\n"
 240     "        name=\"exeParents\"\n"
 241     "        type=\"FieldContainer\"\n"
 242     "        cardinality=\"multi\"\n"
 243     "        visibility=\"internal\"\n"
 244     "        access=\"none\"\n"
 245     "        category=\"parentpointer\"\n"
 246     "        fieldFlags=\"FStdAccess, FClusterLocal\"\n"
 247     "        >\n"
 248     "    </Field>\n"
 249     "<!---        fieldFlags=\"FStdAccess, FClusterLocal\" -->\n"
 250     "</FieldContainer>\n",
 251     ""
 252     );
 253
 254 /*------------------------------ get -----------------------------------*/
 255
 256 FieldContainerType &ShaderValueVariableBase::getType(void)
 257 {
 258     return _type;
 259 }
 260
 261 const FieldContainerType &ShaderValueVariableBase::getType(void) const
 262 {
 263     return _type;
 264 }
 265
 266 UInt32 ShaderValueVariableBase::getContainerSize(void) const
 267 {
 268     return sizeof(ShaderValueVariable);
 269 }
 270
 271 /*------------------------- decorator get ------------------------------*/
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282 /*------------------------------ access -----------------------------------*/
 283
 284 SizeT ShaderValueVariableBase::getBinSize(ConstFieldMaskArg whichField)
 285 {
 286     SizeT returnValue = Inherited::getBinSize(whichField);
 287
 288     if(FieldBits::NoField != (VariableIdxFieldMask & whichField))
 289     {
 290         returnValue += _mfVariableIdx.getBinSize();
 291     }
 292     if(FieldBits::NoField != (ParentsFieldMask & whichField))
 293     {
 294         returnValue += _mfParents.getBinSize();
 295     }
 296     if(FieldBits::NoField != (ExeVariableIdxFieldMask & whichField))
 297     {
 298         returnValue += _mfExeVariableIdx.getBinSize();
 299     }
 300     if(FieldBits::NoField != (ExeParentsFieldMask & whichField))
 301     {
 302         returnValue += _mfExeParents.getBinSize();
 303     }
 304
 305     return returnValue;
 306 }
 307
 308 void ShaderValueVariableBase::copyToBin(BinaryDataHandler &pMem,
 309                                   ConstFieldMaskArg  whichField)
 310 {
 311     Inherited::copyToBin(pMem, whichField);
 312
 313     if(FieldBits::NoField != (VariableIdxFieldMask & whichField))
 314     {
 315         _mfVariableIdx.copyToBin(pMem);
 316     }
 317     if(FieldBits::NoField != (ParentsFieldMask & whichField))
 318     {
 319         _mfParents.copyToBin(pMem);
 320     }
 321     if(FieldBits::NoField != (ExeVariableIdxFieldMask & whichField))
 322     {
 323         _mfExeVariableIdx.copyToBin(pMem);
 324     }
 325     if(FieldBits::NoField != (ExeParentsFieldMask & whichField))
 326     {
 327         _mfExeParents.copyToBin(pMem);
 328     }
 329 }
 330
 331 void ShaderValueVariableBase::copyFromBin(BinaryDataHandler &pMem,
 332                                     ConstFieldMaskArg  whichField)
 333 {
 334     Inherited::copyFromBin(pMem, whichField);
 335
 336     if(FieldBits::NoField != (VariableIdxFieldMask & whichField))
 337     {
 338         editMField(VariableIdxFieldMask, _mfVariableIdx);
 339         _mfVariableIdx.copyFromBin(pMem);
 340     }
 341     if(FieldBits::NoField != (ParentsFieldMask & whichField))
 342     {
 343         editMField(ParentsFieldMask, _mfParents);
 344         _mfParents.copyFromBin(pMem);
 345     }
 346     if(FieldBits::NoField != (ExeVariableIdxFieldMask & whichField))
 347     {
 348         editMField(ExeVariableIdxFieldMask, _mfExeVariableIdx);
 349         _mfExeVariableIdx.copyFromBin(pMem);
 350     }
 351     if(FieldBits::NoField != (ExeParentsFieldMask & whichField))
 352     {
 353         editMField(ExeParentsFieldMask, _mfExeParents);
 354         _mfExeParents.copyFromBin(pMem);
 355     }
 356 }
 357
 358
 359
 360
 361 /*------------------------- constructors ----------------------------------*/
 362
 363 ShaderValueVariableBase::ShaderValueVariableBase(void) :
 364     Inherited(),
 365     _mfVariableIdx            (),
 366     _mfParents                (),
 367     _mfExeVariableIdx         (),
 368     _mfExeParents             ()
 369 {
 370 }
 371
 372 ShaderValueVariableBase::ShaderValueVariableBase(const ShaderValueVariableBase &source) :
 373     Inherited(source),
 374     _mfVariableIdx            (source._mfVariableIdx            ),
 375     _mfParents                (),
 376     _mfExeVariableIdx         (source._mfExeVariableIdx         ),
 377     _mfExeParents             ()
 378 {
 379 }
 380
 381
 382 /*-------------------------- destructors ----------------------------------*/
 383
 384 ShaderValueVariableBase::~ShaderValueVariableBase(void)
 385 {
 386 }
 387 /*-------------------------------------------------------------------------*/
 388 /* Parent linking                                                          */
 389
 390 bool ShaderValueVariableBase::linkParent(
 391     FieldContainer * const pParent,
 392     UInt16           const childFieldId,
 393     UInt16           const parentFieldId )
 394 {
 395     if(parentFieldId == ParentsFieldId)
 396     {
 397         FieldContainer * pTypedParent =
 398             dynamic_cast< FieldContainer * >(pParent);
 399
 400         if(pTypedParent != NULL)
 401         {
 402             editMField(ParentsFieldMask, _mfParents);
 403
 404             _mfParents.push_back(pTypedParent, childFieldId);
 405
 406             return true;
 407         }
 408
 409         return false;
 410     }
 411
 412     if(parentFieldId == ExeParentsFieldId)
 413     {
 414         FieldContainer * pTypedParent =
 415             dynamic_cast< FieldContainer * >(pParent);
 416
 417         if(pTypedParent != NULL)
 418         {
 419             editMField(ExeParentsFieldMask, _mfExeParents);
 420
 421             _mfExeParents.push_back(pTypedParent, childFieldId);
 422
 423             return true;
 424         }
 425
 426         return false;
 427     }
 428
 429     return Inherited::linkParent(pParent, childFieldId, parentFieldId);
 430 }
 431
 432 bool ShaderValueVariableBase::unlinkParent(
 433     FieldContainer * const pParent,
 434     UInt16           const parentFieldId)
 435 {
 436     if(parentFieldId == ParentsFieldId)
 437     {
 438         FieldContainer * pTypedParent =
 439             dynamic_cast< FieldContainer * >(pParent);
 440
 441         if(pTypedParent != NULL)
 442         {
 443             Int32 iParentIdx = _mfParents.findIndex(pTypedParent);
 444
 445             if(iParentIdx != -1)
 446             {
 447                 editMField(ParentsFieldMask, _mfParents);
 448
 449                 _mfParents.erase(iParentIdx);
 450
 451                 return true;
 452             }
 453
 454             SWARNING << "Child (["          << this
 455                      << "] id ["            << this->getId()
 456                      << "] type ["          << this->getType().getCName()
 457                      << "] parentFieldId [" << parentFieldId
 458                      << "]) - Parent (["    << pParent
 459                      << "] id ["            << pParent->getId()
 460                      << "] type ["          << pParent->getType().getCName()
 461                      << "]): link inconsistent!"
 462                      << std::endl;
 463
 464             return false;
 465         }
 466
 467         return false;
 468     }
 469
 470     if(parentFieldId == ExeParentsFieldId)
 471     {
 472         FieldContainer * pTypedParent =
 473             dynamic_cast< FieldContainer * >(pParent);
 474
 475         if(pTypedParent != NULL)
 476         {
 477             Int32 iParentIdx = _mfExeParents.findIndex(pTypedParent);
 478
 479             if(iParentIdx != -1)
 480             {
 481                 editMField(ExeParentsFieldMask, _mfExeParents);
 482
 483                 _mfExeParents.erase(iParentIdx);
 484
 485                 return true;
 486             }
 487
 488             SWARNING << "Child (["          << this
 489                      << "] id ["            << this->getId()
 490                      << "] type ["          << this->getType().getCName()
 491                      << "] parentFieldId [" << parentFieldId
 492                      << "]) - Parent (["    << pParent
 493                      << "] id ["            << pParent->getId()
 494                      << "] type ["          << pParent->getType().getCName()
 495                      << "]): link inconsistent!"
 496                      << std::endl;
 497
 498             return false;
 499         }
 500
 501         return false;
 502     }
 503
 504     return Inherited::unlinkParent(pParent, parentFieldId);
 505 }
 506
 507
 508
 509 GetFieldHandlePtr ShaderValueVariableBase::getHandleVariableIdx     (void) const
 510 {
 511     MFUInt16::GetHandlePtr returnValue;
 512
 513     return returnValue;
 514 }
 515
 516 EditFieldHandlePtr ShaderValueVariableBase::editHandleVariableIdx    (void)
 517 {
 518     EditFieldHandlePtr returnValue;
 519
 520     return returnValue;
 521 }
 522
 523 GetFieldHandlePtr ShaderValueVariableBase::getHandleParents         (void) const
 524 {
 525     MFParentFieldContainerPtr::GetHandlePtr returnValue;
 526
 527     return returnValue;
 528 }
 529
 530 EditFieldHandlePtr ShaderValueVariableBase::editHandleParents        (void)
 531 {
 532     EditFieldHandlePtr returnValue;
 533
 534     return returnValue;
 535 }
 536
 537 GetFieldHandlePtr ShaderValueVariableBase::getHandleExeVariableIdx  (void) const
 538 {
 539     MFUInt16::GetHandlePtr returnValue;
 540
 541     return returnValue;
 542 }
 543
 544 EditFieldHandlePtr ShaderValueVariableBase::editHandleExeVariableIdx (void)
 545 {
 546     EditFieldHandlePtr returnValue;
 547
 548     return returnValue;
 549 }
 550
 551 GetFieldHandlePtr ShaderValueVariableBase::getHandleExeParents      (void) const
 552 {
 553     MFParentFieldContainerPtr::GetHandlePtr returnValue;
 554
 555     return returnValue;
 556 }
 557
 558 EditFieldHandlePtr ShaderValueVariableBase::editHandleExeParents     (void)
 559 {
 560     EditFieldHandlePtr returnValue;
 561
 562     return returnValue;
 563 }
 564
 565
 566 #ifdef OSG_MT_CPTR_ASPECT
 567 void ShaderValueVariableBase::execSyncV(      FieldContainer    &oFrom,
 568                                         ConstFieldMaskArg  whichField,
 569                                         AspectOffsetStore &oOffsets,
 570                                         ConstFieldMaskArg  syncMode,
 571                                   const UInt32             uiSyncInfo)
 572 {
 573     ShaderValueVariable *pThis = static_cast<ShaderValueVariable *>(this);
 574
 575     pThis->execSync(static_cast<ShaderValueVariable *>(&oFrom),
 576                     whichField,
 577                     oOffsets,
 578                     syncMode,
 579                     uiSyncInfo);
 580 }
 581 #endif
 582
 583
 584
 585 void ShaderValueVariableBase::resolveLinks(void)
 586 {
 587     Inherited::resolveLinks();
 588
 589 #ifdef OSG_MT_CPTR_ASPECT
 590     AspectOffsetStore oOffsets;
 591
 592     _pAspectStore->fillOffsetArray(oOffsets, this);
 593 #endif
 594
 595 #ifdef OSG_MT_CPTR_ASPECT
 596     _mfVariableIdx.terminateShare(Thread::getCurrentAspect(),
 597                                       oOffsets);
 598 #endif
 599 #ifdef OSG_MT_CPTR_ASPECT
 600     _mfExeVariableIdx.terminateShare(Thread::getCurrentAspect(),
 601                                       oOffsets);
 602 #endif
 603 }
 604
 605
 606 OSG_END_NAMESPACE