Source/System/NodeCores/Groups/Misc/OSGScreenGroup.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 _OSGSCREENGROUP_H_
  40 #define _OSGSCREENGROUP_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGConfig.h"
  46 #include "OSGScreenGroupBase.h"
  47
  48 OSG_BEGIN_NAMESPACE
  49
  50 class RenderAction;
  51
  52 /*! \brief ScreenGroup class. See \ref
  53            PageSystemScreenGroup for a description.
  54     \ingroup GrpGroupMiscObj
  55     \ingroup GrpLibOSGGroup
  56     \includebasedoc
  57  */
  58
  59 class OSG_GROUP_DLLMAPPING ScreenGroup : public ScreenGroupBase
  60 {
  61   private:
  62
  63     typedef ScreenGroupBase Inherited;
  64
  65     /*==========================  PUBLIC  =================================*/
  66
  67   public:
  68
  69     /*---------------------------------------------------------------------*/
  70     /*! \name                      Sync                                    */
  71     /*! \{                                                                 */
  72
  73     virtual void changed(ConstFieldMaskArg  whichField,
  74                          UInt32             origin,
  75                          BitVector          detail    );
  76
  77     /*! \}                                                                 */
  78     /*---------------------------------------------------------------------*/
  79     /*! \name                     Output                                   */
  80     /*! \{                                                                 */
  81
  82     virtual void dump(      UInt32     uiIndent = 0,
  83                       const BitVector  bvFlags  = 0) const;
  84
  85     /*! \}                                                                 */
  86     /*=========================  PROTECTED  ===============================*/
  87
  88   protected:
  89
  90     // Variables should all be in ScreenGroupBase.
  91
  92     /*---------------------------------------------------------------------*/
  93     /*! \name                  Constructors                                */
  94     /*! \{                                                                 */
  95
  96     ScreenGroup(void);
  97     ScreenGroup(const ScreenGroup &source);
  98
  99     /*! \}                                                                 */
 100     /*---------------------------------------------------------------------*/
 101     /*! \name                   Destructors                                */
 102     /*! \{                                                                 */
 103
 104     virtual ~ScreenGroup(void);
 105
 106     /*! \}                                                                 */
 107     /*---------------------------------------------------------------------*/
 108     /*! \name                   Init                                       */
 109     /*! \{                                                                 */
 110
 111     static void initMethod(InitPhase ePhase);
 112
 113     /*! \}                                                                 */
 114     /*---------------------------------------------------------------------*/
 115     /*! \name               calc the model matrix                          */
 116     /*! \{                                                                 */
 117
 118     void calcMatrix(      RenderAction *pAction,
 119                     const Matrix       &mToWorld,
 120                           Matrix       &mResult );
 121
 122     /*! \}                                                                 */
 123     /*---------------------------------------------------------------------*/
 124     /*! \name                  Transformation                              */
 125     /*! \{                                                                 */
 126
 127     virtual void accumulateMatrix(Matrix &result);
 128
 129     /*! \}                                                                 */
 130     /*---------------------------------------------------------------------*/
 131     /*! \name                      NodeCore Specific                       */
 132     /*! \{                                                                 */
 133
 134     void adjustVolume(Volume &volume);
 135
 136     /*! \}                                                                 */
 137     /*---------------------------------------------------------------------*/
 138     /*! \name              Draw & Intersect & Render                       */
 139     /*! \{                                                                 */
 140
 141     Action::ResultE intersectEnter(Action *action);
 142     Action::ResultE intersectLeave(Action *action);
 143
 144     Action::ResultE renderEnter   (Action *action);
 145     Action::ResultE renderLeave   (Action *action);
 146
 147     /*! \}                                                                 */
 148     /*==========================  PRIVATE  ================================*/
 149
 150   private:
 151
 152     Matrix _camTransform;
 153
 154     friend class FieldContainer;
 155     friend class ScreenGroupBase;
 156
 157     // prohibit default functions (move to 'public' if you need one)
 158     void operator =(const ScreenGroup &source);
 159 };
 160
 161 typedef ScreenGroup *ScreenGroupP;
 162
 163 OSG_END_NAMESPACE
 164
 165 #include "OSGScreenGroupBase.inl"
 166 #include "OSGScreenGroup.inl"
 167
 168 #endif /* _OSGSCREENGROUP_H_ */