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 is
  27             ShadedRepresentation,
  28             WireFrameRepresentation,
  29             BothRepresentation
  30     end RepresentationOfShape;
  31     ---Purpose: Identifies the representation of the shape written
  32     -- to a VRML file. The available options are :
  33     -- -      VrmlAPI_ShadedRepresentation :
  34     --    the shape is translated with a shaded representation.
  35     -- -      VrmlAPI_WireFrameRepresentation :
  36     --   the shape is translated with a wireframe representation.
  37     -- -      VrmlAPI_BothRepresentation : the shape is translated
  38     --   to VRML format with both representations : shaded and
  39     --    wireframe. This is the default option.
  40
  41     class Writer;
  42         ---Purpose: With help of this class user can change parameters of writing.
  43
  44     Write(aShape: Shape from TopoDS; aFileName: CString from Standard);
  45         ---Purpose: Converts the shape aShape to VRML format and writes it
  46         -- to the file identified by aFileName using default parameters.
  47
  48 end VrmlAPI;