0030180: Data Exchange - VrmlAPI_Writer is expected to return export state
[occt.git] / src / VrmlAPI / VrmlAPI.hxx
1 // Created on: 2000-05-30
2 // Created by: Sergey MOZOKHIN
3 // Copyright (c) 2000-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _VrmlAPI_HeaderFile
17 #define _VrmlAPI_HeaderFile
18
19 #include <Standard.hxx>
20 #include <Standard_DefineAlloc.hxx>
21 #include <Standard_Handle.hxx>
22
23 #include <Standard_CString.hxx>
24 #include <Standard_Integer.hxx>
25 class TopoDS_Shape;
26 class VrmlAPI_Writer;
27
28
29 //! API for writing to VRML 1.0
30 class VrmlAPI 
31 {
32 public:
33
34   DEFINE_STANDARD_ALLOC
35
36   
37   //! With help of this class user can change parameters of writing.
38   //! Converts the shape aShape to VRML format of the passed version and writes it
39   //! to the file identified by aFileName using default parameters.
40   Standard_EXPORT static Standard_Boolean Write (const TopoDS_Shape& aShape, const Standard_CString aFileName, const Standard_Integer aVersion = 2);
41
42
43
44
45 protected:
46
47
48
49
50
51 private:
52
53
54
55
56 friend class VrmlAPI_Writer;
57
58 };
59
60
61
62
63
64
65
66 #endif // _VrmlAPI_HeaderFile