Source/System/Window/Camera/OSGOrthographicCameraBase.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 OrthographicCamera
  49  **                                                                         **
  50  *****************************************************************************
  51 \*****************************************************************************/
  52
  53
  54 #ifndef _OSGORTHOGRAPHICCAMERABASE_H_
  55 #define _OSGORTHOGRAPHICCAMERABASE_H_
  56 #ifdef __sgi
  57 #pragma once
  58 #endif
  59
  60
  61 #include "OSGConfig.h"
  62 #include "OSGWindowDef.h"
  63
  64 //#include "OSGBaseTypes.h"
  65
  66 #include "OSGCamera.h" // Parent
  67
  68 #include "OSGSysFields.h"               // VerticalSize type
  69
  70 #include "OSGOrthographicCameraFields.h"
  71
  72 OSG_BEGIN_NAMESPACE
  73
  74
  75 class OrthographicCamera;
  76
  77 //! \brief OrthographicCamera Base Class.
  78
  79 class OSG_WINDOW_DLLMAPPING OrthographicCameraBase : public Camera
  80 {
  81   public:
  82
  83     typedef Camera Inherited;
  84     typedef Camera ParentContainer;
  85
  86     typedef Inherited::TypeObject TypeObject;
  87     typedef TypeObject::InitPhase InitPhase;
  88
  89     OSG_GEN_INTERNALPTR(OrthographicCamera);
  90
  91     /*==========================  PUBLIC  =================================*/
  92
  93   public:
  94
  95     enum
  96     {
  97         VerticalSizeFieldId = Inherited::NextFieldId,
  98         HorizontalSizeFieldId = VerticalSizeFieldId + 1,
  99         AspectFieldId = HorizontalSizeFieldId + 1,
 100         NextFieldId = AspectFieldId + 1
 101     };
 102
 103     static const OSG::BitVector VerticalSizeFieldMask =
 104         (TypeTraits<BitVector>::One << VerticalSizeFieldId);
 105     static const OSG::BitVector HorizontalSizeFieldMask =
 106         (TypeTraits<BitVector>::One << HorizontalSizeFieldId);
 107     static const OSG::BitVector AspectFieldMask =
 108         (TypeTraits<BitVector>::One << AspectFieldId);
 109     static const OSG::BitVector NextFieldMask =
 110         (TypeTraits<BitVector>::One << NextFieldId);
 111
 112     typedef SFReal32          SFVerticalSizeType;
 113     typedef SFReal32          SFHorizontalSizeType;
 114     typedef SFReal32          SFAspectType;
 115
 116     /*---------------------------------------------------------------------*/
 117     /*! \name                    Class Get                                 */
 118     /*! \{                                                                 */
 119
 120     static FieldContainerType &getClassType   (void);
 121     static UInt32              getClassTypeId (void);
 122     static UInt16              getClassGroupId(void);
 123
 124     /*! \}                                                                 */
 125     /*---------------------------------------------------------------------*/
 126     /*! \name                FieldContainer Get                            */
 127     /*! \{                                                                 */
 128
 129     virtual       FieldContainerType &getType         (void);
 130     virtual const FieldContainerType &getType         (void) const;
 131
 132     virtual       UInt32              getContainerSize(void) const;
 133
 134     /*! \}                                                                 */
 135     /*---------------------------------------------------------------------*/
 136     /*! \name                    Field Get                                 */
 137     /*! \{                                                                 */
 138
 139
 140                   SFReal32            *editSFVerticalSize   (void);
 141             const SFReal32            *getSFVerticalSize    (void) const;
 142
 143                   SFReal32            *editSFHorizontalSize (void);
 144             const SFReal32            *getSFHorizontalSize  (void) const;
 145
 146                   SFReal32            *editSFAspect         (void);
 147             const SFReal32            *getSFAspect          (void) const;
 148
 149
 150                   Real32              &editVerticalSize   (void);
 151                   Real32               getVerticalSize    (void) const;
 152
 153                   Real32              &editHorizontalSize (void);
 154                   Real32               getHorizontalSize  (void) const;
 155
 156                   Real32              &editAspect         (void);
 157                   Real32               getAspect          (void) const;
 158
 159     /*! \}                                                                 */
 160     /*---------------------------------------------------------------------*/
 161     /*! \name                    Field Set                                 */
 162     /*! \{                                                                 */
 163
 164             void setVerticalSize   (const Real32 value);
 165             void setHorizontalSize (const Real32 value);
 166             void setAspect         (const Real32 value);
 167
 168     /*! \}                                                                 */
 169     /*---------------------------------------------------------------------*/
 170     /*! \name                Ptr MField Set                                */
 171     /*! \{                                                                 */
 172
 173     /*! \}                                                                 */
 174     /*---------------------------------------------------------------------*/
 175     /*! \name                   Binary Access                              */
 176     /*! \{                                                                 */
 177
 178     virtual SizeT  getBinSize (ConstFieldMaskArg  whichField);
 179     virtual void   copyToBin  (BinaryDataHandler &pMem,
 180                                ConstFieldMaskArg  whichField);
 181     virtual void   copyFromBin(BinaryDataHandler &pMem,
 182                                ConstFieldMaskArg  whichField);
 183
 184
 185     /*! \}                                                                 */
 186     /*---------------------------------------------------------------------*/
 187     /*! \name                   Construction                               */
 188     /*! \{                                                                 */
 189
 190     static  OrthographicCameraTransitPtr  create          (void);
 191     static  OrthographicCamera           *createEmpty     (void);
 192
 193     static  OrthographicCameraTransitPtr  createLocal     (
 194                                                BitVector bFlags = FCLocal::All);
 195
 196     static  OrthographicCamera            *createEmptyLocal(
 197                                               BitVector bFlags = FCLocal::All);
 198
 199     static  OrthographicCameraTransitPtr  createDependent  (BitVector bFlags);
 200
 201     /*! \}                                                                 */
 202     /*---------------------------------------------------------------------*/
 203     /*! \name                       Copy                                   */
 204     /*! \{                                                                 */
 205
 206     virtual FieldContainerTransitPtr shallowCopy     (void) const;
 207     virtual FieldContainerTransitPtr shallowCopyLocal(
 208                                        BitVector bFlags = FCLocal::All) const;
 209     virtual FieldContainerTransitPtr shallowCopyDependent(
 210                                                       BitVector bFlags) const;
 211
 212     /*! \}                                                                 */
 213     /*=========================  PROTECTED  ===============================*/
 214
 215   protected:
 216
 217     static TypeObject _type;
 218
 219     static       void   classDescInserter(TypeObject &oType);
 220     static const Char8 *getClassname     (void             );
 221
 222     /*---------------------------------------------------------------------*/
 223     /*! \name                      Fields                                  */
 224     /*! \{                                                                 */
 225
 226     SFReal32          _sfVerticalSize;
 227     SFReal32          _sfHorizontalSize;
 228     SFReal32          _sfAspect;
 229
 230     /*! \}                                                                 */
 231     /*---------------------------------------------------------------------*/
 232     /*! \name                   Constructors                               */
 233     /*! \{                                                                 */
 234
 235     OrthographicCameraBase(void);
 236     OrthographicCameraBase(const OrthographicCameraBase &source);
 237
 238     /*! \}                                                                 */
 239     /*---------------------------------------------------------------------*/
 240     /*! \name                   Destructors                                */
 241     /*! \{                                                                 */
 242
 243     virtual ~OrthographicCameraBase(void);
 244
 245     /*! \}                                                                 */
 246     /*---------------------------------------------------------------------*/
 247     /*! \name                     onCreate                                */
 248     /*! \{                                                                 */
 249
 250
 251     /*! \}                                                                 */
 252     /*---------------------------------------------------------------------*/
 253     /*! \name                    Generic Field Access                      */
 254     /*! \{                                                                 */
 255
 256      GetFieldHandlePtr  getHandleVerticalSize    (void) const;
 257      EditFieldHandlePtr editHandleVerticalSize   (void);
 258      GetFieldHandlePtr  getHandleHorizontalSize  (void) const;
 259      EditFieldHandlePtr editHandleHorizontalSize (void);
 260      GetFieldHandlePtr  getHandleAspect          (void) const;
 261      EditFieldHandlePtr editHandleAspect         (void);
 262
 263     /*! \}                                                                 */
 264     /*---------------------------------------------------------------------*/
 265     /*! \name                       Sync                                   */
 266     /*! \{                                                                 */
 267
 268 #ifdef OSG_MT_CPTR_ASPECT
 269     virtual void execSyncV(      FieldContainer    &oFrom,
 270                                  ConstFieldMaskArg  whichField,
 271                                  AspectOffsetStore &oOffsets,
 272                                  ConstFieldMaskArg  syncMode  ,
 273                            const UInt32             uiSyncInfo);
 274
 275             void execSync (      OrthographicCameraBase *pFrom,
 276                                  ConstFieldMaskArg  whichField,
 277                                  AspectOffsetStore &oOffsets,
 278                                  ConstFieldMaskArg  syncMode  ,
 279                            const UInt32             uiSyncInfo);
 280 #endif
 281
 282     /*! \}                                                                 */
 283     /*---------------------------------------------------------------------*/
 284     /*! \name                       Edit                                   */
 285     /*! \{                                                                 */
 286
 287     /*! \}                                                                 */
 288     /*---------------------------------------------------------------------*/
 289     /*! \name                     Aspect Create                            */
 290     /*! \{                                                                 */
 291
 292 #ifdef OSG_MT_CPTR_ASPECT
 293     virtual FieldContainer *createAspectCopy(
 294                                     const FieldContainer *pRefAspect) const;
 295 #endif
 296
 297     /*! \}                                                                 */
 298     /*---------------------------------------------------------------------*/
 299     /*! \name                       Edit                                   */
 300     /*! \{                                                                 */
 301     /*! \}                                                                 */
 302     /*---------------------------------------------------------------------*/
 303     /*! \name                       Sync                                   */
 304     /*! \{                                                                 */
 305
 306     virtual void resolveLinks(void);
 307
 308     /*! \}                                                                 */
 309     /*==========================  PRIVATE  ================================*/
 310
 311   private:
 312     /*---------------------------------------------------------------------*/
 313
 314     // prohibit default functions (move to 'public' if you need one)
 315     void operator =(const OrthographicCameraBase &source);
 316 };
 317
 318 typedef OrthographicCameraBase *OrthographicCameraBaseP;
 319
 320 OSG_END_NAMESPACE
 321
 322 #endif /* _OSGORTHOGRAPHICCAMERABASE_H_ */