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