Source/System/Window/Utilities/OSGSimpleSceneManager.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 _OSGSIMPLESCENEMANAGER_H_
  40 #define _OSGSIMPLESCENEMANAGER_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGConfig.h"
  46 #include "OSGUtilDef.h"
  47
  48 #include "OSGBaseTypes.h"
  49
  50 #include "OSGRenderAction.h"
  51
  52 #include "OSGNode.h"
  53 #include "OSGImageForeground.h"
  54 #include "OSGTransform.h"
  55 #include "OSGGeometry.h"
  56 #include "OSGTypedGeoVectorProperty.h"
  57 #include "OSGSimpleMaterial.h"
  58 #include "OSGCamera.h"
  59 #include "OSGDirectionalLight.h"
  60 #include "OSGNavigator.h"
  61 #include "OSGStatisticsForeground.h"
  62 #include "OSGNavigationManager.h"
  63
  64 OSG_BEGIN_NAMESPACE
  65
  66 /*! \brief A helper class to simplify managing simple applications.
  67     \ingroup GrpUtilNavigation
  68     \ingroup GrpLibOSGUtil
  69  */
  70
  71 class OSG_UTIL_DLLMAPPING SimpleSceneManager : public NavigationManager
  72 {
  73     /*==========================  PUBLIC  =================================*/
  74
  75   public:
  76
  77     OSG_GEN_INTERNAL_MEMOBJPTR(SimpleSceneManager);
  78
  79     /*---------------------------------------------------------------------*/
  80     /*! \name                   Constructors                               */
  81     /*! \{                                                                 */
  82
  83     static ObjTransitPtr create(void);
  84
  85     /*! \}                                                                 */
  86     /*---------------------------------------------------------------------*/
  87     /*! \name                      Get                                     */
  88     /*! \{                                                                 */
  89
  90     virtual Node             *getRoot          (void);
  91     virtual Node             *getHighlight     (void);
  92     virtual RenderAction     *getRenderAction  (void);
  93     virtual bool              getHeadlightState(void);
  94     virtual DirectionalLight *getHeadlight     (void);
  95     virtual Camera           *getCamera        (void);
  96     virtual Background       *getBackground    (void);
  97     virtual Node             *getInternalRoot  (void);
  98
  99     /*! \}                                                                 */
 100     /*---------------------------------------------------------------------*/
 101     /*! \name                      Set                                     */
 102     /*! \{                                                                 */
 103
 104     virtual void  setAction        (RenderAction *action    );
 105
 106     virtual void  setRoot          (Node         *root      );
 107
 108     virtual void  setHighlight     (Node         *obj       );
 109     virtual void  setHeadlight     (bool          on        );
 110     virtual void  turnHeadlightOn  (void                    );
 111     virtual void  turnHeadlightOff (void                    );
 112     virtual void  setCamera        (Camera       *camera    );
 113     virtual void  setBackground    (Background   *bg        );
 114
 115     virtual void setUseTraversalAction(bool s               );
 116     virtual bool getUseTraversalAction(void                 );
 117
 118     virtual void  showAll          (void                    );
 119
 120     virtual void  useOpenSGLogo    (void                    );
 121
 122     virtual void  setStatistics    (bool on                 );
 123     bool          getStatistics    (void                    );
 124
 125     virtual void  addForeground    (Foreground * const fg  );
 126     virtual void  removeForeground (Foreground * const fg  );
 127
 128     /*! \}                                                                 */
 129     /*---------------------------------------------------------------------*/
 130     /*! \name               Interaction handling                           */
 131     /*! \{                                                                 */
 132
 133             Line calcViewRay(Int16 x, Int16 y);
 134
 135     /*! \}                                                                 */
 136     /*---------------------------------------------------------------------*/
 137     /*! \name                     Actions                                  */
 138     /*! \{                                                                 */
 139
 140     virtual void update( void );
 141     virtual void redraw( void );
 142
 143     /*! \}                                                                 */
 144     /*---------------------------------------------------------------------*/
 145     /*! \name                    Comparison                                */
 146     /*! \{                                                                 */
 147
 148     bool operator < (const SimpleSceneManager &other) const;
 149
 150     //bool operator == (const SimpleSceneManager &other) const;
 151     //bool operator != (const SimpleSceneManager &other) const;
 152
 153     /*! \}                                                                 */
 154     /*=========================  PROTECTED  ===============================*/
 155
 156   protected:
 157
 158     typedef NavigationManager Inherited;
 159
 160     /*---------------------------------------------------------------------*/
 161     /*! \name                   Constructors                               */
 162     /*! \{                                                                 */
 163
 164     SimpleSceneManager(void);
 165
 166     /*! \}                                                                 */
 167     /*---------------------------------------------------------------------*/
 168     /*! \name                   Destructor                                 */
 169     /*! \{                                                                 */
 170
 171     virtual ~SimpleSceneManager(void);
 172
 173     /*! \}                                                                 */
 174     /*---------------------------------------------------------------------*/
 175     /*! \name                     Updates                                  */
 176     /*! \{                                                                 */
 177
 178             void  initialize      (void);
 179     virtual void  highlightChanged(void);
 180     virtual void  updateHighlight (void);
 181
 182     /*! \}                                                                 */
 183     /*---------------------------------------------------------------------*/
 184     /*! \name                      Member                                  */
 185     /*! \{                                                                 */
 186
 187     NodeRecPtr                 _root;
 188
 189     ImageForegroundRecPtr      _foreground;
 190     StatisticsForegroundRecPtr _statforeground;
 191     bool                       _statstate;
 192
 193     NodeRecPtr                 _highlight;
 194     NodeRecPtr                 _highlightNode;
 195     //GeoPositions3fPtr            _highlightPoints;
 196     GeoPnt3fPropertyRecPtr     _highlightPoints;
 197
 198     NodeRecPtr                 _internalRoot;
 199     DirectionalLightRecPtr     _headlight;
 200
 201     /** The RenderAction to use if using render traversals. */
 202     RenderActionRefPtr         _rtaction;
 203
 204     TransformRecPtr            _cart;
 205     CameraRecPtr               _camera;
 206
 207     bool                       _traversalAction;
 208
 209     SimpleMaterialRecPtr       _highlightMaterial;
 210
 211     /*! \}                                                                 */
 212     /*==========================  PRIVATE  ================================*/
 213   private:
 214
 215     /* prohibit default function (move to 'public' if needed) */
 216
 217     SimpleSceneManager(const SimpleSceneManager &source);
 218     void operator =(const SimpleSceneManager &source);
 219 };
 220
 221 //---------------------------------------------------------------------------
 222 //   Exported Types
 223 //---------------------------------------------------------------------------
 224
 225 // class pointer
 226
 227 typedef SimpleSceneManager *SimpleSceneManagerP;
 228
 229 OSG_GEN_MEMOBJPTR(SimpleSceneManager);
 230
 231 OSG_END_NAMESPACE
 232
 233 #include "OSGSimpleSceneManager.inl"
 234
 235 #endif /* _OSGSIMPLESCENEMANAGER_H_ */