Source/System/NodeCores/Drawables/Particles/OSGParticles.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 _OSGPARTICLES_H_
  40 #define _OSGPARTICLES_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGParticlesBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 class  DrawEnv;
  50 struct ParticlesDrawer;
  51
  52 /*! \ingroup GrpDrawablesParticlesObj
  53     \ingroup GrpLibOSGDrawables
  54     \includebasedoc
  55  */
  56 class OSG_DRAWABLE_DLLMAPPING Particles : public ParticlesBase
  57 {
  58   private:
  59
  60     /*==========================  PUBLIC  =================================*/
  61
  62   public:
  63
  64     typedef ParticlesBase Inherited;
  65
  66     /*---------------------------------------------------------------------*/
  67     /*! \name                     Modes                                    */
  68     /*! \{                                                                 */
  69
  70     enum ModeE
  71     {
  72         Points      = 0,
  73         Lines,
  74         ViewDirQuads,
  75         ViewerQuads,
  76         Arrows,
  77         ViewerArrows,
  78         Rectangles,
  79         ShaderQuads,
  80         ShaderStrips,
  81         LastMode
  82     };
  83
  84     enum DrawOrderE
  85     {
  86         Any         = 0,
  87         BackToFront,
  88         FrontToBack
  89     };
  90
  91     /*! \}                                                                 */
  92     /*---------------------------------------------------------------------*/
  93     /*! \name                      Sync                                    */
  94     /*! \{                                                                 */
  95
  96     virtual void changed(ConstFieldMaskArg whichField,
  97                          UInt32            origin,
  98                          BitVector         detail);
  99
 100     /*! \}                                                                 */
 101     /*---------------------------------------------------------------------*/
 102     /*! \name                     Output                                   */
 103     /*! \{                                                                 */
 104
 105     virtual void dump(      UInt32     uiIndent = 0,
 106                       const BitVector  bvFlags  = 0) const;
 107
 108     /*! \}                                                                 */
 109     /*---------------------------------------------------------------------*/
 110     /*! \name                       Draw                                   */
 111     /*! \{                                                                 */
 112
 113     virtual void drawPrimitives(DrawEnv *pEnv);
 114
 115     /*! \}                                                                 */
 116     /*---------------------------------------------------------------------*/
 117     /*! \name                    Field Set                                 */
 118     /*! \{                                                                 */
 119
 120     virtual void fill(DrawableStatsAttachment *pStat);
 121
 122     /*! \}                                                                 */
 123     /*=========================  PROTECTED  ===============================*/
 124
 125   protected:
 126
 127     // Variables should all be in ParticlesBase.
 128
 129     /*---------------------------------------------------------------------*/
 130     /*! \name                  Constructors                                */
 131     /*! \{                                                                 */
 132
 133     Particles(void);
 134     Particles(const Particles &source);
 135
 136     /*! \}                                                                 */
 137     /*---------------------------------------------------------------------*/
 138     /*! \name                   Destructors                                */
 139     /*! \{                                                                 */
 140
 141     virtual ~Particles(void);
 142
 143     /*! \}                                                                 */
 144     /*---------------------------------------------------------------------*/
 145     /*! \name                       Init                                   */
 146     /*! \{                                                                 */
 147
 148     static void initMethod(InitPhase ePhase);
 149
 150     /*! \}                                                                 */
 151     /*---------------------------------------------------------------------*/
 152     /*! \name                NodeCore Specific                             */
 153     /*! \{                                                                 */
 154
 155     virtual void adjustVolume(Volume & volume);
 156
 157     /*! \}                                                                 */
 158      /*---------------------------------------------------------------------*/
 159     /*! \name                Particles Specific                            */
 160     /*! \{                                                                 */
 161
 162     Int32 *calcIndex(DrawEnv *pEnv,
 163                      UInt32  &len,
 164                      Int32   *index = NULL);
 165
 166     ParticlesDrawer *findDrawer(void);
 167
 168     /*! \}                                                                 */
 169     /*==========================  PRIVATE  ================================*/
 170
 171   private:
 172
 173     friend class FieldContainer;
 174     friend class ParticlesBase;
 175
 176     // prohibit default functions (move to 'public' if you need one)
 177     void operator =(const Particles &source);
 178 };
 179
 180 typedef Particles *ParticlesP;
 181
 182 OSG_END_NAMESPACE
 183
 184 #include "OSGParticlesBase.inl"
 185 #include "OSGParticles.inl"
 186
 187 #endif /* _OSGPARTICLES_H_ */