0025442: Visualization, TKOpenGl - prevent inclusion of system header glxext.h
[occt.git] / src / OpenGl / OpenGl_Element.hxx
1 // Created on: 2011-08-05
2 // Created by: Sergey ZERCHANINOV
3 // Copyright (c) 2011-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_Element_Header
17 #define OpenGl_Element_Header
18
19 #include <Handle_OpenGl_Context.hxx>
20 #include <Handle_OpenGl_Workspace.hxx>
21 #include <OpenGl_RenderFilter.hxx>
22
23 //! Base interface for drawable elements.
24 class OpenGl_Element
25 {
26 public:
27
28   Standard_EXPORT OpenGl_Element();
29
30   virtual void Render (const Handle(OpenGl_Workspace)& theWorkspace) const = 0;
31
32   //! Release GPU resources.
33   //! Pointer to the context is used because this method might be called
34   //! when the context is already being destroyed and usage of a handle
35   //! would be unsafe
36   virtual void Release (OpenGl_Context* theContext) = 0;
37
38   //! Pointer to the context is used because this method might be called
39   //! when the context is already being destroyed and usage of a handle
40   //! would be unsafe
41   template <typename theResource_t>
42   static void Destroy (OpenGl_Context* theContext,
43                        theResource_t*& theElement)
44   {
45     if (theElement == NULL)
46     {
47       return;
48     }
49
50     theElement->Release (theContext);
51     OpenGl_Element* anElement = theElement;
52     delete anElement;
53     theElement = NULL;
54   }
55
56 public:
57
58   //! Render element if it passes the filtering procedure. This method should
59   //! be used for elements which can be used in scope of rendering algorithms.
60   //! E.g. elements of groups during recursive rendering.
61   //! If render filter is null, pure rendering is performed.
62   //! @param theWorkspace [in] the rendering workspace.
63   //! @param theFilter [in] the rendering filter to check whether the element
64   //! should be rendered or not.
65   //! @return True if element passes the filering check and is rendered.
66   inline Standard_Boolean
67     RenderFiltered (const Handle(OpenGl_Workspace)& theWorkspace,
68                     const Handle(OpenGl_RenderFilter)& theFilter) const
69   {
70     if (!theFilter.IsNull() && !theFilter->CanRender (this))
71     {
72       return Standard_False;
73     }
74
75     Render (theWorkspace);
76
77     return Standard_True;
78   }
79
80 protected:
81
82   Standard_EXPORT virtual ~OpenGl_Element();
83
84 public:
85
86   DEFINE_STANDARD_ALLOC
87
88 };
89
90 #endif // OpenGl_Element_Header