1c41e9e92e9fa2b085d2f0d6e920110f8555b7f4
[occt.git] / src / OpenGl / OpenGl_CappingAlgo.hxx
1 // Created on: 2013-09-05
2 // Created by: Anton POLETAEV
3 // Copyright (c) 2013-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _OpenGl_CappingAlgo_H__
17 #define _OpenGl_CappingAlgo_H__
18
19 #include <OpenGl_RenderFilter.hxx>
20 #include <OpenGl_Group.hxx>
21
22 #include <Graphic3d_SequenceOfGroup.hxx>
23
24 // Forward declaration
25
26 DEFINE_STANDARD_HANDLE (OpenGl_CappingAlgoFilter, OpenGl_RenderFilter)
27
28 //! Capping surface rendering algorithm.
29 class OpenGl_CappingAlgo
30 {
31 public:
32
33   //! Draw capping surfaces by OpenGl for the clipping planes
34   //! enabled in current context state. Depth buffer must be generated
35   //! for the passed groups.
36   //! @param theWorkspace [in] the GL workspace, context state.
37   //! @param theGroups [in] the group of primitives to be capped.
38   Standard_EXPORT static void RenderCapping (const Handle(OpenGl_Workspace)&  theWorkspace,
39                                              const Graphic3d_SequenceOfGroup& theGroups);
40
41   //! Render infinite capping plane.
42   //! @param theWorkspace [in] the GL workspace, context state.
43   //! @param thePlane [in] the graphical plane, for which the capping surface is rendered.
44   Standard_EXPORT static void RenderPlane (const Handle(OpenGl_Workspace)& theWorkspace,
45                                            const Handle(Graphic3d_ClipPlane)& thePlane);
46 };
47
48 //! Graphical capping rendering algorithm filter.
49 //! Filters out everything excepth shaded primitives.
50 class OpenGl_CappingAlgoFilter : public OpenGl_RenderFilter
51 {
52 public:
53
54   //! Default constructor.
55   OpenGl_CappingAlgoFilter() {}
56
57   //! Checks whether the element can be rendered or not.
58   //! @param theElement [in] the element to check.
59   //! @return True if element can be rendered.
60   virtual Standard_Boolean CanRender (const OpenGl_Element* theElement);
61
62 public:
63
64   DEFINE_STANDARD_RTTI(OpenGl_CappingAlgoFilter, OpenGl_RenderFilter)
65 };
66
67 #endif