Source/System/State/Shader/Variables/OSGShaderVariableMMatrixBase.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 ShaderVariableMMatrix
  49  **                                                                         **
  50  *****************************************************************************
  51 \*****************************************************************************/
  52
  53
  54 #ifndef _OSGSHADERVARIABLEMMATRIXBASE_H_
  55 #define _OSGSHADERVARIABLEMMATRIXBASE_H_
  56 #ifdef __sgi
  57 #pragma once
  58 #endif
  59
  60
  61 #include "OSGConfig.h"
  62 #include "OSGSystemDef.h"
  63
  64 //#include "OSGBaseTypes.h"
  65
  66 #include "OSGShaderValueVariable.h" // Parent
  67
  68 #include "OSGMathFields.h"              // Value type
  69
  70 #include "OSGShaderVariableMMatrixFields.h"
  71
  72 OSG_BEGIN_NAMESPACE
  73
  74
  75 class ShaderVariableMMatrix;
  76
  77 //! \brief ShaderVariableMMatrix Base Class.
  78
  79 class OSG_SYSTEM_DLLMAPPING ShaderVariableMMatrixBase : public ShaderValueVariable
  80 {
  81   public:
  82
  83     typedef ShaderValueVariable Inherited;
  84     typedef ShaderValueVariable ParentContainer;
  85
  86     typedef Inherited::TypeObject TypeObject;
  87     typedef TypeObject::InitPhase InitPhase;
  88
  89     OSG_GEN_INTERNALPTR(ShaderVariableMMatrix);
  90
  91     /*==========================  PUBLIC  =================================*/
  92
  93   public:
  94
  95     enum
  96     {
  97         ValueFieldId = Inherited::NextFieldId,
  98         NextFieldId = ValueFieldId + 1
  99     };
 100
 101     static const OSG::BitVector ValueFieldMask =
 102         (TypeTraits<BitVector>::One << ValueFieldId);
 103     static const OSG::BitVector NextFieldMask =
 104         (TypeTraits<BitVector>::One << NextFieldId);
 105
 106     typedef MFMatrix          MFValueType;
 107
 108     /*---------------------------------------------------------------------*/
 109     /*! \name                    Class Get                                 */
 110     /*! \{                                                                 */
 111
 112     static FieldContainerType &getClassType   (void);
 113     static UInt32              getClassTypeId (void);
 114     static UInt16              getClassGroupId(void);
 115
 116     /*! \}                                                                 */
 117     /*---------------------------------------------------------------------*/
 118     /*! \name                FieldContainer Get                            */
 119     /*! \{                                                                 */
 120
 121     virtual       FieldContainerType &getType         (void);
 122     virtual const FieldContainerType &getType         (void) const;
 123
 124     virtual       UInt32              getContainerSize(void) const;
 125
 126     /*! \}                                                                 */
 127     /*---------------------------------------------------------------------*/
 128     /*! \name                    Field Get                                 */
 129     /*! \{                                                                 */
 130
 131
 132                   MFMatrix            *editMFValue          (void);
 133             const MFMatrix            *getMFValue           (void) const;
 134
 135
 136             MFMatrix           ::reference       editValue          (const UInt32 index);
 137             const Matrix              &getValue           (const UInt32 index) const;
 138
 139     /*! \}                                                                 */
 140     /*---------------------------------------------------------------------*/
 141     /*! \name                    Field Set                                 */
 142     /*! \{                                                                 */
 143
 144
 145     /*! \}                                                                 */
 146     /*---------------------------------------------------------------------*/
 147     /*! \name                Ptr MField Set                                */
 148     /*! \{                                                                 */
 149
 150     /*! \}                                                                 */
 151     /*---------------------------------------------------------------------*/
 152     /*! \name                   Binary Access                              */
 153     /*! \{                                                                 */
 154
 155     virtual SizeT  getBinSize (ConstFieldMaskArg  whichField);
 156     virtual void   copyToBin  (BinaryDataHandler &pMem,
 157                                ConstFieldMaskArg  whichField);
 158     virtual void   copyFromBin(BinaryDataHandler &pMem,
 159                                ConstFieldMaskArg  whichField);
 160
 161
 162     /*! \}                                                                 */
 163     /*---------------------------------------------------------------------*/
 164     /*! \name                   Construction                               */
 165     /*! \{                                                                 */
 166
 167     static  ShaderVariableMMatrixTransitPtr  create          (void);
 168     static  ShaderVariableMMatrix           *createEmpty     (void);
 169
 170     static  ShaderVariableMMatrixTransitPtr  createLocal     (
 171                                                BitVector bFlags = FCLocal::All);
 172
 173     static  ShaderVariableMMatrix            *createEmptyLocal(
 174                                               BitVector bFlags = FCLocal::All);
 175
 176     static  ShaderVariableMMatrixTransitPtr  createDependent  (BitVector bFlags);
 177
 178     /*! \}                                                                 */
 179     /*---------------------------------------------------------------------*/
 180     /*! \name                       Copy                                   */
 181     /*! \{                                                                 */
 182
 183     virtual FieldContainerTransitPtr shallowCopy     (void) const;
 184     virtual FieldContainerTransitPtr shallowCopyLocal(
 185                                        BitVector bFlags = FCLocal::All) const;
 186     virtual FieldContainerTransitPtr shallowCopyDependent(
 187                                                       BitVector bFlags) const;
 188
 189     /*! \}                                                                 */
 190     /*=========================  PROTECTED  ===============================*/
 191
 192   protected:
 193
 194     static TypeObject _type;
 195
 196     static       void   classDescInserter(TypeObject &oType);
 197     static const Char8 *getClassname     (void             );
 198
 199     /*---------------------------------------------------------------------*/
 200     /*! \name                      Fields                                  */
 201     /*! \{                                                                 */
 202
 203     MFMatrix          _mfValue;
 204
 205     /*! \}                                                                 */
 206     /*---------------------------------------------------------------------*/
 207     /*! \name                   Constructors                               */
 208     /*! \{                                                                 */
 209
 210     ShaderVariableMMatrixBase(void);
 211     ShaderVariableMMatrixBase(const ShaderVariableMMatrixBase &source);
 212
 213     /*! \}                                                                 */
 214     /*---------------------------------------------------------------------*/
 215     /*! \name                   Destructors                                */
 216     /*! \{                                                                 */
 217
 218     virtual ~ShaderVariableMMatrixBase(void);
 219
 220     /*! \}                                                                 */
 221     /*---------------------------------------------------------------------*/
 222     /*! \name                     onCreate                                */
 223     /*! \{                                                                 */
 224
 225
 226     /*! \}                                                                 */
 227     /*---------------------------------------------------------------------*/
 228     /*! \name                    Generic Field Access                      */
 229     /*! \{                                                                 */
 230
 231      GetFieldHandlePtr  getHandleValue           (void) const;
 232      EditFieldHandlePtr editHandleValue          (void);
 233
 234     /*! \}                                                                 */
 235     /*---------------------------------------------------------------------*/
 236     /*! \name                       Sync                                   */
 237     /*! \{                                                                 */
 238
 239 #ifdef OSG_MT_CPTR_ASPECT
 240     virtual void execSyncV(      FieldContainer    &oFrom,
 241                                  ConstFieldMaskArg  whichField,
 242                                  AspectOffsetStore &oOffsets,
 243                                  ConstFieldMaskArg  syncMode  ,
 244                            const UInt32             uiSyncInfo);
 245
 246             void execSync (      ShaderVariableMMatrixBase *pFrom,
 247                                  ConstFieldMaskArg  whichField,
 248                                  AspectOffsetStore &oOffsets,
 249                                  ConstFieldMaskArg  syncMode  ,
 250                            const UInt32             uiSyncInfo);
 251 #endif
 252
 253     /*! \}                                                                 */
 254     /*---------------------------------------------------------------------*/
 255     /*! \name                       Edit                                   */
 256     /*! \{                                                                 */
 257
 258     /*! \}                                                                 */
 259     /*---------------------------------------------------------------------*/
 260     /*! \name                     Aspect Create                            */
 261     /*! \{                                                                 */
 262
 263 #ifdef OSG_MT_CPTR_ASPECT
 264     virtual FieldContainer *createAspectCopy(
 265                                     const FieldContainer *pRefAspect) const;
 266 #endif
 267
 268     /*! \}                                                                 */
 269     /*---------------------------------------------------------------------*/
 270     /*! \name                       Edit                                   */
 271     /*! \{                                                                 */
 272     /*! \}                                                                 */
 273     /*---------------------------------------------------------------------*/
 274     /*! \name                       Sync                                   */
 275     /*! \{                                                                 */
 276
 277     virtual void resolveLinks(void);
 278
 279     /*! \}                                                                 */
 280     /*==========================  PRIVATE  ================================*/
 281
 282   private:
 283     /*---------------------------------------------------------------------*/
 284
 285     // prohibit default functions (move to 'public' if you need one)
 286     void operator =(const ShaderVariableMMatrixBase &source);
 287 };
 288
 289 typedef ShaderVariableMMatrixBase *ShaderVariableMMatrixBaseP;
 290
 291 OSG_END_NAMESPACE
 292
 293 #endif /* _OSGSHADERVARIABLEMMATRIXBASE_H_ */