OpenSG: OSGDVRVolumeBase.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 DVRVolume
00049  **                                                                         **
00050  *****************************************************************************
00051 \*****************************************************************************/
00052 
00053 
00054 #ifndef _OSGDVRVOLUMEBASE_H_
00055 #define _OSGDVRVOLUMEBASE_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 <OSGNodeCore.h> // Parent
00069 
00070 #include <OSGDVRAppearanceFields.h> // Appearance type
00071 #include <OSGDVRGeometryFields.h> // Geometry type
00072 #include <OSGDVRShader.h> // Shader type
00073 #include <OSGStringFields.h> // FileName type
00074 #include <OSGReal32Fields.h> // Sampling type
00075 #include <OSGReal32Fields.h> // SamplingInteractive type
00076 #include <OSGReal32Fields.h> // BaseAlpha type
00077 #include <OSGBoolFields.h> // DoTextures type
00078 #include <OSGUInt32Fields.h> // BrickOverlap type
00079 #include <OSGQBit.h> // Textures2D type
00080 #include <OSGUInt16Fields.h> // BrickStaticMemoryMB type
00081 #include <OSGMaterialFields.h> // RenderMaterial type
00082 #include <OSGUInt16Fields.h> // BrickingMode type
00083 #include <OSGVec3fFields.h> // BrickStaticSubdivision type
00084 #include <OSGVec3fFields.h> // BrickMaxSize type
00085 #include <OSGBoolFields.h> // ShowBricks type
00086 #include <OSGUInt32Fields.h> // DrawStyle type
00087 #include <OSGStringFields.h> // DrawStyleNames type
00088 #include <OSGChunkMaterialFields.h> // TextureStorage type
00089 
00090 #include <OSGDVRVolumeFields.h>
00091 
00092 OSG_BEGIN_NAMESPACE
00093 
00094 class DVRVolume;
00095 class BinaryDataHandler;
00096 
00098 
00099 class OSG_SYSTEMLIB_DLLMAPPING DVRVolumeBase : public NodeCore
00100 {
00101   private:
00102 
00103     typedef NodeCore    Inherited;
00104 
00105     /*==========================  PUBLIC  =================================*/
00106   public:
00107 
00108     typedef DVRVolumePtr  Ptr;
00109 
00110     enum
00111     {
00112         AppearanceFieldId             = Inherited::NextFieldId,
00113         GeometryFieldId               = AppearanceFieldId             + 1,
00114         ShaderFieldId                 = GeometryFieldId               + 1,
00115         FileNameFieldId               = ShaderFieldId                 + 1,
00116         SamplingFieldId               = FileNameFieldId               + 1,
00117         SamplingInteractiveFieldId    = SamplingFieldId               + 1,
00118         BaseAlphaFieldId              = SamplingInteractiveFieldId    + 1,
00119         DoTexturesFieldId             = BaseAlphaFieldId              + 1,
00120         BrickOverlapFieldId           = DoTexturesFieldId             + 1,
00121         Textures2DFieldId             = BrickOverlapFieldId           + 1,
00122         BrickStaticMemoryMBFieldId    = Textures2DFieldId             + 1,
00123         RenderMaterialFieldId         = BrickStaticMemoryMBFieldId    + 1,
00124         BrickingModeFieldId           = RenderMaterialFieldId         + 1,
00125         BrickStaticSubdivisionFieldId = BrickingModeFieldId           + 1,
00126         BrickMaxSizeFieldId           = BrickStaticSubdivisionFieldId + 1,
00127         ShowBricksFieldId             = BrickMaxSizeFieldId           + 1,
00128         DrawStyleFieldId              = ShowBricksFieldId             + 1,
00129         DrawStyleNamesFieldId         = DrawStyleFieldId              + 1,
00130         TextureStorageFieldId         = DrawStyleNamesFieldId         + 1,
00131         NextFieldId                   = TextureStorageFieldId         + 1
00132     };
00133 
00134     static const OSG::BitVector AppearanceFieldMask;
00135     static const OSG::BitVector GeometryFieldMask;
00136     static const OSG::BitVector ShaderFieldMask;
00137     static const OSG::BitVector FileNameFieldMask;
00138     static const OSG::BitVector SamplingFieldMask;
00139     static const OSG::BitVector SamplingInteractiveFieldMask;
00140     static const OSG::BitVector BaseAlphaFieldMask;
00141     static const OSG::BitVector DoTexturesFieldMask;
00142     static const OSG::BitVector BrickOverlapFieldMask;
00143     static const OSG::BitVector Textures2DFieldMask;
00144     static const OSG::BitVector BrickStaticMemoryMBFieldMask;
00145     static const OSG::BitVector RenderMaterialFieldMask;
00146     static const OSG::BitVector BrickingModeFieldMask;
00147     static const OSG::BitVector BrickStaticSubdivisionFieldMask;
00148     static const OSG::BitVector BrickMaxSizeFieldMask;
00149     static const OSG::BitVector ShowBricksFieldMask;
00150     static const OSG::BitVector DrawStyleFieldMask;
00151     static const OSG::BitVector DrawStyleNamesFieldMask;
00152     static const OSG::BitVector TextureStorageFieldMask;
00153 
00154 
00155     static const OSG::BitVector MTInfluenceMask;
00156 
00157     /*---------------------------------------------------------------------*/
00161     static        FieldContainerType &getClassType    (void); 
00162     static        UInt32              getClassTypeId  (void); 
00163 
00165     /*---------------------------------------------------------------------*/
00169     virtual       FieldContainerType &getType  (void); 
00170     virtual const FieldContainerType &getType  (void) const; 
00171 
00172     virtual       UInt32              getContainerSize(void) const;
00173 
00175     /*---------------------------------------------------------------------*/
00179            SFDVRAppearancePtr  *getSFAppearance     (void);
00180            SFDVRGeometryPtr    *getSFGeometry       (void);
00181            SFDVRShaderPtr      *getSFShader         (void);
00182            SFString            *getSFFileName       (void);
00183            SFReal32            *getSFSampling       (void);
00184            SFReal32            *getSFSamplingInteractive(void);
00185            SFReal32            *getSFBaseAlpha      (void);
00186            SFBool              *getSFDoTextures     (void);
00187            SFUInt32            *getSFBrickOverlap   (void);
00188            SFQBit              *getSFTextures2D     (void);
00189            SFUInt16            *getSFBrickStaticMemoryMB(void);
00190            SFChunkMaterialPtr  *getSFTextureStorage (void);
00191 
00192            DVRAppearancePtr    &getAppearance     (void);
00193      const DVRAppearancePtr    &getAppearance     (void) const;
00194            DVRGeometryPtr      &getGeometry       (void);
00195      const DVRGeometryPtr      &getGeometry       (void) const;
00196            DVRShaderPtr        &getShader         (void);
00197      const DVRShaderPtr        &getShader         (void) const;
00198            std::string         &getFileName       (void);
00199      const std::string         &getFileName       (void) const;
00200            Real32              &getSampling       (void);
00201      const Real32              &getSampling       (void) const;
00202            Real32              &getSamplingInteractive(void);
00203      const Real32              &getSamplingInteractive(void) const;
00204            Real32              &getBaseAlpha      (void);
00205      const Real32              &getBaseAlpha      (void) const;
00206            bool                &getDoTextures     (void);
00207      const bool                &getDoTextures     (void) const;
00208            UInt32              &getBrickOverlap   (void);
00209      const UInt32              &getBrickOverlap   (void) const;
00210            QBit                &getTextures2D     (void);
00211      const QBit                &getTextures2D     (void) const;
00212            UInt16              &getBrickStaticMemoryMB(void);
00213      const UInt16              &getBrickStaticMemoryMB(void) const;
00214            ChunkMaterialPtr    &getTextureStorage (void);
00215      const ChunkMaterialPtr    &getTextureStorage (void) const;
00216 
00218     /*---------------------------------------------------------------------*/
00222      void setAppearance     ( const DVRAppearancePtr &value );
00223      void setGeometry       ( const DVRGeometryPtr &value );
00224      void setShader         ( const DVRShaderPtr &value );
00225      void setFileName       ( const std::string &value );
00226      void setSampling       ( const Real32 &value );
00227      void setSamplingInteractive( const Real32 &value );
00228      void setBaseAlpha      ( const Real32 &value );
00229      void setDoTextures     ( const bool &value );
00230      void setBrickOverlap   ( const UInt32 &value );
00231      void setTextures2D     ( const QBit &value );
00232      void setBrickStaticMemoryMB( const UInt16 &value );
00233      void setTextureStorage ( const ChunkMaterialPtr &value );
00234 
00236     /*---------------------------------------------------------------------*/
00241     /*---------------------------------------------------------------------*/
00245     virtual UInt32 getBinSize (const BitVector         &whichField);
00246     virtual void   copyToBin  (      BinaryDataHandler &pMem,
00247                                const BitVector         &whichField);
00248     virtual void   copyFromBin(      BinaryDataHandler &pMem,
00249                                const BitVector         &whichField);
00250 
00251 
00253     /*---------------------------------------------------------------------*/
00257     static  DVRVolumePtr      create          (void); 
00258     static  DVRVolumePtr      createEmpty     (void); 
00259 
00262     /*---------------------------------------------------------------------*/
00266     virtual FieldContainerPtr     shallowCopy     (void) const; 
00267 
00269     /*=========================  PROTECTED  ===============================*/
00270   protected:
00271 
00272     /*---------------------------------------------------------------------*/
00276     SFDVRAppearancePtr   _sfAppearance;
00277     SFDVRGeometryPtr    _sfGeometry;
00278     SFDVRShaderPtr      _sfShader;
00279     SFString            _sfFileName;
00280     SFReal32            _sfSampling;
00281     SFReal32            _sfSamplingInteractive;
00282     SFReal32            _sfBaseAlpha;
00283     SFBool              _sfDoTextures;
00284     SFUInt32            _sfBrickOverlap;
00285     SFQBit              _sfTextures2D;
00286     SFUInt16            _sfBrickStaticMemoryMB;
00287     SFMaterialPtr       _sfRenderMaterial;
00288     SFUInt16            _sfBrickingMode;
00289     SFVec3f             _sfBrickStaticSubdivision;
00290     SFVec3f             _sfBrickMaxSize;
00291     SFBool              _sfShowBricks;
00292     SFUInt32            _sfDrawStyle;
00293     MFString            _mfDrawStyleNames;
00294     SFChunkMaterialPtr   _sfTextureStorage;
00295 
00297     /*---------------------------------------------------------------------*/
00301     DVRVolumeBase(void);
00302     DVRVolumeBase(const DVRVolumeBase &source);
00303 
00305     /*---------------------------------------------------------------------*/
00309     virtual ~DVRVolumeBase(void); 
00310 
00312     /*---------------------------------------------------------------------*/
00316            SFMaterialPtr       *getSFRenderMaterial (void);
00317            SFUInt16            *getSFBrickingMode   (void);
00318            SFVec3f             *getSFBrickStaticSubdivision(void);
00319            SFVec3f             *getSFBrickMaxSize   (void);
00320            SFBool              *getSFShowBricks     (void);
00321            SFUInt32            *getSFDrawStyle      (void);
00322            MFString            *getMFDrawStyleNames (void);
00323 
00324            MaterialPtr         &getRenderMaterial (void);
00325      const MaterialPtr         &getRenderMaterial (void) const;
00326            UInt16              &getBrickingMode   (void);
00327      const UInt16              &getBrickingMode   (void) const;
00328            Vec3f               &getBrickStaticSubdivision(void);
00329      const Vec3f               &getBrickStaticSubdivision(void) const;
00330            Vec3f               &getBrickMaxSize   (void);
00331      const Vec3f               &getBrickMaxSize   (void) const;
00332            bool                &getShowBricks     (void);
00333      const bool                &getShowBricks     (void) const;
00334            UInt32              &getDrawStyle      (void);
00335      const UInt32              &getDrawStyle      (void) const;
00336            std::string         &getDrawStyleNames (UInt32 index);
00337            MFString            &getDrawStyleNames (void);
00338      const MFString            &getDrawStyleNames (void) const;
00339 
00341     /*---------------------------------------------------------------------*/
00345      void setRenderMaterial (const MaterialPtr &value);
00346      void setBrickingMode   (const UInt16 &value);
00347      void setBrickStaticSubdivision(const Vec3f &value);
00348      void setBrickMaxSize   (const Vec3f &value);
00349      void setShowBricks     (const bool &value);
00350      void setDrawStyle      (const UInt32 &value);
00351 
00353     /*---------------------------------------------------------------------*/
00357 #if !defined(OSG_FIXED_MFIELDSYNC)
00358     void executeSyncImpl(      DVRVolumeBase *pOther,
00359                          const BitVector         &whichField);
00360 
00361     virtual void   executeSync(      FieldContainer    &other,
00362                                const BitVector         &whichField);
00363 #else
00364     void executeSyncImpl(      DVRVolumeBase *pOther,
00365                          const BitVector         &whichField,
00366                          const SyncInfo          &sInfo     );
00367 
00368     virtual void   executeSync(      FieldContainer    &other,
00369                                const BitVector         &whichField,
00370                                const SyncInfo          &sInfo);
00371 
00372     virtual void execBeginEdit     (const BitVector &whichField,
00373                                           UInt32     uiAspect,
00374                                           UInt32     uiContainerSize);
00375 
00376             void execBeginEditImpl (const BitVector &whichField,
00377                                           UInt32     uiAspect,
00378                                           UInt32     uiContainerSize);
00379 
00380     virtual void onDestroyAspect(UInt32 uiId, UInt32 uiAspect);
00381 #endif
00382 
00384     /*==========================  PRIVATE  ================================*/
00385   private:
00386 
00387     friend class FieldContainer;
00388 
00389     static FieldDescription   *_desc[];
00390     static FieldContainerType  _type;
00391 
00392 
00393     // prohibit default functions (move to 'public' if you need one)
00394     void operator =(const DVRVolumeBase &source);
00395 };
00396 
00397 //---------------------------------------------------------------------------
00398 //   Exported Types
00399 //---------------------------------------------------------------------------
00400 
00401 
00402 typedef DVRVolumeBase *DVRVolumeBaseP;
00403 
00404 typedef osgIF<DVRVolumeBase::isNodeCore,
00405               CoredNodePtr<DVRVolume>,
00406               FieldContainer::attempt_to_create_CoredNodePtr_on_non_NodeCore_FC
00407               >::_IRet DVRVolumeNodePtr;
00408 
00409 typedef RefPtr<DVRVolumePtr> DVRVolumeRefPtr;
00410 
00411 OSG_END_NAMESPACE
00412 
00413 #define OSGDVRVOLUMEBASE_HEADER_CVSID "@(#)$Id: FCBaseTemplate_h.h,v 1.40 2005/07/20 00:10:14 vossg Exp $"
00414 
00415 #endif /* _OSGDVRVOLUMEBASE_H_ */