fixed: auto_ptr -> unique_ptr
[opensg.git] / Source / System / NodeCores / Groups / Base / OSGMaterialGroupBase.h
blob863f88efb3d9d841f8760ac71b24d629303938d5
1 /*---------------------------------------------------------------------------*\
2 * OpenSG *
3 * *
4 * *
5 * Copyright (C) 2000-2013 by the OpenSG Forum *
6 * *
7 * www.opensg.org *
8 * *
9 * contact: dirk@opensg.org, gerrit.voss@vossg.org, carsten_neumann@gmx.net *
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 \*---------------------------------------------------------------------------*/
39 /*****************************************************************************\
40 *****************************************************************************
41 ** **
42 ** This file is automatically generated. **
43 ** **
44 ** Any changes made to this file WILL be lost when it is **
45 ** regenerated, which can become necessary at any time. **
46 ** **
47 ** Do not change this file, changes should be done in the derived **
48 ** class MaterialGroup
49 ** **
50 *****************************************************************************
51 \*****************************************************************************/
54 #ifndef _OSGMATERIALGROUPBASE_H_
55 #define _OSGMATERIALGROUPBASE_H_
56 #ifdef __sgi
57 #pragma once
58 #endif
61 #include "OSGConfig.h"
62 #include "OSGSystemDef.h"
64 //#include "OSGBaseTypes.h"
66 #include "OSGGroup.h" // Parent
68 #include "OSGMaterialFields.h" // Material type
70 #include "OSGMaterialGroupFields.h"
72 OSG_BEGIN_NAMESPACE
75 class MaterialGroup;
77 //! \brief MaterialGroup Base Class.
79 class OSG_SYSTEM_DLLMAPPING MaterialGroupBase : public Group
81 public:
83 typedef Group Inherited;
84 typedef Group ParentContainer;
86 typedef Inherited::TypeObject TypeObject;
87 typedef TypeObject::InitPhase InitPhase;
89 OSG_GEN_INTERNALPTR(MaterialGroup);
91 /*========================== PUBLIC =================================*/
93 public:
95 enum
97 MaterialFieldId = Inherited::NextFieldId,
98 NextFieldId = MaterialFieldId + 1
101 static const OSG::BitVector MaterialFieldMask =
102 (TypeTraits<BitVector>::One << MaterialFieldId);
103 static const OSG::BitVector NextFieldMask =
104 (TypeTraits<BitVector>::One << NextFieldId);
106 typedef SFUnrecMaterialPtr SFMaterialType;
108 /*---------------------------------------------------------------------*/
109 /*! \name Class Get */
110 /*! \{ */
112 static FieldContainerType &getClassType (void);
113 static UInt32 getClassTypeId (void);
114 static UInt16 getClassGroupId(void);
116 /*! \} */
117 /*---------------------------------------------------------------------*/
118 /*! \name FieldContainer Get */
119 /*! \{ */
121 virtual FieldContainerType &getType (void);
122 virtual const FieldContainerType &getType (void) const;
124 virtual UInt32 getContainerSize(void) const;
126 /*! \} */
127 /*---------------------------------------------------------------------*/
128 /*! \name Field Get */
129 /*! \{ */
131 const SFUnrecMaterialPtr *getSFMaterial (void) const;
132 SFUnrecMaterialPtr *editSFMaterial (void);
135 Material * getMaterial (void) const;
137 /*! \} */
138 /*---------------------------------------------------------------------*/
139 /*! \name Field Set */
140 /*! \{ */
142 void setMaterial (Material * const value);
144 /*! \} */
145 /*---------------------------------------------------------------------*/
146 /*! \name Ptr Field Set */
147 /*! \{ */
149 /*! \} */
150 /*---------------------------------------------------------------------*/
151 /*! \name Ptr MField Set */
152 /*! \{ */
154 /*! \} */
155 /*---------------------------------------------------------------------*/
156 /*! \name Binary Access */
157 /*! \{ */
159 virtual SizeT getBinSize (ConstFieldMaskArg whichField);
160 virtual void copyToBin (BinaryDataHandler &pMem,
161 ConstFieldMaskArg whichField);
162 virtual void copyFromBin(BinaryDataHandler &pMem,
163 ConstFieldMaskArg whichField);
166 /*! \} */
167 /*---------------------------------------------------------------------*/
168 /*! \name Construction */
169 /*! \{ */
171 static MaterialGroupTransitPtr create (void);
172 static MaterialGroup *createEmpty (void);
174 static MaterialGroupTransitPtr createLocal (
175 BitVector bFlags = FCLocal::All);
177 static MaterialGroup *createEmptyLocal(
178 BitVector bFlags = FCLocal::All);
180 static MaterialGroupTransitPtr createDependent (BitVector bFlags);
182 /*! \} */
183 /*---------------------------------------------------------------------*/
184 /*! \name Copy */
185 /*! \{ */
187 virtual FieldContainerTransitPtr shallowCopy (void) const;
188 virtual FieldContainerTransitPtr shallowCopyLocal(
189 BitVector bFlags = FCLocal::All) const;
190 virtual FieldContainerTransitPtr shallowCopyDependent(
191 BitVector bFlags) const;
193 /*! \} */
194 /*========================= PROTECTED ===============================*/
196 protected:
198 static TypeObject _type;
200 static void classDescInserter(TypeObject &oType);
201 static const Char8 *getClassname (void );
203 /*---------------------------------------------------------------------*/
204 /*! \name Fields */
205 /*! \{ */
207 SFUnrecMaterialPtr _sfMaterial;
209 /*! \} */
210 /*---------------------------------------------------------------------*/
211 /*! \name Constructors */
212 /*! \{ */
214 MaterialGroupBase(void);
215 MaterialGroupBase(const MaterialGroupBase &source);
217 /*! \} */
218 /*---------------------------------------------------------------------*/
219 /*! \name Destructors */
220 /*! \{ */
222 virtual ~MaterialGroupBase(void);
224 /*! \} */
225 /*---------------------------------------------------------------------*/
226 /*! \name onCreate */
227 /*! \{ */
229 void onCreate(const MaterialGroup *source = NULL);
231 /*! \} */
232 /*---------------------------------------------------------------------*/
233 /*! \name Generic Field Access */
234 /*! \{ */
236 GetFieldHandlePtr getHandleMaterial (void) const;
237 EditFieldHandlePtr editHandleMaterial (void);
239 /*! \} */
240 /*---------------------------------------------------------------------*/
241 /*! \name Sync */
242 /*! \{ */
244 #ifdef OSG_MT_CPTR_ASPECT
245 virtual void execSyncV( FieldContainer &oFrom,
246 ConstFieldMaskArg whichField,
247 AspectOffsetStore &oOffsets,
248 ConstFieldMaskArg syncMode ,
249 const UInt32 uiSyncInfo);
251 void execSync ( MaterialGroupBase *pFrom,
252 ConstFieldMaskArg whichField,
253 AspectOffsetStore &oOffsets,
254 ConstFieldMaskArg syncMode ,
255 const UInt32 uiSyncInfo);
256 #endif
258 /*! \} */
259 /*---------------------------------------------------------------------*/
260 /*! \name Edit */
261 /*! \{ */
263 /*! \} */
264 /*---------------------------------------------------------------------*/
265 /*! \name Aspect Create */
266 /*! \{ */
268 #ifdef OSG_MT_CPTR_ASPECT
269 virtual FieldContainer *createAspectCopy(
270 const FieldContainer *pRefAspect) const;
271 #endif
273 /*! \} */
274 /*---------------------------------------------------------------------*/
275 /*! \name Edit */
276 /*! \{ */
277 /*! \} */
278 /*---------------------------------------------------------------------*/
279 /*! \name Sync */
280 /*! \{ */
282 virtual void resolveLinks(void);
284 /*! \} */
285 /*========================== PRIVATE ================================*/
287 private:
288 /*---------------------------------------------------------------------*/
290 // prohibit default functions (move to 'public' if you need one)
291 void operator =(const MaterialGroupBase &source);
294 typedef MaterialGroupBase *MaterialGroupBaseP;
296 typedef CoredNodeRefPtr <MaterialGroup> MaterialGroupNodeRefPtr;
297 typedef CoredNodeMTRefPtr<MaterialGroup> MaterialGroupNodeMTRefPtr;
299 OSG_END_NAMESPACE
301 #endif /* _OSGMATERIALGROUPBASE_H_ */