Source/System/NodeCores/Groups/Misc/OSGScreenTransformBase.h

   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 ScreenTransform
  49  **                                                                         **
  50  *****************************************************************************
  51 \*****************************************************************************/
  52
  53
  54 #ifndef _OSGSCREENTRANSFORMBASE_H_
  55 #define _OSGSCREENTRANSFORMBASE_H_
  56 #ifdef __sgi
  57 #pragma once
  58 #endif
  59
  60
  61 #include "OSGConfig.h"
  62 #include "OSGGroupDef.h"
  63
  64 //#include "OSGBaseTypes.h"
  65
  66 #include "OSGGroup.h" // Parent
  67
  68 #include "OSGNodeFields.h"              // Beacon type
  69 #include "OSGSysFields.h"               // InvertWorldTransform type
  70 #include "OSGMathFields.h"              // View type
  71
  72 #include "OSGScreenTransformFields.h"
  73
  74 OSG_BEGIN_NAMESPACE
  75
  76
  77 class ScreenTransform;
  78
  79 //! \brief ScreenTransform Base Class.
  80
  81 class OSG_GROUP_DLLMAPPING ScreenTransformBase : public Group
  82 {
  83   public:
  84
  85     typedef Group Inherited;
  86     typedef Group ParentContainer;
  87
  88     typedef Inherited::TypeObject TypeObject;
  89     typedef TypeObject::InitPhase InitPhase;
  90
  91     OSG_GEN_INTERNALPTR(ScreenTransform);
  92
  93     /*==========================  PUBLIC  =================================*/
  94
  95   public:
  96
  97     enum
  98     {
  99         BeaconFieldId = Inherited::NextFieldId,
 100         InvertWorldTransformFieldId = BeaconFieldId + 1,
 101         InvertViewTransformFieldId = InvertWorldTransformFieldId + 1,
 102         ApplyBeaconRotationFieldId = InvertViewTransformFieldId + 1,
 103         ApplyBeaconScreenTranslationFieldId = ApplyBeaconRotationFieldId + 1,
 104         ViewFieldId = ApplyBeaconScreenTranslationFieldId + 1,
 105         NextFieldId = ViewFieldId + 1
 106     };
 107
 108     static const OSG::BitVector BeaconFieldMask =
 109         (TypeTraits<BitVector>::One << BeaconFieldId);
 110     static const OSG::BitVector InvertWorldTransformFieldMask =
 111         (TypeTraits<BitVector>::One << InvertWorldTransformFieldId);
 112     static const OSG::BitVector InvertViewTransformFieldMask =
 113         (TypeTraits<BitVector>::One << InvertViewTransformFieldId);
 114     static const OSG::BitVector ApplyBeaconRotationFieldMask =
 115         (TypeTraits<BitVector>::One << ApplyBeaconRotationFieldId);
 116     static const OSG::BitVector ApplyBeaconScreenTranslationFieldMask =
 117         (TypeTraits<BitVector>::One << ApplyBeaconScreenTranslationFieldId);
 118     static const OSG::BitVector ViewFieldMask =
 119         (TypeTraits<BitVector>::One << ViewFieldId);
 120     static const OSG::BitVector NextFieldMask =
 121         (TypeTraits<BitVector>::One << NextFieldId);
 122
 123     typedef SFWeakNodePtr     SFBeaconType;
 124     typedef SFBool            SFInvertWorldTransformType;
 125     typedef SFBool            SFInvertViewTransformType;
 126     typedef SFBool            SFApplyBeaconRotationType;
 127     typedef SFBool            SFApplyBeaconScreenTranslationType;
 128     typedef SFMatrix          SFViewType;
 129
 130     /*---------------------------------------------------------------------*/
 131     /*! \name                    Class Get                                 */
 132     /*! \{                                                                 */
 133
 134     static FieldContainerType &getClassType   (void);
 135     static UInt32              getClassTypeId (void);
 136     static UInt16              getClassGroupId(void);
 137
 138     /*! \}                                                                 */
 139     /*---------------------------------------------------------------------*/
 140     /*! \name                FieldContainer Get                            */
 141     /*! \{                                                                 */
 142
 143     virtual       FieldContainerType &getType         (void);
 144     virtual const FieldContainerType &getType         (void) const;
 145
 146     virtual       UInt32              getContainerSize(void) const;
 147
 148     /*! \}                                                                 */
 149     /*---------------------------------------------------------------------*/
 150     /*! \name                    Field Get                                 */
 151     /*! \{                                                                 */
 152
 153             const SFWeakNodePtr       *getSFBeacon         (void) const;
 154                   SFWeakNodePtr       *editSFBeacon         (void);
 155
 156                   SFBool              *editSFInvertWorldTransform(void);
 157             const SFBool              *getSFInvertWorldTransform (void) const;
 158
 159                   SFBool              *editSFInvertViewTransform(void);
 160             const SFBool              *getSFInvertViewTransform (void) const;
 161
 162                   SFBool              *editSFApplyBeaconRotation(void);
 163             const SFBool              *getSFApplyBeaconRotation (void) const;
 164
 165                   SFBool              *editSFApplyBeaconScreenTranslation(void);
 166             const SFBool              *getSFApplyBeaconScreenTranslation (void) const;
 167
 168                   SFMatrix            *editSFView           (void);
 169             const SFMatrix            *getSFView            (void) const;
 170
 171
 172                   Node * getBeacon         (void) const;
 173
 174                   bool                &editInvertWorldTransform(void);
 175                   bool                 getInvertWorldTransform (void) const;
 176
 177                   bool                &editInvertViewTransform(void);
 178                   bool                 getInvertViewTransform (void) const;
 179
 180                   bool                &editApplyBeaconRotation(void);
 181                   bool                 getApplyBeaconRotation (void) const;
 182
 183                   bool                &editApplyBeaconScreenTranslation(void);
 184                   bool                 getApplyBeaconScreenTranslation (void) const;
 185
 186                   Matrix              &editView           (void);
 187             const Matrix              &getView            (void) const;
 188
 189     /*! \}                                                                 */
 190     /*---------------------------------------------------------------------*/
 191     /*! \name                    Field Set                                 */
 192     /*! \{                                                                 */
 193
 194             void setBeacon         (Node * const value);
 195             void setInvertWorldTransform(const bool value);
 196             void setInvertViewTransform(const bool value);
 197             void setApplyBeaconRotation(const bool value);
 198             void setApplyBeaconScreenTranslation(const bool value);
 199             void setView           (const Matrix &value);
 200
 201     /*! \}                                                                 */
 202     /*---------------------------------------------------------------------*/
 203     /*! \name                Ptr Field Set                                 */
 204     /*! \{                                                                 */
 205
 206     /*! \}                                                                 */
 207     /*---------------------------------------------------------------------*/
 208     /*! \name                Ptr MField Set                                */
 209     /*! \{                                                                 */
 210
 211     /*! \}                                                                 */
 212     /*---------------------------------------------------------------------*/
 213     /*! \name                   Binary Access                              */
 214     /*! \{                                                                 */
 215
 216     virtual SizeT  getBinSize (ConstFieldMaskArg  whichField);
 217     virtual void   copyToBin  (BinaryDataHandler &pMem,
 218                                ConstFieldMaskArg  whichField);
 219     virtual void   copyFromBin(BinaryDataHandler &pMem,
 220                                ConstFieldMaskArg  whichField);
 221
 222
 223     /*! \}                                                                 */
 224     /*---------------------------------------------------------------------*/
 225     /*! \name                   Construction                               */
 226     /*! \{                                                                 */
 227
 228     static  ScreenTransformTransitPtr  create          (void);
 229     static  ScreenTransform           *createEmpty     (void);
 230
 231     static  ScreenTransformTransitPtr  createLocal     (
 232                                                BitVector bFlags = FCLocal::All);
 233
 234     static  ScreenTransform            *createEmptyLocal(
 235                                               BitVector bFlags = FCLocal::All);
 236
 237     static  ScreenTransformTransitPtr  createDependent  (BitVector bFlags);
 238
 239     /*! \}                                                                 */
 240     /*---------------------------------------------------------------------*/
 241     /*! \name                       Copy                                   */
 242     /*! \{                                                                 */
 243
 244     virtual FieldContainerTransitPtr shallowCopy     (void) const;
 245     virtual FieldContainerTransitPtr shallowCopyLocal(
 246                                        BitVector bFlags = FCLocal::All) const;
 247     virtual FieldContainerTransitPtr shallowCopyDependent(
 248                                                       BitVector bFlags) const;
 249
 250     /*! \}                                                                 */
 251     /*=========================  PROTECTED  ===============================*/
 252
 253   protected:
 254
 255     static TypeObject _type;
 256
 257     static       void   classDescInserter(TypeObject &oType);
 258     static const Char8 *getClassname     (void             );
 259
 260     /*---------------------------------------------------------------------*/
 261     /*! \name                      Fields                                  */
 262     /*! \{                                                                 */
 263
 264     SFWeakNodePtr     _sfBeacon;
 265     SFBool            _sfInvertWorldTransform;
 266     SFBool            _sfInvertViewTransform;
 267     SFBool            _sfApplyBeaconRotation;
 268     SFBool            _sfApplyBeaconScreenTranslation;
 269     SFMatrix          _sfView;
 270
 271     /*! \}                                                                 */
 272     /*---------------------------------------------------------------------*/
 273     /*! \name                   Constructors                               */
 274     /*! \{                                                                 */
 275
 276     ScreenTransformBase(void);
 277     ScreenTransformBase(const ScreenTransformBase &source);
 278
 279     /*! \}                                                                 */
 280     /*---------------------------------------------------------------------*/
 281     /*! \name                   Destructors                                */
 282     /*! \{                                                                 */
 283
 284     virtual ~ScreenTransformBase(void);
 285
 286     /*! \}                                                                 */
 287     /*---------------------------------------------------------------------*/
 288     /*! \name                     onCreate                                */
 289     /*! \{                                                                 */
 290
 291     void onCreate(const ScreenTransform *source = NULL);
 292
 293     /*! \}                                                                 */
 294     /*---------------------------------------------------------------------*/
 295     /*! \name                    Generic Field Access                      */
 296     /*! \{                                                                 */
 297
 298      GetFieldHandlePtr  getHandleBeacon          (void) const;
 299      EditFieldHandlePtr editHandleBeacon         (void);
 300      GetFieldHandlePtr  getHandleInvertWorldTransform (void) const;
 301      EditFieldHandlePtr editHandleInvertWorldTransform(void);
 302      GetFieldHandlePtr  getHandleInvertViewTransform (void) const;
 303      EditFieldHandlePtr editHandleInvertViewTransform(void);
 304      GetFieldHandlePtr  getHandleApplyBeaconRotation (void) const;
 305      EditFieldHandlePtr editHandleApplyBeaconRotation(void);
 306      GetFieldHandlePtr  getHandleApplyBeaconScreenTranslation (void) const;
 307      EditFieldHandlePtr editHandleApplyBeaconScreenTranslation(void);
 308      GetFieldHandlePtr  getHandleView            (void) const;
 309      EditFieldHandlePtr editHandleView           (void);
 310
 311     /*! \}                                                                 */
 312     /*---------------------------------------------------------------------*/
 313     /*! \name                       Sync                                   */
 314     /*! \{                                                                 */
 315
 316 #ifdef OSG_MT_CPTR_ASPECT
 317     virtual void execSyncV(      FieldContainer    &oFrom,
 318                                  ConstFieldMaskArg  whichField,
 319                                  AspectOffsetStore &oOffsets,
 320                                  ConstFieldMaskArg  syncMode  ,
 321                            const UInt32             uiSyncInfo);
 322
 323             void execSync (      ScreenTransformBase *pFrom,
 324                                  ConstFieldMaskArg  whichField,
 325                                  AspectOffsetStore &oOffsets,
 326                                  ConstFieldMaskArg  syncMode  ,
 327                            const UInt32             uiSyncInfo);
 328 #endif
 329
 330     /*! \}                                                                 */
 331     /*---------------------------------------------------------------------*/
 332     /*! \name                       Edit                                   */
 333     /*! \{                                                                 */
 334
 335     /*! \}                                                                 */
 336     /*---------------------------------------------------------------------*/
 337     /*! \name                     Aspect Create                            */
 338     /*! \{                                                                 */
 339
 340 #ifdef OSG_MT_CPTR_ASPECT
 341     virtual FieldContainer *createAspectCopy(
 342                                     const FieldContainer *pRefAspect) const;
 343 #endif
 344
 345     /*! \}                                                                 */
 346     /*---------------------------------------------------------------------*/
 347     /*! \name                       Edit                                   */
 348     /*! \{                                                                 */
 349     /*! \}                                                                 */
 350     /*---------------------------------------------------------------------*/
 351     /*! \name                       Sync                                   */
 352     /*! \{                                                                 */
 353
 354     virtual void resolveLinks(void);
 355
 356     /*! \}                                                                 */
 357     /*==========================  PRIVATE  ================================*/
 358
 359   private:
 360     /*---------------------------------------------------------------------*/
 361
 362     // prohibit default functions (move to 'public' if you need one)
 363     void operator =(const ScreenTransformBase &source);
 364 };
 365
 366 typedef ScreenTransformBase *ScreenTransformBaseP;
 367
 368 typedef CoredNodeRefPtr  <ScreenTransform> ScreenTransformNodeRefPtr;
 369 typedef CoredNodeMTRefPtr<ScreenTransform> ScreenTransformNodeMTRefPtr;
 370
 371 OSG_END_NAMESPACE
 372
 373 #endif /* _OSGSCREENTRANSFORMBASE_H_ */