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