0031458: Visualization - refine classes across Prs3d and StdPrs packages
[occt.git] / src / StdPrs / StdPrs_ToolTriangulatedShape.hxx
1 // Copyright (c) 2013 OPEN CASCADE SAS
2 //
3 // This file is part of Open CASCADE Technology software library.
4 //
5 // This library is free software; you can redistribute it and/or modify it under
6 // the terms of the GNU Lesser General Public License version 2.1 as published
7 // by the Free Software Foundation, with special exception defined in the file
8 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
9 // distribution for complete text of the license and disclaimer of any warranty.
10 //
11 // Alternatively, this file may be used under the terms of Open CASCADE
12 // commercial license or contractual agreement.
13
14 #ifndef _StdPrs_ToolTriangulatedShape_HeaderFile
15 #define _StdPrs_ToolTriangulatedShape_HeaderFile
16
17 #include <Poly_Connect.hxx>
18 #include <Poly_Triangulation.hxx>
19 #include <Prs3d_Drawer.hxx>
20 #include <Standard.hxx>
21 #include <Standard_Macro.hxx>
22 #include <TColgp_Array1OfDir.hxx>
23
24 class TopoDS_Face;
25 class TopLoc_Location;
26 class TopoDS_Shape;
27 class Prs3d_Drawer;
28 class Poly_Triangulation;
29 class Poly_Connect;
30
31 class StdPrs_ToolTriangulatedShape
32 {
33 public:
34
35   //! Similar to BRepTools::Triangulation() but without extra checks.
36   //! @return true if all faces within shape are triangulated.
37   Standard_EXPORT static Standard_Boolean IsTriangulated (const TopoDS_Shape& theShape);
38
39   //! Checks back faces visibility for specified shape (to activate back-face culling). <br>
40   //! @return true if shape is closed manifold Solid or compound of such Solids. <br>
41   Standard_EXPORT static Standard_Boolean IsClosed (const TopoDS_Shape& theShape);
42
43   //! Computes nodal normals for Poly_Triangulation structure using UV coordinates and surface.
44   //! Does nothing if triangulation already defines normals.
45   //! @param theFace [in] the face
46   //! @param theTris [in] the definition of a face triangulation
47   static void ComputeNormals (const TopoDS_Face& theFace,
48                               const Handle(Poly_Triangulation)& theTris)
49   {
50     Poly_Connect aPolyConnect;
51     ComputeNormals (theFace, theTris, aPolyConnect);
52   }
53
54   //! Computes nodal normals for Poly_Triangulation structure using UV coordinates and surface.
55   //! Does nothing if triangulation already defines normals.
56   //! @param theFace [in] the face
57   //! @param theTris [in] the definition of a face triangulation
58   //! @param thePolyConnect [in,out] optional, initialized tool for exploring triangulation
59   Standard_EXPORT static void ComputeNormals (const TopoDS_Face& theFace,
60                                               const Handle(Poly_Triangulation)& theTris,
61                                               Poly_Connect& thePolyConnect);
62
63   //! Evaluate normals for a triangle of a face.
64   //! @param theFace [in] the face.
65   //! @param thePolyConnect [in] the definition of a face triangulation.
66   //! @param theNormal [out] the array of normals for each triangle.
67   Standard_EXPORT static void Normal (const TopoDS_Face& theFace,
68                                       Poly_Connect& thePolyConnect,
69                                       TColgp_Array1OfDir& theNormals);
70
71   //! Computes the absolute deflection value depending on the type of deflection in theDrawer:
72   //! <ul>
73   //! <li><b>Aspect_TOD_RELATIVE</b>: the absolute deflection is computed using the relative
74   //! deviation coefficient from theDrawer and the shape's bounding box;</li>
75   //! <li><b>Aspect_TOD_ABSOLUTE</b>: the maximal chordial deviation from theDrawer is returned.</li>
76   //! </ul>
77   //! In case of the type of deflection in theDrawer computed relative deflection for shape is stored as absolute deflection.
78   //! It is necessary to use it later on for sub-shapes.
79   //! This function should always be used to compute the deflection value for building
80   //! discrete representations of the shape (triangualtion, wireframe) to avoid incosistencies
81   //! between different representations of the shape and undesirable visual artifacts.
82   Standard_EXPORT static Standard_Real GetDeflection (const TopoDS_Shape& theShape,
83                                                       const Handle(Prs3d_Drawer)& theDrawer);
84
85   //! Checks whether the shape is properly triangulated for a given display settings.
86   //! @param theShape [in] the shape.
87   //! @param theDrawer [in] the display settings.
88   Standard_EXPORT static Standard_Boolean IsTessellated (const TopoDS_Shape& theShape,
89                                                          const Handle(Prs3d_Drawer)& theDrawer);
90
91   //! Validates triangulation within the shape and performs tessellation if necessary.
92   //! @param theShape [in] the shape.
93   //! @param theDrawer [in] the display settings.
94   //! @return true if tesselation was recomputed and false otherwise.
95   Standard_EXPORT static Standard_Boolean Tessellate (const TopoDS_Shape& theShape,
96                                                       const Handle(Prs3d_Drawer)& theDrawer);
97
98   //! If presentation has own deviation coefficient and IsAutoTriangulation() is true,
99   //! function will compare actual coefficients with previous values and will clear triangulation on their change
100   //! (regardless actual tessellation quality).
101   //! Function is placed here for compatibility reasons - new code should avoid using IsAutoTriangulation().
102   //! @param theShape  [in] the shape
103   //! @param theDrawer [in] the display settings
104   //! @param theToResetCoeff [in] updates coefficients in theDrawer to actual state to avoid redundant recomputations
105   Standard_EXPORT static void ClearOnOwnDeflectionChange (const TopoDS_Shape& theShape,
106                                                           const Handle(Prs3d_Drawer)& theDrawer,
107                                                           const Standard_Boolean theToResetCoeff);
108
109 };
110
111 #endif