Source/System/NodeCores/Groups/Misc/OSGScreenTransform.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-2006 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 _OSGSCREENTRANSFORM_H_
  40 #define _OSGSCREENTRANSFORM_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGScreenTransformBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 /*! \brief ScreenTransform class. See \ref
  50            PageGroupScreenTransform for a description.
  51 */
  52
  53 class OSG_GROUP_DLLMAPPING ScreenTransform : public ScreenTransformBase
  54 {
  55   protected:
  56
  57     /*==========================  PUBLIC  =================================*/
  58
  59   public:
  60
  61     typedef ScreenTransformBase Inherited;
  62     typedef ScreenTransform     Self;
  63
  64     /*---------------------------------------------------------------------*/
  65     /*! \name                      Sync                                    */
  66     /*! \{                                                                 */
  67
  68     virtual void changed(ConstFieldMaskArg whichField,
  69                          UInt32            origin,
  70                          BitVector         details    );
  71
  72     /*! \}                                                                 */
  73     /*---------------------------------------------------------------------*/
  74     /*! \name                     Output                                   */
  75     /*! \{                                                                 */
  76
  77     virtual void dump(      UInt32     uiIndent = 0,
  78                       const BitVector  bvFlags  = 0) const;
  79
  80     /*! \}                                                                 */
  81     /*---------------------------------------------------------------------*/
  82     /*! \name                   Transformation                             */
  83     /*! \{                                                                 */
  84
  85     virtual void accumulateMatrix(      Matrix  &result );
  86             void calcMatrix      (const Matrix  &toWorld,
  87                                         DrawEnv &oEnv   );
  88
  89     /*! \}                                                                 */
  90     /*=========================  PROTECTED  ===============================*/
  91
  92   protected:
  93
  94     // Variables should all be in ScreenTransformBase.
  95
  96     Matrix _mTransform;
  97
  98     /*---------------------------------------------------------------------*/
  99     /*! \name                  Constructors                                */
 100     /*! \{                                                                 */
 101
 102     ScreenTransform(void);
 103     ScreenTransform(const ScreenTransform &source);
 104
 105     /*! \}                                                                 */
 106     /*---------------------------------------------------------------------*/
 107     /*! \name                   Destructors                                */
 108     /*! \{                                                                 */
 109
 110     virtual ~ScreenTransform(void);
 111
 112     /*! \}                                                                 */
 113     /*---------------------------------------------------------------------*/
 114     /*! \name                      Init                                    */
 115     /*! \{                                                                 */
 116
 117     static void initMethod(InitPhase ePhase);
 118
 119     /*! \}                                                                 */
 120     /*---------------------------------------------------------------------*/
 121     /*! \name                      Volume                                  */
 122     /*! \{                                                                 */
 123
 124     virtual void adjustVolume    (Volume &volume);
 125
 126     /*! \}                                                                 */
 127     /*---------------------------------------------------------------------*/
 128     /*! \name              Intersect & Render                              */
 129     /*! \{                                                                 */
 130
 131     Action::ResultE intersectEnter(Action *action);
 132     Action::ResultE intersectLeave(Action *action);
 133
 134     Action::ResultE renderEnter   (Action *action);
 135     Action::ResultE renderLeave   (Action *action);
 136
 137     /*! \}                                                                 */
 138     /*==========================  PRIVATE  ================================*/
 139
 140   private:
 141
 142     friend class FieldContainer;
 143     friend class ScreenTransformBase;
 144
 145     // prohibit default functions (move to 'public' if you need one)
 146     void operator =(const ScreenTransform &source);
 147 };
 148
 149 typedef ScreenTransform *ScreenTransformP;
 150
 151 OSG_END_NAMESPACE
 152
 153 #include "OSGScreenTransformBase.inl"
 154 #include "OSGScreenTransform.inl"
 155
 156 #endif /* _OSGSCREENTRANSFORM_H_ */