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