src/Vrml/Vrml_Instancing.hxx

   1 // Created on: 1997-02-05
   2 // Created by: Alexander BRIVIN
   3 // Copyright (c) 1997-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _Vrml_Instancing_HeaderFile
  18 #define _Vrml_Instancing_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <TCollection_AsciiString.hxx>
  25 #include <Standard_OStream.hxx>
  26 class TCollection_AsciiString;
  27
  28
  29 //! defines  "instancing" - using  the  same  instance  of  a  node
  30 //! multiple  times.
  31 //! It  is  accomplished  by  using  the  "DEF"  and  "USE"  keywords.
  32 //! The  DEF  keyword  both  defines  a  named  node,  and  creates  a  single
  33 //! instance  of  it.
  34 //! The  USE  keyword  indicates  that  the  most  recently  defined  instance
  35 //! should  be  used  again.
  36 //! If  several  nades  were  given  the  same  name,  then  the  last  DEF
  37 //! encountered  during  parsing  "wins".
  38 //! DEF/USE  is  limited  to  a  single  file.
  39 class Vrml_Instancing
  40 {
  41 public:
  42
  43   DEFINE_STANDARD_ALLOC
  44
  45
  46   //! Adds "DEF  <myName>" in  anOStream  (VRML  file).
  47   Standard_EXPORT Vrml_Instancing(const TCollection_AsciiString& aString);
  48
  49   //! Adds "USE  <myName>" in  anOStream (VRML  file).
  50   Standard_EXPORT Standard_OStream& DEF (Standard_OStream& anOStream) const;
  51
  52   Standard_EXPORT Standard_OStream& USE (Standard_OStream& anOStream) const;
  53
  54
  55
  56
  57 protected:
  58
  59
  60
  61
  62
  63 private:
  64
  65
  66
  67   TCollection_AsciiString myName;
  68
  69
  70 };
  71
  72
  73
  74
  75
  76
  77
  78 #endif // _Vrml_Instancing_HeaderFile