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

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-2002 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 _OSGGEOPROPERTY_H_
  40 #define _OSGGEOPROPERTY_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGGeoPropertyBase.h"
  46 #include "OSGWindow.h"
  47
  48 OSG_BEGIN_NAMESPACE
  49
  50 class Window;
  51
  52 /*! \brief GeoProperty class. See \ref
  53            PageSystemGeoProperty for a description.
  54     \ingroup GrpDrawablesGeometryProperties
  55     \ingroup GrpLibOSGDrawables
  56     \includebasedoc
  57  */
  58
  59 class OSG_SYSTEM_DLLMAPPING GeoProperty : public GeoPropertyBase
  60 {
  61   private:
  62
  63     /*==========================  PUBLIC  =================================*/
  64
  65   public:
  66
  67     typedef GeoPropertyBase                             Inherited;
  68
  69     static const UInt32 UsageUnspecified      = 0x00000000;
  70
  71     static const UInt32 UsageSpaceMask        = 0x0000000F;
  72
  73     static const UInt32 UsageObjectSpace      = 0x00000001;  // pos
  74     static const UInt32 UsageTangentSpace     = 0x00000002;  // norm, binorm, tang
  75     static const UInt32 UsageParameterSpace   = 0x00000004;  // tex coord
  76     static const UInt32 UsageColorSpace       = 0x00000008;  // color
  77
  78     static const UInt32 UsageSystemSet        = 0x10000000;  // mark as set by OpenSG
  79
  80
  81     static const UInt32 VectorTypeScalar      = 0x00000000;
  82     static const UInt32 VectorTypePoint       = 0x00000001;
  83     static const UInt32 VectorTypeVector      = 0x00000002;
  84     static const UInt32 VectorTypeColor       = 0x00000003;
  85
  86     /*---------------------------------------------------------------------*/
  87     /*! \name                 Property Interface                           */
  88     /*! \{                                                                 */
  89
  90     virtual       UInt32                 getFormat    (void) const = 0;
  91     virtual       UInt32                 getFormatSize(void) const = 0;
  92     virtual       UInt32                 getVectorType(void) const = 0;
  93     virtual       UInt32                 getStride    (void) const = 0;
  94     virtual       UInt32                 getDimension (void) const = 0;
  95     virtual       SizeT                  size         (void) const = 0;
  96     virtual       UInt32                 size32       (void) const = 0;
  97     virtual const UInt8                 *getData      (void) const
  98     { return NULL;  }
  99     virtual       UInt8                 *editData     (void)
 100     { return NULL;  }
 101     virtual       GeoPropertyTransitPtr  clone        (void)       = 0;
 102
 103     /*! \}                                                                 */
 104     /*---------------------------------------------------------------------*/
 105     /*! \name                      Sync                                    */
 106     /*! \{                                                                 */
 107
 108     virtual void changed(ConstFieldMaskArg whichField,
 109                          UInt32            origin,
 110                          BitVector         detail);
 111
 112     /*! \}                                                                 */
 113     /*---------------------------------------------------------------------*/
 114     /*! \name                     Output                                   */
 115     /*! \{                                                                 */
 116
 117     virtual void dump(      UInt32     uiIndent = 0,
 118                       const BitVector  bvFlags  = 0) const;
 119
 120     /*! \}                                                                 */
 121     /*---------------------------------------------------------------------*/
 122     /*! \name                 Chunk Class Access                           */
 123     /*! \{                                                                 */
 124
 125     virtual const StateChunkClass * getClass         (void) const;
 126
 127     /*! \}                                                                 */
 128     /*---------------------------------------------------------------------*/
 129     /*! \name              Static Chunk Class Access                       */
 130     /*! \{                                                                 */
 131
 132     inline static        UInt32            getStaticClassId (void);
 133     inline static  const StateChunkClass * getStaticClass   (void);
 134
 135     /*! \}                                                                 */
 136     /*---------------------------------------------------------------------*/
 137     /*! \name                    State Commands                            */
 138     /*! \{                                                                 */
 139
 140     virtual void activate      (DrawEnv *pEnv, UInt32 index = 0) = 0;
 141
 142     virtual void changeFrom    (DrawEnv    *pEnv,
 143                                 StateChunk *old,
 144                                 UInt32      index = 0)  = 0;
 145
 146     virtual void deactivate    (DrawEnv *pEnv, UInt32 index = 0) = 0;
 147
 148     virtual bool isTransparent (void) const;
 149
 150     /*! \}                                                                 */
 151     /*---------------------------------------------------------------------*/
 152     /*! \name                   Limited Access                             */
 153     /*! \{                                                                 */
 154
 155     UInt32 getGLId(void) const;
 156
 157     /*! \}                                                                 */
 158     /*---------------------------------------------------------------------*/
 159     /*! \name                   Comparison                                 */
 160     /*! \{                                                                 */
 161
 162     virtual Real32 switchCost  ( StateChunk * chunk );
 163
 164     virtual bool   operator <  (const StateChunk &other) const;
 165
 166     virtual bool   operator == (const StateChunk &other) const;
 167     virtual bool   operator != (const StateChunk &other) const;
 168
 169     /*! \}                                                                 */
 170     /*---------------------------------------------------------------------*/
 171     /*! \name                       Helper                                 */
 172     /*! \{                                                                 */
 173
 174     inline static UInt32 MapFormatToSize(GLenum format);
 175
 176     /*! \}                                                                 */
 177     /*=========================  PROTECTED  ===============================*/
 178
 179   protected:
 180
 181     // Variables should all be in GeoPropertyBase.
 182
 183     /*---------------------------------------------------------------------*/
 184     /*! \name                         GL                                   */
 185     /*! \{                                                                 */
 186
 187            UInt32 handleGL       (DrawEnv                 *pEnv,
 188                                   UInt32                   id,
 189                                   Window::GLObjectStatusE  mode,
 190                                   UInt64                   uiOptions);
 191     static void   handleDestroyGL(DrawEnv                 *pEnv,
 192                                   UInt32                   id,
 193                                   Window::GLObjectStatusE  mode     );
 194
 195     /*! \}                                                                 */
 196     /*---------------------------------------------------------------------*/
 197     /*! \name                  Constructors                                */
 198     /*! \{                                                                 */
 199
 200     GeoProperty(void);
 201     GeoProperty(const GeoProperty &source);
 202
 203     /*! \}                                                                 */
 204     /*---------------------------------------------------------------------*/
 205     /*! \name                   Destructors                                */
 206     /*! \{                                                                 */
 207
 208     virtual ~GeoProperty(void);
 209
 210     /*! \}                                                                 */
 211
 212     virtual GLenum getBufferType(void) = 0; // buffer type for VBOs
 213
 214     static StateChunkClass _class;
 215
 216     /*---------------------------------------------------------------------*/
 217     /*! \name               OpenGL Extensions Used                         */
 218     /*! \{                                                                 */
 219
 220     static UInt32 _extVertexBufferObject;
 221     static UInt32 _extMultitexture;
 222     static UInt32 _arbVertexProgram;
 223     static UInt32 _extSecondaryColor;
 224     static UInt32 _arbInstancedArrays;
 225
 226     static UInt32 _funcBindBuffer;
 227     static UInt32 _funcMapBuffer;
 228     static UInt32 _funcUnmapBuffer;
 229     static UInt32 _funcBufferData;
 230     static UInt32 _funcBufferSubData;
 231     static UInt32 _funcDeleteBuffers;
 232     static UInt32 _funcGenBuffers;
 233     static UInt32 _funcVertexAttribPointerARB;
 234     static UInt32 _funcEnableVertexAttribArrayARB;
 235     static UInt32 _funcDisableVertexAttribArrayARB;
 236
 237     static UInt32 _funcClientActiveTextureARB;
 238     static UInt32 _funcSecondaryColorPointer;
 239
 240     static UInt32 _funcVertexAttribDivisorARB;
 241
 242     /*! \}                                                                 */
 243     /*---------------------------------------------------------------------*/
 244     /*! \name                       Init                                   */
 245     /*! \{                                                                 */
 246
 247     static void initMethod(InitPhase ePhase);
 248
 249     /*! \}                                                                 */
 250     /*==========================  PRIVATE  ================================*/
 251
 252   private:
 253
 254     friend class FieldContainer;
 255     friend class GeoPropertyBase;
 256
 257
 258     // prohibit default functions (move to 'public' if you need one)
 259     void operator =(const GeoProperty &source);
 260 };
 261
 262 typedef GeoProperty *GeoPropertyP;
 263
 264 OSG_END_NAMESPACE
 265
 266 #include "OSGGeoPropertyBase.inl"
 267 #include "OSGGeoProperty.inl"
 268
 269 #endif /* _OSGGEOPROPERTY_H_ */