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