src/Vrml/Vrml_Info.hxx

   1 // Created on: 1997-02-10
   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_Info_HeaderFile
  18 #define _Vrml_Info_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
  27
  28 //! defines a Info node of VRML specifying properties of geometry
  29 //! and its appearance.
  30 //! It  is  used  to  store  information  in  the  scene  graph,
  31 //! Typically  for  application-specific  purposes,  copyright  messages,
  32 //! or  other  strings.
  33 class Vrml_Info
  34 {
  35 public:
  36
  37   DEFINE_STANDARD_ALLOC
  38
  39
  40   Standard_EXPORT Vrml_Info(const TCollection_AsciiString& aString = "<Undefined info>");
  41
  42   Standard_EXPORT void SetString (const TCollection_AsciiString& aString);
  43
  44   Standard_EXPORT TCollection_AsciiString String() const;
  45
  46   Standard_EXPORT Standard_OStream& Print (Standard_OStream& anOStream) const;
  47
  48
  49
  50
  51 protected:
  52
  53
  54
  55
  56
  57 private:
  58
  59
  60
  61   TCollection_AsciiString myString;
  62
  63
  64 };
  65
  66
  67
  68
  69
  70
  71
  72 #endif // _Vrml_Info_HeaderFile