0026106: BRepMesh - revision of data model
[occt.git] / src / BRepMesh / BRepMesh_Deflection.hxx
1 // Created on: 2016-04-19
2 // Copyright (c) 2016 OPEN CASCADE SAS
3 // Created by: Oleg AGASHIN
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 #ifndef _BRepMesh_Deflection_HeaderFile
17 #define _BRepMesh_Deflection_HeaderFile
18
19 #include <Standard_Type.hxx>
20 #include <Standard_Handle.hxx>
21 #include <Standard_Transient.hxx>
22 #include <IMeshData_Types.hxx>
23
24 class Bnd_Box;
25 class TopoDS_Face;
26 class TopoDS_Edge;
27 struct IMeshTools_Parameters;
28
29 //! Auxiliary tool encompassing methods to compute deflection of shapes.
30 class BRepMesh_Deflection : public Standard_Transient
31 {
32 public:
33
34   //! Returns relative deflection for edge with respect to shape size.
35   //! @param theEdge edge for which relative deflection should be computed.
36   //! @param theDeflection absolute deflection.
37   //! @param theMaxShapeSize maximum size of a shape.
38   //! @param theAdjustmentCoefficient coefficient of adjustment between maximum 
39   //! size of shape and calculated relative deflection.
40   //! @return relative deflection for the edge.
41   Standard_EXPORT static Standard_Real RelativeEdgeDeflection (
42     const TopoDS_Edge&  theEdge,
43     const Standard_Real theDeflection,
44     const Standard_Real theMaxShapeSize,
45     Standard_Real&      theAdjustmentCoefficient);
46
47   //! Computes and updates deflection of the given discrete edge.
48   Standard_EXPORT static void ComputeDeflection (
49     const IMeshData::IEdgeHandle& theDEdge,
50     const Standard_Real           theMaxShapeSize,
51     const IMeshTools_Parameters&  theParameters);
52
53   //! Computes and updates deflection of the given discrete wire.
54   Standard_EXPORT static void ComputeDeflection (
55     const IMeshData::IWireHandle& theDWire,
56     const IMeshTools_Parameters&  theParameters);
57
58   //! Computes and updates deflection of the given discrete face.
59   Standard_EXPORT static void ComputeDeflection (
60     const IMeshData::IFaceHandle& theDFace,
61     const IMeshTools_Parameters&  theParameters);
62
63   DEFINE_STANDARD_RTTI_INLINE(BRepMesh_Deflection, Standard_Transient)
64 };
65
66 #endif