OpenSG: OSGLightBase.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 Light
00049  **                                                                         **
00050  *****************************************************************************
00051 \*****************************************************************************/
00052 
00053 
00054 #ifndef _OSGLIGHTBASE_H_
00055 #define _OSGLIGHTBASE_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 <OSGGroup.h> // Parent
00069 
00070 #include <OSGColor4fFields.h> // Ambient type
00071 #include <OSGColor4fFields.h> // Diffuse type
00072 #include <OSGColor4fFields.h> // Specular type
00073 #include <OSGNodeFields.h> // Beacon type
00074 #include <OSGBoolFields.h> // On type
00075 #include <OSGReal32Fields.h> // ConstantAttenuation type
00076 #include <OSGReal32Fields.h> // LinearAttenuation type
00077 #include <OSGReal32Fields.h> // QuadraticAttenuation type
00078 #include <OSGReal32Fields.h> // ShadowIntensity type
00079 #include <OSGUInt32Fields.h> // ShadowMode type
00080 
00081 #include <OSGLightFields.h>
00082 
00083 OSG_BEGIN_NAMESPACE
00084 
00085 class Light;
00086 class BinaryDataHandler;
00087 
00089 
00090 class OSG_SYSTEMLIB_DLLMAPPING LightBase : public Group
00091 {
00092   private:
00093 
00094     typedef Group    Inherited;
00095 
00096     /*==========================  PUBLIC  =================================*/
00097   public:
00098 
00099     typedef LightPtr  Ptr;
00100 
00101     enum
00102     {
00103         AmbientFieldId              = Inherited::NextFieldId,
00104         DiffuseFieldId              = AmbientFieldId              + 1,
00105         SpecularFieldId             = DiffuseFieldId              + 1,
00106         BeaconFieldId               = SpecularFieldId             + 1,
00107         OnFieldId                   = BeaconFieldId               + 1,
00108         ConstantAttenuationFieldId  = OnFieldId                   + 1,
00109         LinearAttenuationFieldId    = ConstantAttenuationFieldId  + 1,
00110         QuadraticAttenuationFieldId = LinearAttenuationFieldId    + 1,
00111         ShadowIntensityFieldId      = QuadraticAttenuationFieldId + 1,
00112         ShadowModeFieldId           = ShadowIntensityFieldId      + 1,
00113         NextFieldId                 = ShadowModeFieldId           + 1
00114     };
00115 
00116     static const OSG::BitVector AmbientFieldMask;
00117     static const OSG::BitVector DiffuseFieldMask;
00118     static const OSG::BitVector SpecularFieldMask;
00119     static const OSG::BitVector BeaconFieldMask;
00120     static const OSG::BitVector OnFieldMask;
00121     static const OSG::BitVector ConstantAttenuationFieldMask;
00122     static const OSG::BitVector LinearAttenuationFieldMask;
00123     static const OSG::BitVector QuadraticAttenuationFieldMask;
00124     static const OSG::BitVector ShadowIntensityFieldMask;
00125     static const OSG::BitVector ShadowModeFieldMask;
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           *getSFAmbient        (void);
00153            SFColor4f           *getSFDiffuse        (void);
00154            SFColor4f           *getSFSpecular       (void);
00155            SFNodePtr           *getSFBeacon         (void);
00156            SFBool              *getSFOn             (void);
00157            SFReal32            *getSFConstantAttenuation(void);
00158            SFReal32            *getSFLinearAttenuation(void);
00159            SFReal32            *getSFQuadraticAttenuation(void);
00160            SFReal32            *getSFShadowIntensity(void);
00161            SFUInt32            *getSFShadowMode     (void);
00162 
00163            Color4f             &getAmbient        (void);
00164      const Color4f             &getAmbient        (void) const;
00165            Color4f             &getDiffuse        (void);
00166      const Color4f             &getDiffuse        (void) const;
00167            Color4f             &getSpecular       (void);
00168      const Color4f             &getSpecular       (void) const;
00169            NodePtr             &getBeacon         (void);
00170      const NodePtr             &getBeacon         (void) const;
00171            bool                &getOn             (void);
00172      const bool                &getOn             (void) const;
00173            Real32              &getConstantAttenuation(void);
00174      const Real32              &getConstantAttenuation(void) const;
00175            Real32              &getLinearAttenuation(void);
00176      const Real32              &getLinearAttenuation(void) const;
00177            Real32              &getQuadraticAttenuation(void);
00178      const Real32              &getQuadraticAttenuation(void) const;
00179            Real32              &getShadowIntensity(void);
00180      const Real32              &getShadowIntensity(void) const;
00181            UInt32              &getShadowMode     (void);
00182      const UInt32              &getShadowMode     (void) const;
00183 
00185     /*---------------------------------------------------------------------*/
00189      void setAmbient        ( const Color4f &value );
00190      void setDiffuse        ( const Color4f &value );
00191      void setSpecular       ( const Color4f &value );
00192      void setBeacon         ( const NodePtr &value );
00193      void setOn             ( const bool &value );
00194      void setConstantAttenuation( const Real32 &value );
00195      void setLinearAttenuation( const Real32 &value );
00196      void setQuadraticAttenuation( const Real32 &value );
00197      void setShadowIntensity( const Real32 &value );
00198      void setShadowMode     ( const UInt32 &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     /*=========================  PROTECTED  ===============================*/
00219   protected:
00220 
00221     /*---------------------------------------------------------------------*/
00225     SFColor4f           _sfAmbient;
00226     SFColor4f           _sfDiffuse;
00227     SFColor4f           _sfSpecular;
00228     SFNodePtr           _sfBeacon;
00229     SFBool              _sfOn;
00230     SFReal32            _sfConstantAttenuation;
00231     SFReal32            _sfLinearAttenuation;
00232     SFReal32            _sfQuadraticAttenuation;
00233     SFReal32            _sfShadowIntensity;
00234     SFUInt32            _sfShadowMode;
00235 
00237     /*---------------------------------------------------------------------*/
00241     LightBase(void);
00242     LightBase(const LightBase &source);
00243 
00245     /*---------------------------------------------------------------------*/
00249     virtual ~LightBase(void); 
00250 
00252     /*---------------------------------------------------------------------*/
00256 #if !defined(OSG_FIXED_MFIELDSYNC)
00257     void executeSyncImpl(      LightBase *pOther,
00258                          const BitVector         &whichField);
00259 
00260     virtual void   executeSync(      FieldContainer    &other,
00261                                const BitVector         &whichField);
00262 #else
00263     void executeSyncImpl(      LightBase *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 LightBase &source);
00294 };
00295 
00296 //---------------------------------------------------------------------------
00297 //   Exported Types
00298 //---------------------------------------------------------------------------
00299 
00300 
00301 typedef LightBase *LightBaseP;
00302 
00303 typedef osgIF<LightBase::isNodeCore,
00304               CoredNodePtr<Light>,
00305               FieldContainer::attempt_to_create_CoredNodePtr_on_non_NodeCore_FC
00306               >::_IRet LightNodePtr;
00307 
00308 typedef RefPtr<LightPtr> LightRefPtr;
00309 
00310 OSG_END_NAMESPACE
00311 
00312 #define OSGLIGHTBASE_HEADER_CVSID "@(#)$Id: FCBaseTemplate_h.h,v 1.40 2005/07/20 00:10:14 vossg Exp $"
00313 
00314 #endif /* _OSGLIGHTBASE_H_ */