Source/System/FieldContainer/Attachments/OSGBoostPathAttachment.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-2006 by the OpenSG Forum                 *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  *   contact:  David Kabala (djkabala@gmail.com)                             *
  10  *                                                                           *
  11 \*---------------------------------------------------------------------------*/
  12 /*---------------------------------------------------------------------------*\
  13  *                                License                                    *
  14  *                                                                           *
  15  * This library is free software; you can redistribute it and/or modify it   *
  16  * under the terms of the GNU Library General Public License as published    *
  17  * by the Free Software Foundation, version 2.                               *
  18  *                                                                           *
  19  * This library is distributed in the hope that it will be useful, but       *
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  22  * Library General Public License for more details.                          *
  23  *                                                                           *
  24  * You should have received a copy of the GNU Library General Public         *
  25  * License along with this library; if not, write to the Free Software       *
  26  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  27  *                                                                           *
  28 \*---------------------------------------------------------------------------*/
  29 /*---------------------------------------------------------------------------*\
  30  *                                Changes                                    *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35  *                                                                           *
  36  *                                                                           *
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef _OSGBOOSTPATHATTACHMENT_H_
  40 #define _OSGBOOSTPATHATTACHMENT_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGBoostPathAttachmentBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 /*! \brief BoostPathAttachment class. See \ref
  50            PageBoostPathAttachment for a description.
  51 */
  52
  53 class OSG_SYSTEM_DLLMAPPING BoostPathAttachment : public BoostPathAttachmentBase
  54 {
  55   protected:
  56
  57     /*==========================  PUBLIC  =================================*/
  58
  59   public:
  60
  61     typedef BoostPathAttachmentBase Inherited;
  62     typedef BoostPathAttachment     Self;
  63
  64     /*---------------------------------------------------------------------*/
  65     /*! \name                      Sync                                    */
  66     /*! \{                                                                 */
  67
  68     virtual void changed(ConstFieldMaskArg whichField,
  69                          UInt32            origin,
  70                          BitVector         details    );
  71
  72     /*! \}                                                                 */
  73     /*---------------------------------------------------------------------*/
  74     /*! \name                     Output                                   */
  75     /*! \{                                                                 */
  76
  77     virtual void dump(      UInt32     uiIndent = 0,
  78                       const BitVector  bvFlags  = 0) const;
  79
  80     /*! \}                                                                 */
  81     /*---------------------------------------------------------------------*/
  82     /*! \name                     Output                                   */
  83     /*! \{                                                                 */
  84
  85     /*! \}                                                                 */
  86     /*=========================  PROTECTED  ===============================*/
  87
  88   protected:
  89
  90     // Variables should all be in FilePathAttachmentBase.
  91
  92     /*---------------------------------------------------------------------*/
  93     /*! \name                  Constructors                                */
  94     /*! \{                                                                 */
  95
  96     BoostPathAttachment(void);
  97     BoostPathAttachment(const BoostPathAttachment &source);
  98
  99     /*! \}                                                                 */
 100     /*---------------------------------------------------------------------*/
 101     /*! \name                   Destructors                                */
 102     /*! \{                                                                 */
 103
 104     virtual ~BoostPathAttachment(void);
 105
 106     /*! \}                                                                 */
 107     /*---------------------------------------------------------------------*/
 108     /*! \name                      Init                                    */
 109     /*! \{                                                                 */
 110
 111     static void initMethod(InitPhase ePhase);
 112
 113     /*! \}                                                                 */
 114     /*==========================  PRIVATE  ================================*/
 115
 116   private:
 117
 118     friend class FieldContainer;
 119     friend class BoostPathAttachmentBase;
 120
 121     // prohibit default functions (move to 'public' if you need one)
 122     void operator =(const BoostPathAttachment &source);
 123 };
 124
 125 typedef BoostPathAttachment *BoostPathAttachmentP;
 126
 127 const BoostPath *getBoostPath(const AttachmentContainer *pContainer);
 128
 129       void       setBoostPath(      AttachmentContainer *pContainer,
 130                               const BoostPath           &oPath     );
 131
 132 OSG_END_NAMESPACE
 133
 134 #include "OSGBoostPathAttachmentBase.inl"
 135 #include "OSGBoostPathAttachment.inl"
 136
 137 #endif /* _OSGBOOSTPATHATTACHMENT_H_ */