include/opencascade/Vrml_Instancing.hxx

0001 // Created on: 1997-02-05
0002 // Created by: Alexander BRIVIN
0003 // Copyright (c) 1997-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _Vrml_Instancing_HeaderFile
0018 #define _Vrml_Instancing_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <TCollection_AsciiString.hxx>
0025 #include <Standard_OStream.hxx>
0026
0027
0028 //! defines  "instancing" - using  the  same  instance  of  a  node
0029 //! multiple  times.
0030 //! It  is  accomplished  by  using  the  "DEF"  and  "USE"  keywords.
0031 //! The  DEF  keyword  both  defines  a  named  node,  and  creates  a  single
0032 //! instance  of  it.
0033 //! The  USE  keyword  indicates  that  the  most  recently  defined  instance
0034 //! should  be  used  again.
0035 //! If  several  nades  were  given  the  same  name,  then  the  last  DEF
0036 //! encountered  during  parsing  "wins".
0037 //! DEF/USE  is  limited  to  a  single  file.
0038 class Vrml_Instancing
0039 {
0040 public:
0041
0042   DEFINE_STANDARD_ALLOC
0043
0044
0045   //! Adds "DEF  <myName>" in  anOStream  (VRML  file).
0046   Standard_EXPORT Vrml_Instancing(const TCollection_AsciiString& aString);
0047
0048   //! Adds "USE  <myName>" in  anOStream (VRML  file).
0049   Standard_EXPORT Standard_OStream& DEF (Standard_OStream& anOStream) const;
0050
0051   Standard_EXPORT Standard_OStream& USE (Standard_OStream& anOStream) const;
0052
0053
0054
0055
0056 protected:
0057
0058
0059
0060
0061
0062 private:
0063
0064
0065
0066   TCollection_AsciiString myName;
0067
0068
0069 };
0070
0071
0072
0073
0074
0075
0076
0077 #endif // _Vrml_Instancing_HeaderFile