OSGGradientBackgroundBase.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 GradientBackground
 **                                                                         **
 *****************************************************************************
\*****************************************************************************/


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


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

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

#include <OSGBackground.h> // Parent

#include <OSGColor3fFields.h> // Color type
#include <OSGReal32Fields.h> // Position type
#include <OSGInt32Fields.h> // ClearStencilBit type

#include <OSGGradientBackgroundFields.h>

OSG_BEGIN_NAMESPACE

class GradientBackground;
class BinaryDataHandler;


class OSG_SYSTEMLIB_DLLMAPPING GradientBackgroundBase : public Background
{
  private:

    typedef Background    Inherited;

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

    typedef GradientBackgroundPtr  Ptr;

    enum
    {
        ColorFieldId           = Inherited::NextFieldId,
        PositionFieldId        = ColorFieldId           + 1,
        ClearStencilBitFieldId = PositionFieldId        + 1,
        NextFieldId            = ClearStencilBitFieldId + 1
    };

    static const OSG::BitVector ColorFieldMask;
    static const OSG::BitVector PositionFieldMask;
    static const OSG::BitVector ClearStencilBitFieldMask;


    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;

    /*---------------------------------------------------------------------*/
           SFInt32             *getSFClearStencilBit(void);

           Int32               &getClearStencilBit(void);
     const Int32               &getClearStencilBit(void) const;

    /*---------------------------------------------------------------------*/
     void setClearStencilBit( const Int32 &value );

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


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

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

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

    /*---------------------------------------------------------------------*/
    MFColor3f           _mfColor;
    MFReal32            _mfPosition;
    SFInt32             _sfClearStencilBit;

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

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

    /*---------------------------------------------------------------------*/
           MFColor3f           *getMFColor          (void);
           MFReal32            *getMFPosition       (void);

           Color3f             &getColor          (UInt32 index);
           MFColor3f           &getColor          (void);
     const MFColor3f           &getColor          (void) const;
           Real32              &getPosition       (UInt32 index);
           MFReal32            &getPosition       (void);
     const MFReal32            &getPosition       (void) const;

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

    virtual void   executeSync(      FieldContainer    &other,
                               const BitVector         &whichField);
#else
    void executeSyncImpl(      GradientBackgroundBase *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 GradientBackgroundBase &source);
};

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


typedef GradientBackgroundBase *GradientBackgroundBaseP;

typedef osgIF<GradientBackgroundBase::isNodeCore,
              CoredNodePtr<GradientBackground>,
              FieldContainer::attempt_to_create_CoredNodePtr_on_non_NodeCore_FC
              >::_IRet GradientBackgroundNodePtr;

typedef RefPtr<GradientBackgroundPtr> GradientBackgroundRefPtr;

OSG_END_NAMESPACE

#define OSGGRADIENTBACKGROUNDBASE_HEADER_CVSID "@(#)$Id: FCBaseTemplate_h.h,v 1.40 2005/07/20 00:10:14 vossg Exp $"

#endif /* _OSGGRADIENTBACKGROUNDBASE_H_ */

---