Source/System/State/OpenGL/OSGTransformChunk.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
  40 #ifndef _OSGTRANSFORMCHUNK_H_
  41 #define _OSGTRANSFORMCHUNK_H_
  42 #ifdef __sgi
  43 #pragma once
  44 #endif
  45
  46 #include "OSGTransformChunkBase.h"
  47
  48 OSG_BEGIN_NAMESPACE
  49
  50 /*! \brief State chunk for transformation. See \ref PageSystemTransformChunk
  51            for a description.
  52     \ingroup GrpStateOpenGLObj
  53     \ingroup GrpLibOSGState
  54     \includebasedoc
  55  */
  56
  57 class OSG_STATE_DLLMAPPING TransformChunk : public TransformChunkBase
  58 {
  59     /*==========================  PUBLIC  =================================*/
  60
  61   public:
  62
  63     /*---------------------------------------------------------------------*/
  64     /*! \name                 Chunk Class Access                           */
  65     /*! \{                                                                 */
  66
  67     virtual const StateChunkClass *getClass(void) const;
  68
  69     /*! \}                                                                 */
  70     /*---------------------------------------------------------------------*/
  71     /*! \name              Static Chunk Class Access                       */
  72     /*! \{                                                                 */
  73
  74     static       UInt32           getStaticClassId(void);
  75     static const StateChunkClass *getStaticClass  (void);
  76
  77     /*! \}                                                                 */
  78     /*---------------------------------------------------------------------*/
  79     /*! \name                      Sync                                    */
  80     /*! \{                                                                 */
  81
  82     virtual void changed(ConstFieldMaskArg whichField,
  83                          UInt32            origin,
  84                          BitVector         details);
  85
  86     /*! \}                                                                 */
  87     /*---------------------------------------------------------------------*/
  88     /*! \name                      Output                                  */
  89     /*! \{                                                                 */
  90
  91     virtual void dump(      UInt32    uiIndent = 0,
  92                       const BitVector bvFlags  = 0) const;
  93
  94     /*! \}                                                                 */
  95     /*---------------------------------------------------------------------*/
  96     /*! \name                      State                                   */
  97     /*! \{                                                                 */
  98
  99     virtual void activate  (DrawEnv    *pEnv,
 100                             UInt32      index = 0);
 101
 102     virtual void changeFrom(DrawEnv    *pEnv,
 103                             StateChunk *old,
 104                             UInt32      index = 0);
 105
 106     virtual void deactivate(DrawEnv    *pEnv,
 107                             UInt32      index = 0);
 108
 109     /*! \}                                                                 */
 110     /*---------------------------------------------------------------------*/
 111     /*! \name                    Comparison                                */
 112     /*! \{                                                                 */
 113
 114     virtual Real32 switchCost(StateChunk *chunk);
 115
 116     virtual bool   operator < (const StateChunk &other) const;
 117
 118     virtual bool   operator ==(const StateChunk &other) const;
 119     virtual bool   operator !=(const StateChunk &other) const;
 120
 121     /*! \}                                                                 */
 122     /*=========================  PROTECTED  ===============================*/
 123
 124   protected:
 125
 126     /*---------------------------------------------------------------------*/
 127     /*! \name                   Constructors                               */
 128     /*! \{                                                                 */
 129
 130     TransformChunk(void);
 131     TransformChunk(const TransformChunk &source);
 132
 133     /*! \}                                                                 */
 134     /*---------------------------------------------------------------------*/
 135     /*! \name                   Destructors                                */
 136     /*! \{                                                                 */
 137
 138     virtual ~TransformChunk(void);
 139
 140     /*! \}                                                                 */
 141     /*---------------------------------------------------------------------*/
 142     /*! \name                       Init                                   */
 143     /*! \{                                                                 */
 144
 145     static void initMethod(InitPhase ePhase);
 146
 147     /*! \}                                                                 */
 148     /*==========================  PRIVATE  ================================*/
 149
 150   private:
 151
 152     typedef TransformChunkBase Inherited;
 153
 154     friend class FieldContainer;
 155     friend class TransformChunkBase;
 156
 157     /*---------------------------------------------------------------------*/
 158
 159     // class. Used for indexing in State
 160     static StateChunkClass _class;
 161
 162     /*---------------------------------------------------------------------*/
 163
 164     // prohibit default functions (move to 'public' if you need one)
 165     void operator =(const TransformChunk &source);
 166 };
 167
 168 typedef TransformChunk *TransformChunkP;
 169
 170 OSG_END_NAMESPACE
 171
 172 #include "OSGTransformChunkBase.inl"
 173 #include "OSGTransformChunk.inl"
 174
 175 #endif /* _OSGTRANSFORMCHUNK_H_ */