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