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