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