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