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 //! defines "instancing" - using the same instance of a node
0028 //! multiple times.
0029 //! It is accomplished by using the "DEF" and "USE" keywords.
0030 //! The DEF keyword both defines a named node, and creates a single
0031 //! instance of it.
0032 //! The USE keyword indicates that the most recently defined instance
0033 //! should be used again.
0034 //! If several nades were given the same name, then the last DEF
0035 //! encountered during parsing "wins".
0036 //! DEF/USE is limited to a single file.
0037 class Vrml_Instancing
0038 {
0039 public:
0040   DEFINE_STANDARD_ALLOC
0041
0042   //! Adds "DEF <myName>" in anOStream (VRML file).
0043   Standard_EXPORT Vrml_Instancing(const TCollection_AsciiString& aString);
0044
0045   //! Adds "USE <myName>" in anOStream (VRML file).
0046   Standard_EXPORT Standard_OStream& DEF(Standard_OStream& anOStream) const;
0047
0048   Standard_EXPORT Standard_OStream& USE(Standard_OStream& anOStream) const;
0049
0050 private:
0051   TCollection_AsciiString myName;
0052 };
0053
0054 #endif // _Vrml_Instancing_HeaderFile