OSGSpotLightBase.h

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 *                                OpenSG                                     *
 *                                                                           *
 *                                                                           *
 *               Copyright (C) 2000-2002 by the OpenSG Forum                 *
 *                                                                           *
 *                            www.opensg.org                                 *
 *                                                                           *
 *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
 *                                                                           *
\*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*\
 *                                License                                    *
 *                                                                           *
 * This library is free software; you can redistribute it and/or modify it   *
 * under the terms of the GNU Library General Public License as published    *
 * by the Free Software Foundation, version 2.                               *
 *                                                                           *
 * This library is distributed in the hope that it will be useful, but       *
 * WITHOUT ANY WARRANTY; without even the implied warranty of                *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
 * Library General Public License for more details.                          *
 *                                                                           *
 * You should have received a copy of the GNU Library General Public         *
 * License along with this library; if not, write to the Free Software       *
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
 *                                                                           *
\*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*\
 *                                Changes                                    *
 *                                                                           *
 *                                                                           *
 *                                                                           *
 *                                                                           *
 *                                                                           *
 *                                                                           *
\*---------------------------------------------------------------------------*/

/*****************************************************************************\
 *****************************************************************************
 **                                                                         **
 **                  This file is automatically generated.                  **
 **                                                                         **
 **          Any changes made to this file WILL be lost when it is          **
 **           regenerated, which can become necessary at any time.          **
 **                                                                         **
 **     Do not change this file, changes should be done in the derived      **
 **     class SpotLight
 **                                                                         **
 *****************************************************************************
\*****************************************************************************/


#ifndef _OSGSPOTLIGHTBASE_H_
#define _OSGSPOTLIGHTBASE_H_
#ifdef __sgi
#pragma once
#endif


#include <OSGConfig.h>
#include <OSGSystemDef.h>

#include <OSGBaseTypes.h>
#include <OSGRefPtr.h>
#include <OSGCoredNodePtr.h>

#include <OSGPointLight.h> // Parent

#include <OSGVec3fFields.h> // Direction type
#include <OSGReal32Fields.h> // SpotExponent type
#include <OSGReal32Fields.h> // SpotCutOff type

#include <OSGSpotLightFields.h>

OSG_BEGIN_NAMESPACE

class SpotLight;
class BinaryDataHandler;


class OSG_SYSTEMLIB_DLLMAPPING SpotLightBase : public PointLight
{
  private:

    typedef PointLight    Inherited;

    /*==========================  PUBLIC  =================================*/
  public:

    typedef SpotLightPtr  Ptr;

    enum
    {
        DirectionFieldId    = Inherited::NextFieldId,
        SpotExponentFieldId = DirectionFieldId    + 1,
        SpotCutOffFieldId   = SpotExponentFieldId + 1,
        NextFieldId         = SpotCutOffFieldId   + 1
    };

    static const OSG::BitVector DirectionFieldMask;
    static const OSG::BitVector SpotExponentFieldMask;
    static const OSG::BitVector SpotCutOffFieldMask;


    static const OSG::BitVector MTInfluenceMask;

    /*---------------------------------------------------------------------*/
    static        FieldContainerType &getClassType    (void); 
    static        UInt32              getClassTypeId  (void); 

    /*---------------------------------------------------------------------*/
    virtual       FieldContainerType &getType  (void); 
    virtual const FieldContainerType &getType  (void) const; 

    virtual       UInt32              getContainerSize(void) const;

    /*---------------------------------------------------------------------*/
           SFVec3f             *getSFDirection      (void);
           SFReal32            *getSFSpotExponent   (void);
           SFReal32            *getSFSpotCutOff     (void);

           Vec3f               &getDirection      (void);
     const Vec3f               &getDirection      (void) const;
           Real32              &getSpotExponent   (void);
     const Real32              &getSpotExponent   (void) const;
           Real32              &getSpotCutOff     (void);
     const Real32              &getSpotCutOff     (void) const;

    /*---------------------------------------------------------------------*/
     void setDirection      ( const Vec3f &value );
     void setSpotExponent   ( const Real32 &value );
     void setSpotCutOff     ( const Real32 &value );

    /*---------------------------------------------------------------------*/
    /*---------------------------------------------------------------------*/
    virtual UInt32 getBinSize (const BitVector         &whichField);
    virtual void   copyToBin  (      BinaryDataHandler &pMem,
                               const BitVector         &whichField);
    virtual void   copyFromBin(      BinaryDataHandler &pMem,
                               const BitVector         &whichField);


    /*---------------------------------------------------------------------*/
    static  SpotLightPtr      create          (void); 
    static  SpotLightPtr      createEmpty     (void); 

    /*---------------------------------------------------------------------*/
    virtual FieldContainerPtr     shallowCopy     (void) const; 

    /*=========================  PROTECTED  ===============================*/
  protected:

    /*---------------------------------------------------------------------*/
    SFVec3f             _sfDirection;
    SFReal32            _sfSpotExponent;
    SFReal32            _sfSpotCutOff;

    /*---------------------------------------------------------------------*/
    SpotLightBase(void);
    SpotLightBase(const SpotLightBase &source);

    /*---------------------------------------------------------------------*/
    virtual ~SpotLightBase(void); 

    /*---------------------------------------------------------------------*/
#if !defined(OSG_FIXED_MFIELDSYNC)
    void executeSyncImpl(      SpotLightBase *pOther,
                         const BitVector         &whichField);

    virtual void   executeSync(      FieldContainer    &other,
                               const BitVector         &whichField);
#else
    void executeSyncImpl(      SpotLightBase *pOther,
                         const BitVector         &whichField,
                         const SyncInfo          &sInfo     );

    virtual void   executeSync(      FieldContainer    &other,
                               const BitVector         &whichField,
                               const SyncInfo          &sInfo);

    virtual void execBeginEdit     (const BitVector &whichField,
                                          UInt32     uiAspect,
                                          UInt32     uiContainerSize);

            void execBeginEditImpl (const BitVector &whichField,
                                          UInt32     uiAspect,
                                          UInt32     uiContainerSize);

    virtual void onDestroyAspect(UInt32 uiId, UInt32 uiAspect);
#endif

    /*==========================  PRIVATE  ================================*/
  private:

    friend class FieldContainer;

    static FieldDescription   *_desc[];
    static FieldContainerType  _type;


    // prohibit default functions (move to 'public' if you need one)
    void operator =(const SpotLightBase &source);
};

//---------------------------------------------------------------------------
//   Exported Types
//---------------------------------------------------------------------------


typedef SpotLightBase *SpotLightBaseP;

typedef osgIF<SpotLightBase::isNodeCore,
              CoredNodePtr<SpotLight>,
              FieldContainer::attempt_to_create_CoredNodePtr_on_non_NodeCore_FC
              >::_IRet SpotLightNodePtr;

typedef RefPtr<SpotLightPtr> SpotLightRefPtr;

OSG_END_NAMESPACE

#define OSGSPOTLIGHTBASE_HEADER_CVSID "@(#)$Id: FCBaseTemplate_h.h,v 1.38 2005/07/08 06:37:35 vossg Exp $"

#endif /* _OSGSPOTLIGHTBASE_H_ */

---