0030675: Visualization - remove redundant proxy classes in hierarchy of PrsMgr_Presen...
[occt.git] / src / StdPrs / StdPrs_ShadedShape.hxx
1 // Created on: 1993-09-23
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 #ifndef _StdPrs_ShadedShape_HeaderFile
18 #define _StdPrs_ShadedShape_HeaderFile
19
20 #include <GeomAbs_Shape.hxx>
21 #include <Prs3d_Root.hxx>
22 #include <Prs3d_Drawer.hxx>
23 #include <StdPrs_Volume.hxx>
24
25 class Graphic3d_ArrayOfSegments;
26 class Graphic3d_ArrayOfTriangles;
27 class TopoDS_Shape;
28 class gp_Pnt2d;
29 class BRep_Builder;
30 class TopoDS_Compound;
31
32 //! Auxiliary procedures to prepare Shaded presentation of specified shape.
33 class StdPrs_ShadedShape : public Prs3d_Root
34 {
35 public:
36   
37   //! Shades <theShape>.
38   //! @param theVolumeType defines the way how to interpret input shapes - as Closed volumes (to activate back-face
39   //! culling and capping plane algorithms), as Open volumes (shells or solids with holes)
40   //! or to perform Autodetection (would split input shape into two groups)
41   Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& thePresentation, const TopoDS_Shape& theShape, const Handle(Prs3d_Drawer)& theDrawer, const StdPrs_Volume theVolume = StdPrs_Volume_Autodetection);
42   
43   //! Shades <theShape> with texture coordinates.
44   //! @param theVolumeType defines the way how to interpret input shapes - as Closed volumes (to activate back-face
45   //! culling and capping plane algorithms), as Open volumes (shells or solids with holes)
46   //! or to perform Autodetection (would split input shape into two groups)
47   Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& thePresentation, const TopoDS_Shape& theShape, const Handle(Prs3d_Drawer)& theDrawer, const Standard_Boolean theHasTexels, const gp_Pnt2d& theUVOrigin, const gp_Pnt2d& theUVRepeat, const gp_Pnt2d& theUVScale, const StdPrs_Volume theVolume = StdPrs_Volume_Autodetection);
48   
49   //! Searches closed and unclosed subshapes in shape structure and puts them
50   //! into two compounds for separate processing of closed and unclosed sub-shapes
51   Standard_EXPORT static void ExploreSolids (const TopoDS_Shape& theShape, const BRep_Builder& theBuilder, TopoDS_Compound& theClosed, TopoDS_Compound& theOpened, const Standard_Boolean theIgnore1DSubShape);
52
53   //! Computes wireframe presentation for free wires and vertices
54   Standard_EXPORT static void AddWireframeForFreeElements (const Handle(Prs3d_Presentation)& thePrs,
55                                                            const TopoDS_Shape&               theShape,
56                                                            const Handle(Prs3d_Drawer)&       theDrawer);
57
58   //! Computes special wireframe presentation for faces without triangulation.
59   Standard_EXPORT static void AddWireframeForFacesWithoutTriangles (const Handle(Prs3d_Presentation)& thePrs,
60                                                                     const TopoDS_Shape&               theShape,
61                                                                     const Handle(Prs3d_Drawer)&       theDrawer);
62
63 public:
64
65   //! Create primitive array with triangles for specified shape.
66   //! @param theShape [in] the shape with precomputed triangulation
67   static Handle(Graphic3d_ArrayOfTriangles) FillTriangles (const TopoDS_Shape& theShape)
68   {
69     gp_Pnt2d aDummy;
70     return FillTriangles (theShape, Standard_False, aDummy, aDummy, aDummy);
71   }
72
73   //! Create primitive array of triangles for specified shape.
74   //! @param theShape     the shape with precomputed triangulation
75   //! @param theHasTexels define UV coordinates in primitive array
76   //! @param theUVOrigin  origin for UV coordinates
77   //! @param theUVRepeat  repeat parameters  for UV coordinates
78   //! @param theUVScale   scale coefficients for UV coordinates
79   //! @return triangles array or NULL if specified face does not have computed triangulation
80   Standard_EXPORT static Handle(Graphic3d_ArrayOfTriangles) FillTriangles (const TopoDS_Shape&    theShape,
81                                                                            const Standard_Boolean theHasTexels,
82                                                                            const gp_Pnt2d&        theUVOrigin,
83                                                                            const gp_Pnt2d&        theUVRepeat,
84                                                                            const gp_Pnt2d&        theUVScale);
85
86   //! Define primitive array of boundary segments for specified shape.
87   //! @param theShape segments array or NULL if specified face does not have computed triangulation
88   //! @param theUpperContinuity the most edge continuity class to be included to result (edges with more continuity will be ignored)
89   Standard_EXPORT static Handle(Graphic3d_ArrayOfSegments) FillFaceBoundaries (const TopoDS_Shape& theShape,
90                                                                                GeomAbs_Shape theUpperContinuity = GeomAbs_CN);
91
92 };
93
94 #endif // _StdPrs_ShadedShape_HeaderFile