Source/System/NodeCores/Drawables/Geometry/Base/OSGGeoPumpGroup.cpp

   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  *                                                                           *
  16  *                                                                           *
  17  * This library is free software; you can redistribute it and/or modify it   *
  18  * under the terms of the GNU Library General Public License as published    *
  19  * by the Free Software Foundation, version 2.                               *
  20  *                                                                           *
  21  * This library is distributed in the hope that it will be useful, but       *
  22  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  24  * Library General Public License for more details.                          *
  25  *                                                                           *
  26  * You should have received a copy of the GNU Library General Public         *
  27  * License along with this library; if not, write to the Free Software       *
  28  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  29  *                                                                           *
  30  *                                                                           *
  31 \*---------------------------------------------------------------------------*/
  32 /*---------------------------------------------------------------------------*\
  33  *                                Changes                                    *
  34  *                                                                           *
  35  *                                                                           *
  36  *                                                                           *
  37  *                                                                           *
  38  *                                                                           *
  39  *                                                                           *
  40 \*---------------------------------------------------------------------------*/
  41
  42 //---------------------------------------------------------------------------
  43 //  Includes
  44 //---------------------------------------------------------------------------
  45
  46 #include <cstdlib>
  47 #include <cstdio>
  48
  49 #include "OSGConfig.h"
  50
  51 #include "OSGGL.h"
  52 #include "OSGGLEXT.h"
  53
  54 #include "OSGLog.h"
  55
  56 #include "OSGGeometry.h"
  57 #include "OSGDrawEnv.h"
  58
  59 #include "OSGMaterial.h"
  60
  61 #include "OSGGeoPumpGroup.h"
  62 #include "OSGGeoImmediatePumpGroup.h"
  63 #include "OSGGeoVertexArrayPumpGroup.h"
  64 #include "OSGGeoSplitVertexArrayPumpGroup.h"
  65
  66 OSG_USING_NAMESPACE
  67
  68
  69 /***************************************************************************\
  70  *                            Description                                  *
  71 \***************************************************************************/
  72
  73 /* \class OSG::GeoPumpGroup
  74    \ingroup GrpSystemNodeCoresDrawablesGeometry
  75
  76 The PumpGroup is responsible for selecting the most appropriate pump
  77 function to send the geometry's data to OpenGL in the most efficient manner.
  78
  79 The pump is selected inside the rendering function and should not be accessed
  80 from the outside.
  81
  82 \dev The pump factory chooses the pump based on the used properties. For
  83 non- and single-indexed geometry OpenGL VertexArrays are used, for
  84 multi-indexed geometry an immediate mode pump has to be used. Specialized Pumps
  85 for all combinations of properties are created to optimizie this case as much
  86 as possible.
  87 */
  88
  89
  90 std::vector<GeoPumpGroup*> *GeoPumpGroup::_activeGroups;
  91
  92 /*! Initialize the _activeGroups at startup.
  93 */
  94 InitFuncWrapper GeoPumpGroup::actInit(GeoPumpGroup::initActiveGroups);
  95
  96 bool GeoPumpGroup::initActiveGroups(void)
  97 {
  98     _activeGroups = new std::vector<GeoPumpGroup*>;
  99
 100     _activeGroups->push_back(new GeoVertexArrayPumpGroup);
 101     _activeGroups->push_back(new GeoSplitVertexArrayPumpGroup);
 102 #if !defined(OSG_OGL_COREONLY) || defined(OSG_CHECK_COREONLY)
 103     _activeGroups->push_back(new GeoImmediatePumpGroup);
 104 #endif
 105
 106     addPostFactoryExitFunction(&GeoPumpGroup::terminateActiveGroups);
 107
 108     return true;
 109 }
 110
 111 bool GeoPumpGroup::terminateActiveGroups(void)
 112 {
 113     for(UInt32 i = 0; i < _activeGroups->size(); ++i)
 114     {
 115         delete (*_activeGroups)[i];
 116     }
 117
 118     delete _activeGroups;
 119
 120     return true;
 121 }
 122
 123 /*! PropertyCharacteristics handling.
 124 */
 125
 126 std::string GeoPumpGroup::describePropertyCharacteristics(
 127                                         PropertyCharacteristics ac)
 128 {
 129     std::string result;
 130
 131     if(ac & GeoPumpGroup::NonIndexed)    result += "NonIndexed,";
 132     if(ac & GeoPumpGroup::SingleIndexed) result += "SingleIndexed,";
 133     if(ac & GeoPumpGroup::MultiIndexed)  result += "MultiIndexed,";
 134     if(ac & GeoPumpGroup::NonTraditionalProperties)
 135         result += "NonTraditionalProperties,";
 136
 137     if(result.empty() == true)
 138         result += "unknown,";
 139
 140     result.resize(result.length()-1);
 141
 142     return result;
 143 }
 144
 145 GeoPumpGroup::PropertyCharacteristics
 146 GeoPumpGroup::characterizeGeometry(Geometry* geo)
 147 {
 148     return characterizeGeometry(geo->getMFProperties(),
 149                                 geo->getMFPropIndices());
 150 }
 151
 152 GeoPumpGroup::PropertyCharacteristics
 153 GeoPumpGroup::characterizeGeometry(const Geometry::MFPropertiesType  *prop,
 154                                    const Geometry::MFPropIndicesType *propIdx)
 155 {
 156     PropertyCharacteristics retVal = 0;
 157
 158     Int16 natt = prop   ->size32();
 159     Int16 nind = propIdx->size32();
 160
 161     // Check for single- and multi-indexed
 162     GeoIntegralProperty *ind = NULL;
 163
 164     bool single     = true;
 165     bool multi      = true;
 166     bool nonind     = true;
 167     bool allPropVAO = true;
 168     bool allIdxVAO  = true;
 169
 170     for(Int16 i = 0; i < natt; ++i)
 171     {
 172         // Only count actual attributes
 173         if((*prop)[i] != NULL && (*prop)[i]->getDivisor() == 0)
 174         {
 175             if((*prop)[i]->getUseVBO() == false)
 176             {
 177                 allPropVAO = false;
 178             }
 179
 180             if(i < nind)
 181             {
 182                 if((*propIdx)[i] == NULL)
 183                 {
 184                     if((*prop)[i]->size() != 1)
 185                     {
 186                         single = false;
 187                         multi  = false;
 188                     }
 189                 }
 190                 else
 191                 {
 192                     if((*propIdx)[i]->getUseVBO() == false)
 193                     {
 194                         allIdxVAO = false;
 195                     }
 196
 197                     nonind = false;
 198
 199                     if(ind == NULL)
 200                         ind = (*propIdx)[i];
 201
 202                     if((*propIdx)[i] != ind && (*prop)[i]->size() != 1)
 203                         single = false;
 204                 }
 205             }
 206             else
 207             {
 208                 single = false;
 209                 multi  = false;
 210             }
 211         }
 212     }
 213
 214     if(nonind)
 215         retVal |= GeoPumpGroup::NonIndexed;
 216     else if(single)
 217         retVal |= GeoPumpGroup::SingleIndexed;
 218     else if(multi)
 219         retVal |= GeoPumpGroup::MultiIndexed;
 220
 221     if(allPropVAO == true)
 222     {
 223         retVal |= AllPropsVAO;
 224     }
 225
 226     if(allIdxVAO == true)
 227     {
 228         retVal |= AllPropIdxVAO;
 229     }
 230
 231 #if 0
 232     // check double single + multi char
 233     fprintf(stderr,
 234             "single %d | no %d | multi %d | prop vao %d | idx vao %d\n",
 235             UInt32(single),
 236             UInt32(nonind),
 237             UInt32(multi),
 238             UInt32(allPropVAO),
 239             UInt32(allIdxVAO));
 240 #endif
 241
 242     // Check for non-traditional properties.
 243     // Right now just check existence of attribs 6&7
 244     // To be complete this would also have to check
 245     // type compatibility! *DR*
 246
 247     if(natt > 6 && (*prop)[6] != NULL)
 248         retVal |= GeoPumpGroup::NonTraditionalProperties;
 249     if(natt > 7 && (*prop)[7] != NULL)
 250         retVal |= GeoPumpGroup::NonTraditionalProperties;
 251
 252     return retVal;
 253 }
 254
 255 /*! Find the actual pumps for the given Window/Geometry.
 256 */
 257
 258 GeoPumpGroup::GeoPump GeoPumpGroup::findGeoPump(DrawEnv                 *pEnv,
 259                                                 PropertyCharacteristics  acset)
 260 {
 261     GeoPump  pump = NULL;
 262     Window  *win  = pEnv->getWindow();
 263
 264     for(std::vector<GeoPumpGroup*>::iterator it = _activeGroups->begin();
 265         it != _activeGroups->end() && pump == NULL;
 266         ++it)
 267     {
 268         pump = (*it)->getGeoPump(pEnv,acset);
 269     }
 270
 271     if(pump == NULL)
 272     {
 273         FWARNING(("GeoPumpGroup::findGeoPump: Couldn't find pump for"
 274                   "Window %p and characteristics %s!\n",
 275                   static_cast<void *>(win),
 276                   describePropertyCharacteristics(acset).c_str() ));
 277     }
 278
 279     return pump;
 280 }
 281
 282 GeoPumpGroup::SplitGeoPump GeoPumpGroup::findSplitGeoPump(
 283     DrawEnv                 *pEnv,
 284     PropertyCharacteristics  acset)
 285 {
 286     SplitGeoPump  pump = { NULL, NULL, NULL };
 287     Window       *win  = pEnv->getWindow();
 288
 289     std::vector<GeoPumpGroup*>::const_iterator pIt  = _activeGroups->begin();
 290     std::vector<GeoPumpGroup*>::const_iterator pEnd = _activeGroups->end  ();
 291
 292     for(; pIt != pEnd && pump.setupPump == NULL; ++pIt)
 293     {
 294         pump = (*pIt)->getSplitGeoPump(pEnv, acset);
 295     }
 296
 297     if(pump.setupPump == NULL)
 298     {
 299         FWARNING(("GeoPumpGroup::findSplitGeoPump: Couldn't find pump for"
 300                   "Window %p and characteristics %s!\n",
 301                   static_cast<void *>(win),
 302                   describePropertyCharacteristics(acset).c_str() ));
 303     }
 304
 305     return pump;
 306 }
 307
 308 GeoPumpGroup::SplitGeoPump GeoPumpGroup::getSplitGeoPump(
 309     DrawEnv                 *,
 310     PropertyCharacteristics  )
 311 {
 312     SplitGeoPump  pump = { NULL, NULL, NULL };
 313
 314     return pump;
 315 }
 316
 317 GeoPumpGroup::~GeoPumpGroup()
 318 {
 319 }