Source/System/Window/Background/OSGSkyBackground.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 _OSGSKYBACKGROUND_H_
  40 #define _OSGSKYBACKGROUND_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGSkyBackgroundBase.h"
  46 #include "OSGTextureBaseChunk.h"
  47
  48 OSG_BEGIN_NAMESPACE
  49
  50 class Viewport;
  51
  52 /*! \brief Background clearing class using a sky sphere and box. See \ref
  53            PageSystemWindowBackgroundSky for a description.
  54     \ingroup GrpWindowBackgroundObj
  55     \ingroup GrpLibOSGWindow
  56     \includebasedoc
  57  */
  58
  59 class OSG_WINDOW_DLLMAPPING SkyBackground : public SkyBackgroundBase
  60 {
  61     /*==========================  PUBLIC  =================================*/
  62
  63   public:
  64
  65     typedef SkyBackgroundBase                           Inherited;
  66
  67     /*---------------------------------------------------------------------*/
  68     /*! \name                      Sync                                    */
  69     /*! \{                                                                 */
  70
  71     virtual void changed(ConstFieldMaskArg whichField,
  72                          UInt32            origin,
  73                          BitVector         detail);
  74
  75     /*! \}                                                                 */
  76     /*---------------------------------------------------------------------*/
  77     /*! \name                     Background                               */
  78     /*! \{                                                                 */
  79
  80     virtual void clear(DrawEnv *pEnv);
  81
  82     /*! \}                                                                 */
  83     /*---------------------------------------------------------------------*/
  84     /*! \name                     Output                                   */
  85     /*! \{                                                                 */
  86
  87     virtual void dump(      UInt32     uiIndent = 0,
  88                       const BitVector  bvFlags  = 0) const;
  89
  90     /*! \}                                                                 */
  91     /*=========================  PROTECTED  ===============================*/
  92
  93   protected:
  94
  95     // Variables should all be in SkyBackgroundBase.
  96
  97     std::vector<Real32> _cosval;
  98     std::vector<Real32> _sinval;
  99
 100     /*---------------------------------------------------------------------*/
 101     /*! \name                  Constructors                                */
 102     /*! \{                                                                 */
 103
 104     SkyBackground(void);
 105     SkyBackground(const SkyBackground &source);
 106
 107     /*! \}                                                                 */
 108     /*---------------------------------------------------------------------*/
 109     /*! \name                   Destructors                                */
 110     /*! \{                                                                 */
 111
 112     virtual ~SkyBackground(void);
 113
 114     /*! \}                                                                 */
 115     /*---------------------------------------------------------------------*/
 116     /*! \name                       Init                                   */
 117     /*! \{                                                                 */
 118
 119     static void initMethod(InitPhase ePhase);
 120
 121     /*! \}                                                                 */
 122     /*---------------------------------------------------------------------*/
 123     /*! \name                   Draw Helper                                */
 124     /*! \{                                                                 */
 125
 126     void drawFace(      DrawEnv             * action,
 127                         TextureBaseChunk    * tex,
 128                         StateChunk          *&oldtex,
 129                   const Pnt3f                &p1,
 130                   const Pnt3f                &p2,
 131                   const Pnt3f                &p3,
 132                   const Pnt3f                &p4,
 133                   const Vec3f               * texCoord);
 134
 135     /*! \}                                                                 */
 136     /*==========================  PRIVATE  ================================*/
 137
 138   private:
 139
 140     friend class FieldContainer;
 141     friend class SkyBackgroundBase;
 142
 143     // prohibit default functions (move to 'public' if you need one)
 144     void operator =(const SkyBackground &source);
 145
 146     const Vec3f *selectTexCoords(const Vec3f            *userTexCoords,
 147                                        TextureBaseChunk *texImage,
 148                                        UInt32            side          );
 149
 150     static const Vec3f _defaultTexCoords    [7][4];
 151     static const Vec3f _defaultVRMLTexCoords[7][4];
 152 };
 153
 154 typedef SkyBackground              *SkyBackgroundP;
 155
 156 OSG_END_NAMESPACE
 157
 158 #include "OSGSkyBackgroundBase.inl"
 159 #include "OSGSkyBackground.inl"
 160
 161 #endif /* _OSGSKYBACKGROUND_H_ */