Source/Base/FieldContainer/Fields/OSGNodeSFields.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *           Copyright (C) 2003 by the OpenSG Forum                          *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
  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 _OSGNODESFIELDS_H_
  40 #define _OSGNODESFIELDS_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGNodeFieldTraits.h"
  46 #include "OSGPointerSField.h"
  47 #include "OSGParentPointerSField.h"
  48
  49 OSG_BEGIN_NAMESPACE
  50
  51 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  52
  53 /*! \ingroup GrpBaseFieldContainerFieldSFields */
  54 typedef PointerSField      <Node *,
  55                             RecordedRefCountPolicy  > SFRecNodePtr;
  56 /*! \ingroup GrpBaseFieldContainerFieldSFields */
  57 typedef PointerSField      <Node *,
  58                             UnrecordedRefCountPolicy> SFUnrecNodePtr;
  59 /*! \ingroup GrpBaseFieldContainerFieldSFields */
  60 typedef PointerSField      <Node *,
  61                             WeakRefCountPolicy      > SFWeakNodePtr;
  62 /*! \ingroup GrpBaseFieldContainerFieldSFields */
  63 typedef PointerSField      <Node *,
  64                             NoRefCountPolicy        > SFUncountedNodePtr;
  65 /*! \ingroup GrpBaseFieldContainerFieldSFields */
  66 typedef ChildPointerSField <Node *,
  67                             UnrecordedRefCountPolicy,
  68                             1                       > SFUnrecChildNodePtr;
  69 /*! \ingroup GrpBaseFieldContainerFieldSFields */
  70 typedef ParentPointerSField<Node *,
  71                             NoRefCountPolicy,
  72                             1                       > SFParentNodePtr;
  73
  74 #else // these are the doxygen hacks
  75
  76 /*! \ingroup GrpBaseFieldContainerFieldSFields \ingroup GrpLibOSGBase */
  77 struct SFRecNodePtr :
  78     public PointerSField      <Node *,
  79                                RecordedRefCountPolicy  > {};
  80 /*! \ingroup GrpBaseFieldContainerFieldSFields \ingroup GrpLibOSGBase */
  81 struct SFUnrecNodePtr :
  82     public PointerSField      <Node *,
  83                                UnrecordedRefCountPolicy> {};
  84 /*! \ingroup GrpBaseFieldContainerFieldSFields \ingroup GrpLibOSGBase */
  85 struct SFWeakNodePtr :
  86     public PointerSField      <Node *,
  87                                WeakRefCountPolicy      > {};
  88 /*! \ingroup GrpBaseFieldContainerFieldSFields \ingroup GrpLibOSGBase */
  89 struct SFUncountedNodePtr :
  90     public PointerSField      <Node *,
  91                                NoRefCountPolicy        > {};
  92 /*! \ingroup GrpBaseFieldContainerFieldSFields \ingroup GrpLibOSGBase */
  93 struct SFUnrecChildNodePtr :
  94     public ChildPointerSField <Node *,
  95                                UnrecordedRefCountPolicy,
  96                                1                       > {};
  97 /*! \ingroup GrpBaseFieldContainerFieldSFields \ingroup GrpLibOSGBase */
  98 struct SFParentNodePtr :
  99     public ParentPointerSField<Node *,
 100                                NoRefCountPolicy,
 101                                1                       > {};
 102
 103 #endif // these are the doxygen hacks
 104
 105 OSG_END_NAMESPACE
 106
 107 #endif /* _OSGNODESFIELDS_H_ */