0023024: Update headers of OCCT files
[occt.git] / src / VrmlAPI / VrmlAPI.cdl
1 -- Created on: 2000-05-30
2 -- Created by: Sergey MOZOKHIN
3 -- Copyright (c) 2000-2012 OPEN CASCADE SAS
4 --
5 -- The content of this file is subject to the Open CASCADE Technology Public
6 -- License Version 6.5 (the "License"). You may not use the content of this file
7 -- except in compliance with the License. Please obtain a copy of the License
8 -- at http://www.opencascade.org and read it completely before using this file.
9 --
10 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
11 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
12 --
13 -- The Original Code and all software distributed under the License is
14 -- distributed on an "AS IS" basis, without warranty of any kind, and the
15 -- Initial Developer hereby disclaims all such warranties, including without
16 -- limitation, any warranties of merchantability, fitness for a particular
17 -- purpose or non-infringement. Please see the License for the specific terms
18 -- and conditions governing the rights and limitations under the License.
19
20
21
22 package VrmlAPI 
23
24         ---Purpose: API for writing to VRML 1.0
25
26 uses
27     TopoDS,
28     VrmlConverter,
29     Vrml,
30     Quantity
31 is
32     enumeration RepresentationOfShape
33         ---Purpose: Identifies the representation of the shape written
34         -- to a VRML file. The available options are :
35         -- -      VrmlAPI_ShadedRepresentation :
36         --    the shape is translated with a shaded representation.
37         -- -      VrmlAPI_WireFrameRepresentation :
38         --   the shape is translated with a wireframe representation.
39         -- -      VrmlAPI_BothRepresentation : the shape is translated
40         --   to VRML format with both representations : shaded and
41         --    wireframe. This is the default option.
42         
43     is
44             ShadedRepresentation,
45             WireFrameRepresentation,
46             BothRepresentation
47     end RepresentationOfShape;
48
49     class Writer;
50         ---Purpose: With help of this class user can change parameters of writing.
51     
52     Write(aShape: Shape from TopoDS; aFileName: CString from Standard);
53         ---Purpose: Converts the shape aShape to VRML format and writes it
54         -- to the file identified by aFileName using default parameters.
55     
56 end VrmlAPI;