7ebf2963411c82c03a406e74abbd6399ab533954
[occt.git] / src / VrmlAPI / VrmlAPI.cdl
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 package VrmlAPI 
17
18         ---Purpose: API for writing to VRML 1.0
19
20 uses
21     TopoDS,
22     VrmlConverter,
23     Vrml,
24     Quantity
25 is
26     enumeration RepresentationOfShape
27         ---Purpose: Identifies the representation of the shape written
28         -- to a VRML file. The available options are :
29         -- -      VrmlAPI_ShadedRepresentation :
30         --    the shape is translated with a shaded representation.
31         -- -      VrmlAPI_WireFrameRepresentation :
32         --   the shape is translated with a wireframe representation.
33         -- -      VrmlAPI_BothRepresentation : the shape is translated
34         --   to VRML format with both representations : shaded and
35         --    wireframe. This is the default option.
36         
37     is
38             ShadedRepresentation,
39             WireFrameRepresentation,
40             BothRepresentation
41     end RepresentationOfShape;
42
43     class Writer;
44         ---Purpose: With help of this class user can change parameters of writing.
45     
46     Write(aShape: Shape from TopoDS; aFileName: CString from Standard);
47         ---Purpose: Converts the shape aShape to VRML format and writes it
48         -- to the file identified by aFileName using default parameters.
49     
50 end VrmlAPI;