Files
OCCT/src/StlAPI/StlAPI_Writer.cdl

81 lines
3.3 KiB
Plaintext
Executable File

-- Created on: 2000-06-23
-- Created by: Sergey MOZOKHIN
-- Copyright (c) 2000-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer hereby disclaims all such warranties, including without
-- limitation, any warranties of merchantability, fitness for a particular
-- purpose or non-infringement. Please see the License for the specific terms
-- and conditions governing the rights and limitations under the License.
class Writer from StlAPI
---Purpose: This class creates and writes
-- STL files from Open CASCADE shapes. An STL file can be
-- written to an existing STL file or to a new one..
uses
Shape from TopoDS,
Mesh from StlMesh
is
Create;
---Purpose: Creates a writer object with
-- default parameters: ASCIIMode, RelativeMode, SetCoefficent,
-- SetDeflection. These parameters may be modified.
SetDeflection(me: in out; aDeflection : in Real from Standard);
---Purpose: Sets the deflection of the meshing algorithm.
-- Deflection is used, only if relative mode is false
SetCoefficient(me: in out; aCoefficient : in Real from Standard);
---Purpose: Sets the coeffiecient for computation of deflection through
-- relative size of shape. Default value = 0.001
RelativeMode(me: in out) returns Boolean;
---C++: return &
---Purpose: Returns the address to the
-- flag defining the relative mode for writing the file.
-- This address may be used to either read or change the flag.
-- If the mode returns True (default value), the
-- deflection is calculated from the relative size of the
-- shape. If the mode returns False, the user defined deflection is used.
-- Example
-- Read:
-- Standard_Boolean val = Writer.RelativeMode( );
-- Modify:
-- Writer.RelativeMode( ) = Standard_True;
ASCIIMode(me: in out) returns Boolean;
---C++: return &
---Purpose: Returns the address to the
-- flag defining the mode for writing the file. This address
-- may be used to either read or change the flag.
-- If the mode returns True (default value) the generated
-- file is an ASCII file. If the mode returns False, the
-- generated file is a binary file.
Write(me : in out;
aShape : Shape from TopoDS;
aFileName : CString from Standard;
InParallel : Boolean from Standard = Standard_False);
---Purpose: Converts a given shape to STL format and writes it to file with a given filename.
fields
theRelativeMode : Boolean from Standard;
theASCIIMode : Boolean from Standard;
theDeflection : Real from Standard;
theCoefficient : Real from Standard;
theStlMesh : Mesh from StlMesh;
end Writer;