Source/System/NodeCores/Groups/Misc/OSGMaterialChunkOverrideGroupBase.cpp

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