OpenSG: OSGStencilChunkBase.h Source File

00001 /*---------------------------------------------------------------------------*\
00002  *                                OpenSG                                     *
00003  *                                                                           *
00004  *                                                                           *
00005  *               Copyright (C) 2000-2002 by the OpenSG Forum                 *
00006  *                                                                           *
00007  *                            www.opensg.org                                 *
00008  *                                                                           *
00009  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
00010  *                                                                           *
00011 \*---------------------------------------------------------------------------*/
00012 /*---------------------------------------------------------------------------*\
00013  *                                License                                    *
00014  *                                                                           *
00015  * This library is free software; you can redistribute it and/or modify it   *
00016  * under the terms of the GNU Library General Public License as published    *
00017  * by the Free Software Foundation, version 2.                               *
00018  *                                                                           *
00019  * This library is distributed in the hope that it will be useful, but       *
00020  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
00021  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
00022  * Library General Public License for more details.                          *
00023  *                                                                           *
00024  * You should have received a copy of the GNU Library General Public         *
00025  * License along with this library; if not, write to the Free Software       *
00026  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
00027  *                                                                           *
00028 \*---------------------------------------------------------------------------*/
00029 /*---------------------------------------------------------------------------*\
00030  *                                Changes                                    *
00031  *                                                                           *
00032  *                                                                           *
00033  *                                                                           *
00034  *                                                                           *
00035  *                                                                           *
00036  *                                                                           *
00037 \*---------------------------------------------------------------------------*/
00038 
00039 /*****************************************************************************\
00040  *****************************************************************************
00041  **                                                                         **
00042  **                  This file is automatically generated.                  **
00043  **                                                                         **
00044  **          Any changes made to this file WILL be lost when it is          **
00045  **           regenerated, which can become necessary at any time.          **
00046  **                                                                         **
00047  **     Do not change this file, changes should be done in the derived      **
00048  **     class StencilChunk
00049  **                                                                         **
00050  *****************************************************************************
00051 \*****************************************************************************/
00052 
00053 
00054 #ifndef _OSGSTENCILCHUNKBASE_H_
00055 #define _OSGSTENCILCHUNKBASE_H_
00056 #ifdef __sgi
00057 #pragma once
00058 #endif
00059 
00060 
00061 #include <OSGConfig.h>
00062 #include <OSGSystemDef.h>
00063 
00064 #include <OSGBaseTypes.h>
00065 #include <OSGRefPtr.h>
00066 #include <OSGCoredNodePtr.h>
00067 
00068 #include <OSGStateChunk.h> // Parent
00069 
00070 #include <OSGGLenumFields.h> // StencilFunc type
00071 #include <OSGInt32Fields.h> // StencilValue type
00072 #include <OSGUInt32Fields.h> // StencilMask type
00073 #include <OSGGLenumFields.h> // StencilOpFail type
00074 #include <OSGGLenumFields.h> // StencilOpZFail type
00075 #include <OSGGLenumFields.h> // StencilOpZPass type
00076 #include <OSGInt32Fields.h> // ClearBuffer type
00077 #include <OSGUInt32Fields.h> // BitMask type
00078 
00079 #include <OSGStencilChunkFields.h>
00080 
00081 OSG_BEGIN_NAMESPACE
00082 
00083 class StencilChunk;
00084 class BinaryDataHandler;
00085 
00087 
00088 class OSG_SYSTEMLIB_DLLMAPPING StencilChunkBase : public StateChunk
00089 {
00090   private:
00091 
00092     typedef StateChunk    Inherited;
00093 
00094     /*==========================  PUBLIC  =================================*/
00095   public:
00096 
00097     typedef StencilChunkPtr  Ptr;
00098 
00099     enum
00100     {
00101         StencilFuncFieldId    = Inherited::NextFieldId,
00102         StencilValueFieldId   = StencilFuncFieldId    + 1,
00103         StencilMaskFieldId    = StencilValueFieldId   + 1,
00104         StencilOpFailFieldId  = StencilMaskFieldId    + 1,
00105         StencilOpZFailFieldId = StencilOpFailFieldId  + 1,
00106         StencilOpZPassFieldId = StencilOpZFailFieldId + 1,
00107         ClearBufferFieldId    = StencilOpZPassFieldId + 1,
00108         BitMaskFieldId        = ClearBufferFieldId    + 1,
00109         NextFieldId           = BitMaskFieldId        + 1
00110     };
00111 
00112     static const OSG::BitVector StencilFuncFieldMask;
00113     static const OSG::BitVector StencilValueFieldMask;
00114     static const OSG::BitVector StencilMaskFieldMask;
00115     static const OSG::BitVector StencilOpFailFieldMask;
00116     static const OSG::BitVector StencilOpZFailFieldMask;
00117     static const OSG::BitVector StencilOpZPassFieldMask;
00118     static const OSG::BitVector ClearBufferFieldMask;
00119     static const OSG::BitVector BitMaskFieldMask;
00120 
00121 
00122     static const OSG::BitVector MTInfluenceMask;
00123 
00124     /*---------------------------------------------------------------------*/
00128     static        FieldContainerType &getClassType    (void); 
00129     static        UInt32              getClassTypeId  (void); 
00130 
00132     /*---------------------------------------------------------------------*/
00136     virtual       FieldContainerType &getType  (void); 
00137     virtual const FieldContainerType &getType  (void) const; 
00138 
00139     virtual       UInt32              getContainerSize(void) const;
00140 
00142     /*---------------------------------------------------------------------*/
00146            SFGLenum            *getSFStencilFunc    (void);
00147            SFInt32             *getSFStencilValue   (void);
00148            SFUInt32            *getSFStencilMask    (void);
00149            SFGLenum            *getSFStencilOpFail  (void);
00150            SFGLenum            *getSFStencilOpZFail (void);
00151            SFGLenum            *getSFStencilOpZPass (void);
00152            SFInt32             *getSFClearBuffer    (void);
00153            SFUInt32            *getSFBitMask        (void);
00154 
00155            GLenum              &getStencilFunc    (void);
00156      const GLenum              &getStencilFunc    (void) const;
00157            Int32               &getStencilValue   (void);
00158      const Int32               &getStencilValue   (void) const;
00159            UInt32              &getStencilMask    (void);
00160      const UInt32              &getStencilMask    (void) const;
00161            GLenum              &getStencilOpFail  (void);
00162      const GLenum              &getStencilOpFail  (void) const;
00163            GLenum              &getStencilOpZFail (void);
00164      const GLenum              &getStencilOpZFail (void) const;
00165            GLenum              &getStencilOpZPass (void);
00166      const GLenum              &getStencilOpZPass (void) const;
00167            Int32               &getClearBuffer    (void);
00168      const Int32               &getClearBuffer    (void) const;
00169            UInt32              &getBitMask        (void);
00170      const UInt32              &getBitMask        (void) const;
00171 
00173     /*---------------------------------------------------------------------*/
00177      void setStencilFunc    ( const GLenum &value );
00178      void setStencilValue   ( const Int32 &value );
00179      void setStencilMask    ( const UInt32 &value );
00180      void setStencilOpFail  ( const GLenum &value );
00181      void setStencilOpZFail ( const GLenum &value );
00182      void setStencilOpZPass ( const GLenum &value );
00183      void setClearBuffer    ( const Int32 &value );
00184      void setBitMask        ( const UInt32 &value );
00185 
00187     /*---------------------------------------------------------------------*/
00192     /*---------------------------------------------------------------------*/
00196     virtual UInt32 getBinSize (const BitVector         &whichField);
00197     virtual void   copyToBin  (      BinaryDataHandler &pMem,
00198                                const BitVector         &whichField);
00199     virtual void   copyFromBin(      BinaryDataHandler &pMem,
00200                                const BitVector         &whichField);
00201 
00202 
00204     /*---------------------------------------------------------------------*/
00208     static  StencilChunkPtr      create          (void); 
00209     static  StencilChunkPtr      createEmpty     (void); 
00210 
00213     /*---------------------------------------------------------------------*/
00217     virtual FieldContainerPtr     shallowCopy     (void) const; 
00218 
00220     /*=========================  PROTECTED  ===============================*/
00221   protected:
00222 
00223     /*---------------------------------------------------------------------*/
00227     SFGLenum            _sfStencilFunc;
00228     SFInt32             _sfStencilValue;
00229     SFUInt32            _sfStencilMask;
00230     SFGLenum            _sfStencilOpFail;
00231     SFGLenum            _sfStencilOpZFail;
00232     SFGLenum            _sfStencilOpZPass;
00233     SFInt32             _sfClearBuffer;
00234     SFUInt32            _sfBitMask;
00235 
00237     /*---------------------------------------------------------------------*/
00241     StencilChunkBase(void);
00242     StencilChunkBase(const StencilChunkBase &source);
00243 
00245     /*---------------------------------------------------------------------*/
00249     virtual ~StencilChunkBase(void); 
00250 
00252     /*---------------------------------------------------------------------*/
00256 #if !defined(OSG_FIXED_MFIELDSYNC)
00257     void executeSyncImpl(      StencilChunkBase *pOther,
00258                          const BitVector         &whichField);
00259 
00260     virtual void   executeSync(      FieldContainer    &other,
00261                                const BitVector         &whichField);
00262 #else
00263     void executeSyncImpl(      StencilChunkBase *pOther,
00264                          const BitVector         &whichField,
00265                          const SyncInfo          &sInfo     );
00266 
00267     virtual void   executeSync(      FieldContainer    &other,
00268                                const BitVector         &whichField,
00269                                const SyncInfo          &sInfo);
00270 
00271     virtual void execBeginEdit     (const BitVector &whichField,
00272                                           UInt32     uiAspect,
00273                                           UInt32     uiContainerSize);
00274 
00275             void execBeginEditImpl (const BitVector &whichField,
00276                                           UInt32     uiAspect,
00277                                           UInt32     uiContainerSize);
00278 
00279     virtual void onDestroyAspect(UInt32 uiId, UInt32 uiAspect);
00280 #endif
00281 
00283     /*==========================  PRIVATE  ================================*/
00284   private:
00285 
00286     friend class FieldContainer;
00287 
00288     static FieldDescription   *_desc[];
00289     static FieldContainerType  _type;
00290 
00291 
00292     // prohibit default functions (move to 'public' if you need one)
00293     void operator =(const StencilChunkBase &source);
00294 };
00295 
00296 //---------------------------------------------------------------------------
00297 //   Exported Types
00298 //---------------------------------------------------------------------------
00299 
00300 
00301 typedef StencilChunkBase *StencilChunkBaseP;
00302 
00303 typedef osgIF<StencilChunkBase::isNodeCore,
00304               CoredNodePtr<StencilChunk>,
00305               FieldContainer::attempt_to_create_CoredNodePtr_on_non_NodeCore_FC
00306               >::_IRet StencilChunkNodePtr;
00307 
00308 typedef RefPtr<StencilChunkPtr> StencilChunkRefPtr;
00309 
00310 OSG_END_NAMESPACE
00311 
00312 #define OSGSTENCILCHUNKBASE_HEADER_CVSID "@(#)$Id: OSGStencilChunkBase.h,v 1.7 2006/09/08 13:45:30 yjung Exp $"
00313 
00314 #endif /* _OSGSTENCILCHUNKBASE_H_ */