OpenSG: OSGLightChunkBase.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 LightChunk
00049  **                                                                         **
00050  *****************************************************************************
00051 \*****************************************************************************/
00052 
00053 
00054 #ifndef _OSGLIGHTCHUNKBASE_H_
00055 #define _OSGLIGHTCHUNKBASE_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 <OSGColor4fFields.h> // Diffuse type
00071 #include <OSGColor4fFields.h> // Ambient type
00072 #include <OSGColor4fFields.h> // Specular type
00073 #include <OSGVec4fFields.h> // Position type
00074 #include <OSGVec3fFields.h> // Direction type
00075 #include <OSGReal32Fields.h> // Exponent type
00076 #include <OSGReal32Fields.h> // Cutoff type
00077 #include <OSGReal32Fields.h> // ConstantAttenuation type
00078 #include <OSGReal32Fields.h> // LinearAttenuation type
00079 #include <OSGReal32Fields.h> // QuadraticAttenuation type
00080 
00081 #include <OSGLightChunkFields.h>
00082 
00083 OSG_BEGIN_NAMESPACE
00084 
00085 class LightChunk;
00086 class BinaryDataHandler;
00087 
00089 
00090 class OSG_SYSTEMLIB_DLLMAPPING LightChunkBase : public StateChunk
00091 {
00092   private:
00093 
00094     typedef StateChunk    Inherited;
00095 
00096     /*==========================  PUBLIC  =================================*/
00097   public:
00098 
00099     typedef LightChunkPtr  Ptr;
00100 
00101     enum
00102     {
00103         DiffuseFieldId              = Inherited::NextFieldId,
00104         AmbientFieldId              = DiffuseFieldId              + 1,
00105         SpecularFieldId             = AmbientFieldId              + 1,
00106         PositionFieldId             = SpecularFieldId             + 1,
00107         DirectionFieldId            = PositionFieldId             + 1,
00108         ExponentFieldId             = DirectionFieldId            + 1,
00109         CutoffFieldId               = ExponentFieldId             + 1,
00110         ConstantAttenuationFieldId  = CutoffFieldId               + 1,
00111         LinearAttenuationFieldId    = ConstantAttenuationFieldId  + 1,
00112         QuadraticAttenuationFieldId = LinearAttenuationFieldId    + 1,
00113         NextFieldId                 = QuadraticAttenuationFieldId + 1
00114     };
00115 
00116     static const OSG::BitVector DiffuseFieldMask;
00117     static const OSG::BitVector AmbientFieldMask;
00118     static const OSG::BitVector SpecularFieldMask;
00119     static const OSG::BitVector PositionFieldMask;
00120     static const OSG::BitVector DirectionFieldMask;
00121     static const OSG::BitVector ExponentFieldMask;
00122     static const OSG::BitVector CutoffFieldMask;
00123     static const OSG::BitVector ConstantAttenuationFieldMask;
00124     static const OSG::BitVector LinearAttenuationFieldMask;
00125     static const OSG::BitVector QuadraticAttenuationFieldMask;
00126 
00127 
00128     static const OSG::BitVector MTInfluenceMask;
00129 
00130     /*---------------------------------------------------------------------*/
00134     static        FieldContainerType &getClassType    (void); 
00135     static        UInt32              getClassTypeId  (void); 
00136 
00138     /*---------------------------------------------------------------------*/
00142     virtual       FieldContainerType &getType  (void); 
00143     virtual const FieldContainerType &getType  (void) const; 
00144 
00145     virtual       UInt32              getContainerSize(void) const;
00146 
00148     /*---------------------------------------------------------------------*/
00152            SFColor4f           *getSFDiffuse        (void);
00153            SFColor4f           *getSFAmbient        (void);
00154            SFColor4f           *getSFSpecular       (void);
00155            SFVec4f             *getSFPosition       (void);
00156            SFVec3f             *getSFDirection      (void);
00157            SFReal32            *getSFExponent       (void);
00158            SFReal32            *getSFCutoff         (void);
00159            SFReal32            *getSFConstantAttenuation(void);
00160            SFReal32            *getSFLinearAttenuation(void);
00161            SFReal32            *getSFQuadraticAttenuation(void);
00162 
00163            Color4f             &getDiffuse        (void);
00164      const Color4f             &getDiffuse        (void) const;
00165            Color4f             &getAmbient        (void);
00166      const Color4f             &getAmbient        (void) const;
00167            Color4f             &getSpecular       (void);
00168      const Color4f             &getSpecular       (void) const;
00169            Vec4f               &getPosition       (void);
00170      const Vec4f               &getPosition       (void) const;
00171            Vec3f               &getDirection      (void);
00172      const Vec3f               &getDirection      (void) const;
00173            Real32              &getExponent       (void);
00174      const Real32              &getExponent       (void) const;
00175            Real32              &getCutoff         (void);
00176      const Real32              &getCutoff         (void) const;
00177            Real32              &getConstantAttenuation(void);
00178      const Real32              &getConstantAttenuation(void) const;
00179            Real32              &getLinearAttenuation(void);
00180      const Real32              &getLinearAttenuation(void) const;
00181            Real32              &getQuadraticAttenuation(void);
00182      const Real32              &getQuadraticAttenuation(void) const;
00183 
00185     /*---------------------------------------------------------------------*/
00189      void setDiffuse        ( const Color4f &value );
00190      void setAmbient        ( const Color4f &value );
00191      void setSpecular       ( const Color4f &value );
00192      void setPosition       ( const Vec4f &value );
00193      void setDirection      ( const Vec3f &value );
00194      void setExponent       ( const Real32 &value );
00195      void setCutoff         ( const Real32 &value );
00196      void setConstantAttenuation( const Real32 &value );
00197      void setLinearAttenuation( const Real32 &value );
00198      void setQuadraticAttenuation( const Real32 &value );
00199 
00201     /*---------------------------------------------------------------------*/
00206     /*---------------------------------------------------------------------*/
00210     virtual UInt32 getBinSize (const BitVector         &whichField);
00211     virtual void   copyToBin  (      BinaryDataHandler &pMem,
00212                                const BitVector         &whichField);
00213     virtual void   copyFromBin(      BinaryDataHandler &pMem,
00214                                const BitVector         &whichField);
00215 
00216 
00218     /*---------------------------------------------------------------------*/
00222     static  LightChunkPtr      create          (void); 
00223     static  LightChunkPtr      createEmpty     (void); 
00224 
00227     /*---------------------------------------------------------------------*/
00231     virtual FieldContainerPtr     shallowCopy     (void) const; 
00232 
00234     /*=========================  PROTECTED  ===============================*/
00235   protected:
00236 
00237     /*---------------------------------------------------------------------*/
00241     SFColor4f           _sfDiffuse;
00242     SFColor4f           _sfAmbient;
00243     SFColor4f           _sfSpecular;
00244     SFVec4f             _sfPosition;
00245     SFVec3f             _sfDirection;
00246     SFReal32            _sfExponent;
00247     SFReal32            _sfCutoff;
00248     SFReal32            _sfConstantAttenuation;
00249     SFReal32            _sfLinearAttenuation;
00250     SFReal32            _sfQuadraticAttenuation;
00251 
00253     /*---------------------------------------------------------------------*/
00257     LightChunkBase(void);
00258     LightChunkBase(const LightChunkBase &source);
00259 
00261     /*---------------------------------------------------------------------*/
00265     virtual ~LightChunkBase(void); 
00266 
00268     /*---------------------------------------------------------------------*/
00272 #if !defined(OSG_FIXED_MFIELDSYNC)
00273     void executeSyncImpl(      LightChunkBase *pOther,
00274                          const BitVector         &whichField);
00275 
00276     virtual void   executeSync(      FieldContainer    &other,
00277                                const BitVector         &whichField);
00278 #else
00279     void executeSyncImpl(      LightChunkBase *pOther,
00280                          const BitVector         &whichField,
00281                          const SyncInfo          &sInfo     );
00282 
00283     virtual void   executeSync(      FieldContainer    &other,
00284                                const BitVector         &whichField,
00285                                const SyncInfo          &sInfo);
00286 
00287     virtual void execBeginEdit     (const BitVector &whichField,
00288                                           UInt32     uiAspect,
00289                                           UInt32     uiContainerSize);
00290 
00291             void execBeginEditImpl (const BitVector &whichField,
00292                                           UInt32     uiAspect,
00293                                           UInt32     uiContainerSize);
00294 
00295     virtual void onDestroyAspect(UInt32 uiId, UInt32 uiAspect);
00296 #endif
00297 
00299     /*==========================  PRIVATE  ================================*/
00300   private:
00301 
00302     friend class FieldContainer;
00303 
00304     static FieldDescription   *_desc[];
00305     static FieldContainerType  _type;
00306 
00307 
00308     // prohibit default functions (move to 'public' if you need one)
00309     void operator =(const LightChunkBase &source);
00310 };
00311 
00312 //---------------------------------------------------------------------------
00313 //   Exported Types
00314 //---------------------------------------------------------------------------
00315 
00316 
00317 typedef LightChunkBase *LightChunkBaseP;
00318 
00319 typedef osgIF<LightChunkBase::isNodeCore,
00320               CoredNodePtr<LightChunk>,
00321               FieldContainer::attempt_to_create_CoredNodePtr_on_non_NodeCore_FC
00322               >::_IRet LightChunkNodePtr;
00323 
00324 typedef RefPtr<LightChunkPtr> LightChunkRefPtr;
00325 
00326 OSG_END_NAMESPACE
00327 
00328 #define OSGLIGHTCHUNKBASE_HEADER_CVSID "@(#)$Id: FCBaseTemplate_h.h,v 1.40 2005/07/20 00:10:14 vossg Exp $"
00329 
00330 #endif /* _OSGLIGHTCHUNKBASE_H_ */