0031458: Visualization - refine classes across Prs3d and StdPrs packages
[occt.git] / src / StdPrs / StdPrs_ToolTriangulatedShape.cxx
1 // Created on: 1993-10-27
2 // Created by: Jean-LOuis FRENKEL
3 // Copyright (c) 1993-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 #include <StdPrs_ToolTriangulatedShape.hxx>
18
19 #include <BRepBndLib.hxx>
20 #include <BRepMesh_DiscretFactory.hxx>
21 #include <BRepMesh_DiscretRoot.hxx>
22 #include <BRepTools.hxx>
23 #include <BRep_Tool.hxx>
24 #include <GeomAbs_SurfaceType.hxx>
25 #include <GeomLib.hxx>
26 #include <gp_XYZ.hxx>
27 #include <Poly.hxx>
28 #include <Poly_Connect.hxx>
29 #include <Poly_Triangulation.hxx>
30 #include <Precision.hxx>
31 #include <Prs3d.hxx>
32 #include <Prs3d_Drawer.hxx>
33 #include <TColgp_Array1OfPnt.hxx>
34 #include <TColgp_Array1OfPnt2d.hxx>
35 #include <TopAbs_Orientation.hxx>
36 #include <TopLoc_Location.hxx>
37 #include <TShort_HArray1OfShortReal.hxx>
38 #include <TShort_Array1OfShortReal.hxx>
39 #include <TopExp_Explorer.hxx>
40 #include <TopoDS.hxx>
41 #include <TopoDS_Face.hxx>
42
43 //=======================================================================
44 //function : IsTriangulated
45 //purpose  :
46 //=======================================================================
47 Standard_Boolean StdPrs_ToolTriangulatedShape::IsTriangulated (const TopoDS_Shape& theShape)
48 {
49   TopLoc_Location aLocDummy;
50   for (TopExp_Explorer aFaceIter (theShape, TopAbs_FACE); aFaceIter.More(); aFaceIter.Next())
51   {
52     const TopoDS_Face&                aFace = TopoDS::Face (aFaceIter.Current());
53     const Handle(Poly_Triangulation)& aTri  = BRep_Tool::Triangulation (aFace, aLocDummy);
54     if (aTri.IsNull())
55     {
56       return Standard_False;
57     }
58   }
59   return Standard_True;
60 }
61
62 //=======================================================================
63 //function : IsClosed
64 //purpose  :
65 //=======================================================================
66 Standard_Boolean StdPrs_ToolTriangulatedShape::IsClosed (const TopoDS_Shape& theShape)
67 {
68   if (theShape.IsNull())
69   {
70     return Standard_True;
71   }
72
73   switch (theShape.ShapeType())
74   {
75     case TopAbs_COMPOUND:
76     case TopAbs_COMPSOLID:
77     default:
78     {
79       // check that compound consists of closed solids
80       for (TopoDS_Iterator anIter (theShape); anIter.More(); anIter.Next())
81       {
82         const TopoDS_Shape& aShape = anIter.Value();
83         if (!IsClosed (aShape))
84         {
85           return Standard_False;
86         }
87       }
88       return Standard_True;
89     }
90     case TopAbs_SOLID:
91     {
92       // Check for non-manifold topology first of all:
93       // have to use BRep_Tool::IsClosed() because it checks the face connectivity
94       // inside the shape
95       if (!BRep_Tool::IsClosed (theShape))
96         return Standard_False;
97
98       for (TopoDS_Iterator anIter (theShape); anIter.More(); anIter.Next())
99       {
100         const TopoDS_Shape& aShape = anIter.Value();
101         if (aShape.IsNull())
102         {
103           continue;
104         }
105
106         if (aShape.ShapeType() == TopAbs_FACE)
107         {
108           // invalid solid
109           return Standard_False;
110         }
111         else if (!IsTriangulated (aShape))
112         {
113           // mesh contains holes
114           return Standard_False;
115         }
116       }
117       return Standard_True;
118     }
119     case TopAbs_SHELL:
120     case TopAbs_FACE:
121     {
122       // free faces / shell are not allowed
123       return Standard_False;
124     }
125     case TopAbs_WIRE:
126     case TopAbs_EDGE:
127     case TopAbs_VERTEX:
128     {
129       // ignore
130       return Standard_True;
131     }
132   }
133 }
134
135 //=======================================================================
136 //function : ComputeNormals
137 //purpose  :
138 //=======================================================================
139 void StdPrs_ToolTriangulatedShape::ComputeNormals (const TopoDS_Face& theFace,
140                                                    const Handle(Poly_Triangulation)& theTris,
141                                                    Poly_Connect& thePolyConnect)
142 {
143   if (theTris.IsNull()
144    || theTris->HasNormals())
145   {
146     return;
147   }
148
149   // take in face the surface location
150   const TopoDS_Face    aZeroFace = TopoDS::Face (theFace.Located (TopLoc_Location()));
151   Handle(Geom_Surface) aSurf     = BRep_Tool::Surface (aZeroFace);
152   const Poly_Array1OfTriangle& aTriangles = theTris->Triangles();
153   if (!theTris->HasUVNodes() || aSurf.IsNull())
154   {
155     // compute normals by averaging triangulation normals sharing the same vertex
156     Poly::ComputeNormals (theTris);
157     return;
158   }
159
160   const Standard_Real aTol = Precision::Confusion();
161   Handle(TShort_HArray1OfShortReal) aNormals = new TShort_HArray1OfShortReal (1, theTris->NbNodes() * 3);
162   const TColgp_Array1OfPnt2d& aNodesUV = theTris->UVNodes();
163   Standard_Integer aTri[3];
164   const TColgp_Array1OfPnt& aNodes = theTris->Nodes();
165   gp_Dir aNorm;
166   for (Standard_Integer aNodeIter = aNodes.Lower(); aNodeIter <= aNodes.Upper(); ++aNodeIter)
167   {
168     // try to retrieve normal from real surface first, when UV coordinates are available
169     if (GeomLib::NormEstim (aSurf, aNodesUV.Value (aNodeIter), aTol, aNorm) > 1)
170     {
171       if (thePolyConnect.Triangulation() != theTris)
172       {
173         thePolyConnect.Load (theTris);
174       }
175
176       // compute flat normals
177       gp_XYZ eqPlan (0.0, 0.0, 0.0);
178       for (thePolyConnect.Initialize (aNodeIter); thePolyConnect.More(); thePolyConnect.Next())
179       {
180         aTriangles (thePolyConnect.Value()).Get (aTri[0], aTri[1], aTri[2]);
181         const gp_XYZ v1 (aNodes (aTri[1]).Coord() - aNodes (aTri[0]).Coord());
182         const gp_XYZ v2 (aNodes (aTri[2]).Coord() - aNodes (aTri[1]).Coord());
183         const gp_XYZ vv = v1 ^ v2;
184         const Standard_Real aMod = vv.Modulus();
185         if (aMod >= aTol)
186         {
187           eqPlan += vv / aMod;
188         }
189       }
190       const Standard_Real aModMax = eqPlan.Modulus();
191       aNorm = (aModMax > aTol) ? gp_Dir (eqPlan) : gp::DZ();
192     }
193
194     const Standard_Integer anId = (aNodeIter - aNodes.Lower()) * 3;
195     aNormals->SetValue (anId + 1, (Standard_ShortReal )aNorm.X());
196     aNormals->SetValue (anId + 2, (Standard_ShortReal )aNorm.Y());
197     aNormals->SetValue (anId + 3, (Standard_ShortReal )aNorm.Z());
198   }
199   theTris->SetNormals (aNormals);
200 }
201
202 //=======================================================================
203 //function : Normal
204 //purpose  :
205 //=======================================================================
206 void StdPrs_ToolTriangulatedShape::Normal (const TopoDS_Face&  theFace,
207                                            Poly_Connect&       thePolyConnect,
208                                            TColgp_Array1OfDir& theNormals)
209 {
210   const Handle(Poly_Triangulation)& aPolyTri = thePolyConnect.Triangulation();
211   if (!aPolyTri->HasNormals())
212   {
213     ComputeNormals (theFace, aPolyTri, thePolyConnect);
214   }
215
216   const TColgp_Array1OfPnt&       aNodes   = aPolyTri->Nodes();
217   const TShort_Array1OfShortReal& aNormals = aPolyTri->Normals();
218   const Standard_ShortReal*       aNormArr = &aNormals.First();
219   for (Standard_Integer aNodeIter = aNodes.Lower(); aNodeIter <= aNodes.Upper(); ++aNodeIter)
220   {
221     const Standard_Integer anId = 3 * (aNodeIter - aNodes.Lower());
222     const gp_Dir aNorm (aNormArr[anId + 0],
223                         aNormArr[anId + 1],
224                         aNormArr[anId + 2]);
225     theNormals (aNodeIter) = aNorm;
226   }
227
228   if (theFace.Orientation() == TopAbs_REVERSED)
229   {
230     for (Standard_Integer aNodeIter = aNodes.Lower(); aNodeIter <= aNodes.Upper(); ++aNodeIter)
231     {
232       theNormals.ChangeValue (aNodeIter).Reverse();
233     }
234   }
235 }
236
237 //=======================================================================
238 //function : GetDeflection
239 //purpose  :
240 //=======================================================================
241 Standard_Real StdPrs_ToolTriangulatedShape::GetDeflection (const TopoDS_Shape& theShape,
242                                                            const Handle(Prs3d_Drawer)& theDrawer)
243 {
244   if (theDrawer->TypeOfDeflection() != Aspect_TOD_RELATIVE)
245   {
246     return theDrawer->MaximalChordialDeviation();
247   }
248
249   Bnd_Box aBndBox;
250   BRepBndLib::Add (theShape, aBndBox, Standard_False);
251   if (aBndBox.IsVoid())
252   {
253     return theDrawer->MaximalChordialDeviation();
254   }
255   else if (aBndBox.IsOpen())
256   {
257     if (!aBndBox.HasFinitePart())
258     {
259       return theDrawer->MaximalChordialDeviation();
260     }
261     aBndBox = aBndBox.FinitePart();
262   }
263
264   // store computed relative deflection of shape as absolute deviation coefficient in case relative type to use it later on for sub-shapes
265   const Standard_Real aDeflection = Prs3d::GetDeflection (aBndBox, theDrawer->DeviationCoefficient(), theDrawer->MaximalChordialDeviation());
266   theDrawer->SetMaximalChordialDeviation (aDeflection);
267   return aDeflection;
268 }
269
270 //=======================================================================
271 //function : IsTessellated
272 //purpose  :
273 //=======================================================================
274 Standard_Boolean StdPrs_ToolTriangulatedShape::IsTessellated (const TopoDS_Shape&         theShape,
275                                                               const Handle(Prs3d_Drawer)& theDrawer)
276 {
277   return BRepTools::Triangulation (theShape, GetDeflection (theShape, theDrawer), true);
278 }
279
280 // =======================================================================
281 // function : Tessellate
282 // purpose  :
283 // =======================================================================
284 Standard_Boolean StdPrs_ToolTriangulatedShape::Tessellate (const TopoDS_Shape&         theShape,
285                                                            const Handle(Prs3d_Drawer)& theDrawer)
286 {
287   Standard_Boolean wasRecomputed = Standard_False;
288   // Check if it is possible to avoid unnecessary recomputation of shape triangulation
289   if (IsTessellated (theShape, theDrawer))
290   {
291     return wasRecomputed;
292   }
293
294   const Standard_Real aDeflection = GetDeflection (theShape, theDrawer);
295
296   // retrieve meshing tool from Factory
297   Handle(BRepMesh_DiscretRoot) aMeshAlgo = BRepMesh_DiscretFactory::Get().Discret (theShape,
298                                                                                    aDeflection,
299                                                                                    theDrawer->DeviationAngle());
300   if (!aMeshAlgo.IsNull())
301   {
302     aMeshAlgo->Perform();
303     wasRecomputed = Standard_True;
304   }
305
306   return wasRecomputed;
307 }
308
309 // =======================================================================
310 // function : ClearOnOwnDeflectionChange
311 // purpose  :
312 // =======================================================================
313 void StdPrs_ToolTriangulatedShape::ClearOnOwnDeflectionChange (const TopoDS_Shape&         theShape,
314                                                                const Handle(Prs3d_Drawer)& theDrawer,
315                                                                const Standard_Boolean      theToResetCoeff)
316 {
317   if (!theDrawer->IsAutoTriangulation()
318     || theShape.IsNull())
319   {
320     return;
321   }
322
323   const Standard_Boolean isOwnDeviationAngle       = theDrawer->HasOwnDeviationAngle();
324   const Standard_Boolean isOwnDeviationCoefficient = theDrawer->HasOwnDeviationCoefficient();
325   const Standard_Real anAngleNew  = theDrawer->DeviationAngle();
326   const Standard_Real anAnglePrev = theDrawer->PreviousDeviationAngle();
327   const Standard_Real aCoeffNew   = theDrawer->DeviationCoefficient();
328   const Standard_Real aCoeffPrev  = theDrawer->PreviousDeviationCoefficient();
329   if ((!isOwnDeviationAngle       || Abs (anAngleNew - anAnglePrev) <= Precision::Angular())
330    && (!isOwnDeviationCoefficient || Abs (aCoeffNew  - aCoeffPrev)  <= Precision::Confusion()))
331   {
332     return;
333   }
334
335   BRepTools::Clean (theShape);
336   if (theToResetCoeff)
337   {
338     theDrawer->UpdatePreviousDeviationAngle();
339     theDrawer->UpdatePreviousDeviationCoefficient();
340   }
341 }