0025748: Parallel version of progress indicator
[occt.git] / src / ShapeCustom / ShapeCustom.hxx
1 // Created on: 1998-06-03
2 // Created by: data exchange team
3 // Copyright (c) 1998-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _ShapeCustom_HeaderFile
18 #define _ShapeCustom_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <TopTools_DataMapOfShapeShape.hxx>
25 #include <Standard_Real.hxx>
26 #include <Standard_Integer.hxx>
27 #include <GeomAbs_Shape.hxx>
28 #include <Standard_Boolean.hxx>
29 #include <Message_ProgressRange.hxx>
30
31 class TopoDS_Shape;
32 class BRepTools_Modification;
33 class BRepTools_Modifier;
34 class ShapeBuild_ReShape;
35 class ShapeCustom_RestrictionParameters;
36 class ShapeCustom_Surface;
37 class ShapeCustom_Curve;
38 class ShapeCustom_Curve2d;
39 class ShapeCustom_RestrictionParameters;
40 class ShapeCustom_Modification;
41 class ShapeCustom_DirectModification;
42 class ShapeCustom_TrsfModification;
43 class ShapeCustom_BSplineRestriction;
44 class ShapeCustom_ConvertToRevolution;
45 class ShapeCustom_SweptToElementary;
46 class ShapeCustom_ConvertToBSpline;
47
48
49 //! This package is intended to
50 //! convert geometrical objects and topological. The
51 //! modifications of one geometrical object to another
52 //! (one) geometrical object are provided. The supported
53 //! modifications are the following:
54 //! conversion of BSpline and Bezier surfaces to analytical form,
55 //! conversion of indirect elementary surfaces (with left-handed
56 //! coordinate systems) into  direct ones,
57 //! conversion of elementary surfaces to surfaces of revolution,
58 //! conversion of surface of linear extrusion, revolution, offset
59 //! surface to bspline,
60 //! modification of parameterization, degree, number of segments of bspline
61 //! surfaces,  scale the shape.
62 class ShapeCustom 
63 {
64 public:
65
66   DEFINE_STANDARD_ALLOC
67
68   
69   //! Applies modifier to shape and checks sharing in the case assemblies.
70   Standard_EXPORT static TopoDS_Shape ApplyModifier
71     (const TopoDS_Shape& S, const Handle(BRepTools_Modification)& M,
72      TopTools_DataMapOfShapeShape& context, BRepTools_Modifier& MD,
73      const Message_ProgressRange& theProgress = Message_ProgressRange(),
74      const Handle(ShapeBuild_ReShape)& aReShape = NULL);
75   
76   //! Returns a new shape without indirect surfaces.
77   Standard_EXPORT static TopoDS_Shape DirectFaces (const TopoDS_Shape& S);
78   
79   //! Returns a new shape which is scaled original
80   Standard_EXPORT static TopoDS_Shape ScaleShape (const TopoDS_Shape& S, const Standard_Real scale);
81   
82   //! Returns a new shape with all surfaces, curves and pcurves
83   //! which type is BSpline/Bezier or based on them converted
84   //! having Degree less than <MaxDegree> or number of spans less
85   //! than <NbMaxSegment> in dependence on parameter priority <Degree>.
86   //! <GmaxDegree> and <GMaxSegments> are maximum possible degree
87   //! and number of spans correspondingly.
88   //! These values will be used in those cases when approximation with
89   //! specified parameters is impossible and one of GmaxDegree or
90   //! GMaxSegments is selected in dependence on priority.
91   //! Note that even if approximation is impossible with <GMaxDegree>
92   //! then number of spans can exceed specified <GMaxSegment>
93   //! <Rational> specifies if to convert Rational BSpline/Bezier into
94   //! polynomial B-Spline.
95   //! If flags ConvOffSurf,ConvOffCurve3d,ConvOffCurve2d are Standard_True there are means
96   //! that Offset surfaces , Offset curves 3d and Offset curves 2d are converted to BSPline
97   //! correspondingly.
98   Standard_EXPORT static TopoDS_Shape BSplineRestriction (const TopoDS_Shape& S, const Standard_Real Tol3d, const Standard_Real Tol2d, const Standard_Integer MaxDegree, const Standard_Integer MaxNbSegment, const GeomAbs_Shape Continuity3d, const GeomAbs_Shape Continuity2d, const Standard_Boolean Degree, const Standard_Boolean Rational, const Handle(ShapeCustom_RestrictionParameters)& aParameters);
99   
100   //! Returns a new shape with all elementary periodic surfaces converted
101   //! to Geom_SurfaceOfRevolution
102   Standard_EXPORT static TopoDS_Shape ConvertToRevolution (const TopoDS_Shape& S);
103   
104   //! Returns a new shape with all surfaces of revolution and linear extrusion
105   //! convert to elementary periodic surfaces
106   Standard_EXPORT static TopoDS_Shape SweptToElementary (const TopoDS_Shape& S);
107   
108   //! Returns a new shape with all surfaces of linear extrusion, revolution,
109   //! offset, and planar surfaces converted according to flags to
110   //! Geom_BSplineSurface (with same parameterisation).
111   Standard_EXPORT static TopoDS_Shape ConvertToBSpline (const TopoDS_Shape& S, const Standard_Boolean extrMode, const Standard_Boolean revolMode, const Standard_Boolean offsetMode, const Standard_Boolean planeMode = Standard_False);
112
113
114
115
116 protected:
117
118
119
120
121
122 private:
123
124
125
126
127 friend class ShapeCustom_Surface;
128 friend class ShapeCustom_Curve;
129 friend class ShapeCustom_Curve2d;
130 friend class ShapeCustom_RestrictionParameters;
131 friend class ShapeCustom_Modification;
132 friend class ShapeCustom_DirectModification;
133 friend class ShapeCustom_TrsfModification;
134 friend class ShapeCustom_BSplineRestriction;
135 friend class ShapeCustom_ConvertToRevolution;
136 friend class ShapeCustom_SweptToElementary;
137 friend class ShapeCustom_ConvertToBSpline;
138
139 };
140
141
142
143
144
145
146
147 #endif // _ShapeCustom_HeaderFile