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