Source/System/NodeCores/Drawables/Geometry/PropertiesBase/OSGGeoVectorProperty.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-2006 by the OpenSG Forum                 *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
  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 #ifndef _OSGGEOVECTORPROPERTY_H_
  40 #define _OSGGEOVECTORPROPERTY_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGVector.h"
  46 #include "OSGGeoVectorPropertyBase.h"
  47 #include "OSGGeoVectorPropertyConversion.h"
  48
  49 OSG_BEGIN_NAMESPACE
  50
  51 class DrawEnv;
  52
  53 /*! \brief GeoVectorProperty class. See \ref
  54            PageDrawableGeoVectorProperty for a description.
  55     \ingroup GrpDrawablesGeometryProperties
  56     \ingroup GrpLibOSGDrawables
  57     \includebasedoc
  58  */
  59
  60 class OSG_SYSTEM_DLLMAPPING GeoVectorProperty :
  61     public GeoVectorPropertyBase
  62 {
  63   private:
  64
  65     /*==========================  PUBLIC  =================================*/
  66
  67   public:
  68
  69     typedef GeoVectorPropertyBase                             Inherited;
  70
  71     /*---------------------------------------------------------------------*/
  72     /*! \name        Arbitrary Type Interface Methods                      */
  73     /*! \{                                                                 */
  74
  75     typedef Vec4d MaxTypeT;
  76
  77     // MSVC 7.0 is a little weird about template member methods, that's why
  78     // the code has to be here...
  79
  80     template <class ExternalType>
  81     ExternalType getValue(const SizeT index) const
  82     {
  83         ExternalType eval;
  84         MaxTypeT     ival;
  85         getGenericValue(ival, index);
  86         if(getNormalize() &&
  87            TypeTraits<typename  ExternalType::ValueType>::MathProp ==
  88                IntValue)
  89         {
  90             GeoConvertNormalize::convertOut(eval, ival,
  91                 TypeTraits<typename  ExternalType::ValueType>::getMax(), 0);
  92         }
  93         else
  94         {
  95             GeoConvert::convertOut(eval, ival);
  96         }
  97         return eval;
  98     }
  99
 100     template <class ExternalType>
 101     void getValue(ExternalType &eval, const SizeT index) const
 102     {
 103         MaxTypeT ival;
 104         getGenericValue(ival, index);
 105         if(getNormalize() &&
 106            TypeTraits<typename  ExternalType::ValueType>::MathProp ==
 107                IntValue)
 108         {
 109             GeoConvertNormalize::convertOut(eval, ival,
 110                 TypeTraits<typename  ExternalType::ValueType>::getMax(), 0);
 111         }
 112         else
 113         {
 114             GeoConvert::convertOut(eval, ival);
 115         }
 116     }
 117
 118     template <class ExternalType>
 119     void setValue(const ExternalType &val, const SizeT index)
 120     {
 121         MaxTypeT ival;
 122         if(getNormalize() &&
 123            TypeTraits<typename  ExternalType::ValueType>::MathProp ==
 124                IntValue)
 125         {
 126             GeoConvertNormalize::convertIn(ival, val,
 127                 TypeTraits<typename  ExternalType::ValueType>::getMax(), 0);
 128         }
 129         else
 130         {
 131             GeoConvert::convertIn(ival, val);
 132         }
 133         setGenericValue(ival, index);
 134     }
 135
 136     template <class ExternalType>
 137     void addValue(const ExternalType &val)
 138     {
 139          push_back(val);
 140     }
 141
 142     template <class ExternalType>
 143     void push_back(const ExternalType &val)
 144     {
 145         resize(size() + 1);
 146         setValue(val, size() - 1);
 147     }
 148
 149     virtual bool   getNormalize(void         ) const = 0;
 150     virtual void   clear       (void         )       = 0;
 151     virtual void   resize      (SizeT newsize)       = 0;
 152     virtual SizeT  size        (void         ) const = 0;
 153     virtual UInt32 size32      (void         ) const = 0;
 154
 155     /*! \}                                                                 */
 156     /*---------------------------------------------------------------------*/
 157     /*! \name                      Sync                                    */
 158     /*! \{                                                                 */
 159
 160     virtual void changed(ConstFieldMaskArg whichField,
 161                          UInt32            origin,
 162                          BitVector         detail);
 163
 164     /*! \}                                                                 */
 165     /*---------------------------------------------------------------------*/
 166     /*! \name                     Output                                   */
 167     /*! \{                                                                 */
 168
 169     virtual void dump(      UInt32     uiIndent = 0,
 170                       const BitVector  bvFlags  = 0) const;
 171
 172     /*! \}                                                                 */
 173     /*---------------------------------------------------------------------*/
 174     /*! \name                 Chunk Class Access                           */
 175     /*! \{                                                                 */
 176
 177     virtual const StateChunkClass * getClass         (void) const;
 178
 179     /*! \}                                                                 */
 180     /*---------------------------------------------------------------------*/
 181     /*! \name              Static Chunk Class Access                       */
 182     /*! \{                                                                 */
 183
 184     inline static        UInt32            getStaticClassId (void);
 185     inline static  const StateChunkClass * getStaticClass   (void);
 186
 187     /*! \}                                                                 */
 188     /*---------------------------------------------------------------------*/
 189     /*! \name                    State Commands                            */
 190     /*! \{                                                                 */
 191
 192     virtual void activate      (DrawEnv    *pEnv,
 193                                 UInt32      index = 0);
 194
 195     virtual void changeFrom    (DrawEnv    *pEnv,
 196                                 StateChunk *old,
 197                                 UInt32      index = 0);
 198
 199     virtual void deactivate    (DrawEnv    *pEnv,
 200                                 UInt32      index = 0);
 201
 202     /*! \}                                                                 */
 203     /*---------------------------------------------------------------------*/
 204     /*! \name                    State Commands                            */
 205     /*! \{                                                                 */
 206
 207     virtual void *mapBuffer  (GLenum eAccess, DrawEnv *pEnv);
 208     virtual bool  unmapBuffer(                DrawEnv *pEnv);
 209
 210     /*! \}                                                                 */
 211     /*=========================  PROTECTED  ===============================*/
 212
 213   protected:
 214
 215     // Variables should all be in GeoVectorPropertyBase.
 216
 217     /*---------------------------------------------------------------------*/
 218     /*! \name                  Constructors                                */
 219     /*! \{                                                                 */
 220
 221     GeoVectorProperty(void);
 222     GeoVectorProperty(const GeoVectorProperty &source);
 223
 224     /*! \}                                                                 */
 225     /*---------------------------------------------------------------------*/
 226     /*! \name                   Destructors                                */
 227     /*! \{                                                                 */
 228
 229     virtual ~GeoVectorProperty(void);
 230
 231     /*! \}                                                                 */
 232     /*---------------------------------------------------------------------*/
 233     /*! \name                   Generic Access                             */
 234     /*! \{                                                                 */
 235
 236     // This is the fallback, it has to be implemented by the concrete Props!
 237     virtual void getGenericValue(      MaxTypeT &val,
 238                                  const SizeT     index  ) const = 0;
 239     virtual void setGenericValue(const MaxTypeT &val,
 240                                  const SizeT     index  )       = 0;
 241
 242     /*! \}                                                                 */
 243
 244     virtual GLenum getBufferType(void); // buffer type for VBOs
 245
 246     static void initMethod(InitPhase ePhase);
 247
 248     /*==========================  PRIVATE  ================================*/
 249   private:
 250
 251     friend class FieldContainer;
 252     friend class GeoVectorPropertyBase;
 253
 254     // prohibit default functions (move to 'public' if you need one)
 255     void operator =(const GeoVectorProperty &source);
 256 };
 257
 258 typedef GeoVectorProperty *GeoVectorPropertyP;
 259
 260 //typedef GeoVectorProperty::ObjPtr         GeoVectorPropertyPtr;
 261 //typedef GeoVectorProperty::ConstObjPtr    ConstGeoVectorPropertyPtr;
 262
 263 OSG_END_NAMESPACE
 264
 265 #include "OSGGeoVectorPropertyBase.inl"
 266 #include "OSGGeoVectorProperty.inl"
 267
 268 #endif /* _OSGGEOVECTORPROPERTY_H_ */