Source/System/NodeCores/Groups/Misc/OSGStackedTransform.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 _OSGSTACKEDTRANSFORM_H_
  40 #define _OSGSTACKEDTRANSFORM_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGStackedTransformBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 /*! \brief StackedTransform class. See \ref
  50            PageGroupStackedTransform for a description.
  51 */
  52
  53 class OSG_GROUP_DLLMAPPING StackedTransform : public StackedTransformBase
  54 {
  55   protected:
  56
  57     /*==========================  PUBLIC  =================================*/
  58
  59   public:
  60
  61     typedef StackedTransformBase Inherited;
  62     typedef StackedTransform     Self;
  63
  64     static std::string TranslateName;
  65     static std::string RotateXName;
  66     static std::string RotateYName;
  67     static std::string RotateZName;
  68     static std::string ScaleName;
  69
  70     /*---------------------------------------------------------------------*/
  71     /*! \name                      Sync                                    */
  72     /*! \{                                                                 */
  73
  74     virtual void changed(ConstFieldMaskArg whichField,
  75                          UInt32            origin,
  76                          BitVector         details    );
  77
  78     /*! \}                                                                 */
  79     /*---------------------------------------------------------------------*/
  80     /*! \name                     Output                                   */
  81     /*! \{                                                                 */
  82
  83     virtual void dump(      UInt32     uiIndent = 0,
  84                       const BitVector  bvFlags  = 0) const;
  85
  86     /*! \}                                                                 */
  87     /*---------------------------------------------------------------------*/
  88     /*! \name                   Transformation                             */
  89     /*! \{                                                                 */
  90
  91     virtual void accumulateMatrix(Matrix &result);
  92
  93     /*! \}                                                                 */
  94     /*---------------------------------------------------------------------*/
  95     /*! \name                   Transformation                             */
  96     /*! \{                                                                 */
  97
  98     TransformationElement *getElement(const std::string &szName) const;
  99
 100     template <typename ElementType>
 101     ElementType           *getElement(const std::string &szName) const;
 102
 103     /*! \}                                                                 */
 104     /*---------------------------------------------------------------------*/
 105     /*! \name                   Transformation                             */
 106     /*! \{                                                                 */
 107
 108     void pushToNamedTransformElements      (
 109         TransformationElement       * const pValue,
 110         std::string           const &       szName);
 111
 112     void insertIntoNamedTransformElements  (
 113         UInt32               uiIndex,
 114         TransformationElement       * const pValue,
 115         std::string           const &       szName);
 116
 117     void replaceInNamedTransformElements   (
 118         UInt32                              uiIndex,
 119         TransformationElement       * const pValue,
 120         std::string           const &       szName);
 121
 122     void replaceObjInNamedTransformElements(
 123         TransformationElement       * const pOldElem,
 124         TransformationElement       * const pNewElem,
 125         std::string           const &       szName);
 126
 127     void removeFromNamedTransformElements  (
 128         std::string           const &       szName);
 129
 130     /*! \}                                                                 */
 131     /*=========================  PROTECTED  ===============================*/
 132
 133   protected:
 134
 135     // Variables should all be in StackedTransformBase.
 136
 137     Matrix _mTransformation;
 138
 139     /*---------------------------------------------------------------------*/
 140     /*! \name                  Constructors                                */
 141     /*! \{                                                                 */
 142
 143     StackedTransform(void);
 144     StackedTransform(const StackedTransform &source);
 145
 146     /*! \}                                                                 */
 147     /*---------------------------------------------------------------------*/
 148     /*! \name                   Destructors                                */
 149     /*! \{                                                                 */
 150
 151     virtual ~StackedTransform(void);
 152
 153     /*! \}                                                                 */
 154     /*---------------------------------------------------------------------*/
 155     /*! \name                      Init                                    */
 156     /*! \{                                                                 */
 157
 158     static void initMethod(InitPhase ePhase);
 159
 160     /*! \}                                                                 */
 161     /*---------------------------------------------------------------------*/
 162     /*! \name                      Volume                                  */
 163     /*! \{                                                                 */
 164
 165     virtual void adjustVolume    (Volume &volume);
 166
 167     /*! \}                                                                 */
 168     /*---------------------------------------------------------------------*/
 169     /*! \name              Intersect & Render                              */
 170     /*! \{                                                                 */
 171
 172     Action::ResultE intersectEnter     (Action *action);
 173     Action::ResultE intersectLeave     (Action *action);
 174
 175     Action::ResultE renderEnter        (Action *action);
 176     Action::ResultE renderLeave        (Action *action);
 177
 178     void            updateTransform    (void          );
 179     void            invalidateTransform(void          );
 180
 181     /*! \}                                                                 */
 182     /*==========================  PRIVATE  ================================*/
 183
 184   private:
 185
 186     friend class FieldContainer;
 187     friend class StackedTransformBase;
 188     friend class TransformationElement;
 189
 190     // prohibit default functions (move to 'public' if you need one)
 191     void operator =(const StackedTransform &source);
 192 };
 193
 194 typedef StackedTransform *StackedTransformP;
 195
 196 OSG_END_NAMESPACE
 197
 198 #include "OSGStackedTransformBase.inl"
 199 #include "OSGStackedTransform.inl"
 200
 201 #endif /* _OSGSTACKEDTRANSFORM_H_ */