Files
OCCT/src/VrmlAPI/VrmlAPI.cdl
ski ff8178ef85 0024784: Move documentation in CDL files to proper location
Mostly duplicated comments were removed and missing ones were moved
into dedicated class CDL files.
Some more duplicated comments were removed from CDL files.
Correction of merge
2014-05-29 16:06:49 +04:00

49 lines
1.8 KiB
Plaintext

-- Created on: 2000-05-30
-- Created by: Sergey MOZOKHIN
-- Copyright (c) 2000-2014 OPEN CASCADE SAS
--
-- This file is part of Open CASCADE Technology software library.
--
-- This library is free software; you can redistribute it and/or modify it under
-- the terms of the GNU Lesser General Public License version 2.1 as published
-- by the Free Software Foundation, with special exception defined in the file
-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
-- distribution for complete text of the license and disclaimer of any warranty.
--
-- Alternatively, this file may be used under the terms of Open CASCADE
-- commercial license or contractual agreement.
package VrmlAPI
---Purpose: API for writing to VRML 1.0
uses
TopoDS,
VrmlConverter,
Vrml,
Quantity
is
enumeration RepresentationOfShape is
ShadedRepresentation,
WireFrameRepresentation,
BothRepresentation
end RepresentationOfShape;
---Purpose: Identifies the representation of the shape written
-- to a VRML file. The available options are :
-- - VrmlAPI_ShadedRepresentation :
-- the shape is translated with a shaded representation.
-- - VrmlAPI_WireFrameRepresentation :
-- the shape is translated with a wireframe representation.
-- - VrmlAPI_BothRepresentation : the shape is translated
-- to VRML format with both representations : shaded and
-- wireframe. This is the default option.
class Writer;
---Purpose: With help of this class user can change parameters of writing.
Write(aShape: Shape from TopoDS; aFileName: CString from Standard);
---Purpose: Converts the shape aShape to VRML format and writes it
-- to the file identified by aFileName using default parameters.
end VrmlAPI;