Integration of OCCT 6.5.0 from SVN
[occt.git] / src / VrmlAPI / VrmlAPI.cdl
1 -- File:        VrmlAPI.cdl
2 -- Created:     Tue May 30 15:49:48 2000
3 -- Author:      Sergey MOZOKHIN
4 --              <smh@russox.nnov.matra-dtv.fr>
5 ---Copyright:    Matra Datavision 2000
6
7
8 package VrmlAPI 
9
10         ---Purpose: API for writing to VRML 1.0
11
12 uses
13     TopoDS,
14     VrmlConverter,
15     Vrml,
16     Quantity
17 is
18     enumeration RepresentationOfShape
19         ---Purpose: Identifies the representation of the shape written
20         -- to a VRML file. The available options are :
21         -- -      VrmlAPI_ShadedRepresentation :
22         --    the shape is translated with a shaded representation.
23         -- -      VrmlAPI_WireFrameRepresentation :
24         --   the shape is translated with a wireframe representation.
25         -- -      VrmlAPI_BothRepresentation : the shape is translated
26         --   to VRML format with both representations : shaded and
27         --    wireframe. This is the default option.
28         
29     is
30             ShadedRepresentation,
31             WireFrameRepresentation,
32             BothRepresentation
33     end RepresentationOfShape;
34
35     class Writer;
36         ---Purpose: With help of this class user can change parameters of writing.
37     
38     Write(aShape: Shape from TopoDS; aFileName: CString from Standard);
39         ---Purpose: Converts the shape aShape to VRML format and writes it
40         -- to the file identified by aFileName using default parameters.
41     
42 end VrmlAPI;