Files
OCCT/src/BRepOffset/BRepOffset_Offset.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

183 lines
6.4 KiB
Plaintext

-- Created on: 1995-10-19
-- Created by: Bruno DUMORTIER
-- Copyright (c) 1995-1999 Matra Datavision
-- Copyright (c) 1999-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.
class Offset from BRepOffset
---Purpose: This class compute elemenary offset surface.
-- Evaluate the offset generated :
-- 1 - from a face.
-- 2 - from an edge.
-- 3 - from a vertex.
uses
Status from BRepOffset,
Shape from TopoDS,
Face from TopoDS,
Edge from TopoDS,
Vertex from TopoDS,
ListOfShape from TopTools,
DataMapOfShapeShape from TopTools,
Shape from GeomAbs,
JoinType from GeomAbs
is
Create returns Offset from BRepOffset;
Create( Face : Face from TopoDS;
Offset : Real from Standard;
OffsetOutside : Boolean from Standard = Standard_True;
JoinType : JoinType from GeomAbs = GeomAbs_Arc)
---Purpose:
returns Offset from BRepOffset;
Create( Face : Face from TopoDS;
Offset : Real from Standard;
Created : DataMapOfShapeShape from TopTools;
OffsetOutside : Boolean from Standard = Standard_True;
JoinType : JoinType from GeomAbs = GeomAbs_Arc)
---Purpose: This method will be called when you want to share
-- the edges soon generated from an other face.
-- e.g. when two faces are tangents the common edge
-- will generate only one edge ( no pipe).
--
-- The Map will be fill as follow:
--
-- Created(E) = E'
-- with: E = an edge of <Face>
-- E' = the image of E in the offseting of
-- another face sharing E with a
-- continuity at least G1
--
returns Offset from BRepOffset;
Create( Path : Edge from TopoDS;
Edge1 : Edge from TopoDS;
Edge2 : Edge from TopoDS;
Offset : Real from Standard;
Polynomial: Boolean from Standard = Standard_False;
Tol : Real from Standard = 1.0e-4;
Conti : Shape from GeomAbs = GeomAbs_C1)
---Purpose:
returns Offset from BRepOffset;
Create( Path : Edge from TopoDS;
Edge1 : Edge from TopoDS;
Edge2 : Edge from TopoDS;
Offset : Real from Standard;
FirstEdge : Edge from TopoDS;
LastEdge : Edge from TopoDS;
Polynomial: Boolean from Standard = Standard_False;
Tol : Real from Standard = 1.0e-4;
Conti : Shape from GeomAbs = GeomAbs_C1)
---Purpose:
returns Offset from BRepOffset;
Create( Vertex : Vertex from TopoDS;
LEdge : ListOfShape from TopTools;
Offset : Real from Standard;
Polynomial: Boolean from Standard = Standard_False;
Tol : Real from Standard = 1.0e-4;
Conti : Shape from GeomAbs = GeomAbs_C1)
---Purpose: Tol and Conti are only used if Polynomial is True
-- (Used to perfrom the approximation)
returns Offset from BRepOffset;
Init( me : in out;
Face : Face from TopoDS;
Offset : Real from Standard;
OffsetOutside : Boolean from Standard = Standard_True;
JoinType : JoinType from GeomAbs = GeomAbs_Arc)
---Purpose:
is static;
Init( me : in out;
Face : Face from TopoDS;
Offset : Real from Standard;
Created : DataMapOfShapeShape from TopTools;
OffsetOutside : Boolean from Standard = Standard_True;
JoinType : JoinType from GeomAbs = GeomAbs_Arc)
---Purpose:
is static;
Init( me : in out;
Path : Edge from TopoDS;
Edge1 : Edge from TopoDS;
Edge2 : Edge from TopoDS;
Offset : Real from Standard;
Polynomial: Boolean from Standard = Standard_False;
Tol : Real from Standard = 1.0e-4;
Conti : Shape from GeomAbs = GeomAbs_C1)
---Purpose:
is static;
Init( me : in out;
Path : Edge from TopoDS;
Edge1 : Edge from TopoDS;
Edge2 : Edge from TopoDS;
Offset : Real from Standard;
FirstEdge : Edge from TopoDS;
LastEdge : Edge from TopoDS;
Polynomial: Boolean from Standard = Standard_False;
Tol : Real from Standard = 1.0e-4;
Conti : Shape from GeomAbs = GeomAbs_C1)
---Purpose:
is static;
Init( me: in out;
Vertex : Vertex from TopoDS;
LEdge : ListOfShape from TopTools;
Offset : Real from Standard;
Polynomial: Boolean from Standard = Standard_False;
Tol : Real from Standard = 1.0e-4;
Conti : Shape from GeomAbs = GeomAbs_C1)
---Purpose: Tol and Conti are only used if Polynomial is True
-- (Used to perfrom the approximation)
is static;
Init( me : in out;
Edge : Edge from TopoDS;
Offset : Real from Standard)
---Purpose: Only used in Rolling Ball. Pipe on Free Boundary
is static;
InitialShape(me)
---C++: return const &
---C++: inline
returns Shape from TopoDS;
Face( me)
---C++: return const &
returns Face from TopoDS;
Generated(me; Shape : Shape from TopoDS)
---Purpose:
returns Shape from TopoDS;
Status( me)
---Purpose:
returns Status from BRepOffset;
fields
myShape : Shape from TopoDS;
myStatus : Status from BRepOffset;
myFace : Face from TopoDS;
myMap : DataMapOfShapeShape from TopTools;
end Offset;