Source/Contrib/Manipulators/OSGPlaneMoveManipulatorBase.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 PlaneMoveManipulator
  49  **                                                                         **
  50  *****************************************************************************
  51 \*****************************************************************************/
  52
  53
  54 #ifndef _OSGPLANEMOVEMANIPULATORBASE_H_
  55 #define _OSGPLANEMOVEMANIPULATORBASE_H_
  56 #ifdef __sgi
  57 #pragma once
  58 #endif
  59
  60
  61 #include "OSGConfig.h"
  62 #include "OSGContribGUIDef.h"
  63
  64 //#include "OSGBaseTypes.h"
  65
  66 #include "OSGManipulator.h" // Parent
  67
  68 #include "OSGSysFields.h"               // Axis type
  69 #include "OSGVecFields.h"               // BaseTranslation type
  70 #include "OSGMathFields.h"              // BaseRotation type
  71
  72 #include "OSGPlaneMoveManipulatorFields.h"
  73
  74 OSG_BEGIN_NAMESPACE
  75
  76
  77 class PlaneMoveManipulator;
  78
  79 //! \brief PlaneMoveManipulator Base Class.
  80
  81 class OSG_CONTRIBGUI_DLLMAPPING PlaneMoveManipulatorBase : public Manipulator
  82 {
  83   public:
  84
  85     typedef Manipulator Inherited;
  86     typedef Manipulator ParentContainer;
  87
  88     typedef Inherited::TypeObject TypeObject;
  89     typedef TypeObject::InitPhase InitPhase;
  90
  91     OSG_GEN_INTERNALPTR(PlaneMoveManipulator);
  92
  93     /*==========================  PUBLIC  =================================*/
  94
  95   public:
  96
  97     enum
  98     {
  99         AxisFieldId = Inherited::NextFieldId,
 100         BaseTranslationFieldId = AxisFieldId + 1,
 101         BaseRotationFieldId = BaseTranslationFieldId + 1,
 102         ClickPointFieldId = BaseRotationFieldId + 1,
 103         NextFieldId = ClickPointFieldId + 1
 104     };
 105
 106     static const OSG::BitVector AxisFieldMask =
 107         (TypeTraits<BitVector>::One << AxisFieldId);
 108     static const OSG::BitVector BaseTranslationFieldMask =
 109         (TypeTraits<BitVector>::One << BaseTranslationFieldId);
 110     static const OSG::BitVector BaseRotationFieldMask =
 111         (TypeTraits<BitVector>::One << BaseRotationFieldId);
 112     static const OSG::BitVector ClickPointFieldMask =
 113         (TypeTraits<BitVector>::One << ClickPointFieldId);
 114     static const OSG::BitVector NextFieldMask =
 115         (TypeTraits<BitVector>::One << NextFieldId);
 116
 117     typedef SFUInt16          SFAxisType;
 118     typedef SFVec3f           SFBaseTranslationType;
 119     typedef SFQuaternion      SFBaseRotationType;
 120     typedef SFPnt3f           SFClickPointType;
 121
 122     /*---------------------------------------------------------------------*/
 123     /*! \name                    Class Get                                 */
 124     /*! \{                                                                 */
 125
 126     static FieldContainerType &getClassType   (void);
 127     static UInt32              getClassTypeId (void);
 128     static UInt16              getClassGroupId(void);
 129
 130     /*! \}                                                                 */
 131     /*---------------------------------------------------------------------*/
 132     /*! \name                FieldContainer Get                            */
 133     /*! \{                                                                 */
 134
 135     virtual       FieldContainerType &getType         (void);
 136     virtual const FieldContainerType &getType         (void) const;
 137
 138     virtual       UInt32              getContainerSize(void) const;
 139
 140     /*! \}                                                                 */
 141     /*---------------------------------------------------------------------*/
 142     /*! \name                   Binary Access                              */
 143     /*! \{                                                                 */
 144
 145     virtual SizeT  getBinSize (ConstFieldMaskArg  whichField);
 146     virtual void   copyToBin  (BinaryDataHandler &pMem,
 147                                ConstFieldMaskArg  whichField);
 148     virtual void   copyFromBin(BinaryDataHandler &pMem,
 149                                ConstFieldMaskArg  whichField);
 150
 151
 152     /*! \}                                                                 */
 153     /*---------------------------------------------------------------------*/
 154     /*! \name                   Construction                               */
 155     /*! \{                                                                 */
 156
 157     static  PlaneMoveManipulatorTransitPtr  create          (void);
 158     static  PlaneMoveManipulator           *createEmpty     (void);
 159
 160     static  PlaneMoveManipulatorTransitPtr  createLocal     (
 161                                                BitVector bFlags = FCLocal::All);
 162
 163     static  PlaneMoveManipulator            *createEmptyLocal(
 164                                               BitVector bFlags = FCLocal::All);
 165
 166     static  PlaneMoveManipulatorTransitPtr  createDependent  (BitVector bFlags);
 167
 168     /*! \}                                                                 */
 169     /*---------------------------------------------------------------------*/
 170     /*! \name                       Copy                                   */
 171     /*! \{                                                                 */
 172
 173     virtual FieldContainerTransitPtr shallowCopy     (void) const;
 174     virtual FieldContainerTransitPtr shallowCopyLocal(
 175                                        BitVector bFlags = FCLocal::All) const;
 176     virtual FieldContainerTransitPtr shallowCopyDependent(
 177                                                       BitVector bFlags) const;
 178
 179     /*! \}                                                                 */
 180     /*=========================  PROTECTED  ===============================*/
 181
 182   protected:
 183
 184     static TypeObject _type;
 185
 186     static       void   classDescInserter(TypeObject &oType);
 187     static const Char8 *getClassname     (void             );
 188
 189     /*---------------------------------------------------------------------*/
 190     /*! \name                      Fields                                  */
 191     /*! \{                                                                 */
 192
 193     SFUInt16          _sfAxis;
 194     SFVec3f           _sfBaseTranslation;
 195     SFQuaternion      _sfBaseRotation;
 196     SFPnt3f           _sfClickPoint;
 197
 198     /*! \}                                                                 */
 199     /*---------------------------------------------------------------------*/
 200     /*! \name                   Constructors                               */
 201     /*! \{                                                                 */
 202
 203     PlaneMoveManipulatorBase(void);
 204     PlaneMoveManipulatorBase(const PlaneMoveManipulatorBase &source);
 205
 206     /*! \}                                                                 */
 207     /*---------------------------------------------------------------------*/
 208     /*! \name                   Destructors                                */
 209     /*! \{                                                                 */
 210
 211     virtual ~PlaneMoveManipulatorBase(void);
 212
 213     /*! \}                                                                 */
 214     /*---------------------------------------------------------------------*/
 215     /*! \name                     onCreate                                */
 216     /*! \{                                                                 */
 217
 218
 219     /*! \}                                                                 */
 220     /*---------------------------------------------------------------------*/
 221     /*! \name                    Generic Field Access                      */
 222     /*! \{                                                                 */
 223
 224      GetFieldHandlePtr  getHandleAxis            (void) const;
 225      EditFieldHandlePtr editHandleAxis           (void);
 226      GetFieldHandlePtr  getHandleBaseTranslation (void) const;
 227      EditFieldHandlePtr editHandleBaseTranslation(void);
 228      GetFieldHandlePtr  getHandleBaseRotation    (void) const;
 229      EditFieldHandlePtr editHandleBaseRotation   (void);
 230      GetFieldHandlePtr  getHandleClickPoint      (void) const;
 231      EditFieldHandlePtr editHandleClickPoint     (void);
 232
 233     /*! \}                                                                 */
 234     /*---------------------------------------------------------------------*/
 235     /*! \name                    Field Get                                 */
 236     /*! \{                                                                 */
 237
 238
 239                   SFUInt16            *editSFAxis           (void);
 240             const SFUInt16            *getSFAxis            (void) const;
 241
 242                   SFVec3f             *editSFBaseTranslation(void);
 243             const SFVec3f             *getSFBaseTranslation (void) const;
 244
 245                   SFQuaternion        *editSFBaseRotation   (void);
 246             const SFQuaternion        *getSFBaseRotation    (void) const;
 247
 248                   SFPnt3f             *editSFClickPoint     (void);
 249             const SFPnt3f             *getSFClickPoint      (void) const;
 250
 251
 252                   UInt16              &editAxis           (void);
 253                   UInt16               getAxis            (void) const;
 254
 255                   Vec3f               &editBaseTranslation(void);
 256             const Vec3f               &getBaseTranslation (void) const;
 257
 258                   Quaternion          &editBaseRotation   (void);
 259             const Quaternion          &getBaseRotation    (void) const;
 260
 261                   Pnt3f               &editClickPoint     (void);
 262             const Pnt3f               &getClickPoint      (void) const;
 263
 264     /*! \}                                                                 */
 265     /*---------------------------------------------------------------------*/
 266     /*! \name                    Field Set                                 */
 267     /*! \{                                                                 */
 268
 269             void setAxis           (const UInt16 value);
 270             void setBaseTranslation(const Vec3f &value);
 271             void setBaseRotation   (const Quaternion &value);
 272             void setClickPoint     (const Pnt3f &value);
 273
 274     /*! \}                                                                 */
 275     /*---------------------------------------------------------------------*/
 276     /*! \name                Ptr MField Set                                */
 277     /*! \{                                                                 */
 278
 279     /*! \}                                                                 */
 280     /*---------------------------------------------------------------------*/
 281     /*! \name                       Sync                                   */
 282     /*! \{                                                                 */
 283
 284 #ifdef OSG_MT_CPTR_ASPECT
 285     virtual void execSyncV(      FieldContainer    &oFrom,
 286                                  ConstFieldMaskArg  whichField,
 287                                  AspectOffsetStore &oOffsets,
 288                                  ConstFieldMaskArg  syncMode  ,
 289                            const UInt32             uiSyncInfo);
 290
 291             void execSync (      PlaneMoveManipulatorBase *pFrom,
 292                                  ConstFieldMaskArg  whichField,
 293                                  AspectOffsetStore &oOffsets,
 294                                  ConstFieldMaskArg  syncMode  ,
 295                            const UInt32             uiSyncInfo);
 296 #endif
 297
 298     /*! \}                                                                 */
 299     /*---------------------------------------------------------------------*/
 300     /*! \name                       Edit                                   */
 301     /*! \{                                                                 */
 302
 303     /*! \}                                                                 */
 304     /*---------------------------------------------------------------------*/
 305     /*! \name                     Aspect Create                            */
 306     /*! \{                                                                 */
 307
 308 #ifdef OSG_MT_CPTR_ASPECT
 309     virtual FieldContainer *createAspectCopy(
 310                                     const FieldContainer *pRefAspect) const;
 311 #endif
 312
 313     /*! \}                                                                 */
 314     /*---------------------------------------------------------------------*/
 315     /*! \name                       Edit                                   */
 316     /*! \{                                                                 */
 317     /*! \}                                                                 */
 318     /*---------------------------------------------------------------------*/
 319     /*! \name                       Sync                                   */
 320     /*! \{                                                                 */
 321
 322     virtual void resolveLinks(void);
 323
 324     /*! \}                                                                 */
 325     /*==========================  PRIVATE  ================================*/
 326
 327   private:
 328     /*---------------------------------------------------------------------*/
 329
 330     // prohibit default functions (move to 'public' if you need one)
 331     void operator =(const PlaneMoveManipulatorBase &source);
 332 };
 333
 334 typedef PlaneMoveManipulatorBase *PlaneMoveManipulatorBaseP;
 335
 336 OSG_END_NAMESPACE
 337
 338 #endif /* _OSGPLANEMOVEMANIPULATORBASE_H_ */