0031394: Visualization, TKOpenGl - define OpenGl_Element::EstimatedDataSize() interface
[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 #include <Standard_Type.hxx>
21
22 class OpenGl_Workspace;
23 class OpenGl_Context;
24
25 //! Base interface for drawable elements.
26 class OpenGl_Element
27 {
28 public:
29
30   Standard_EXPORT OpenGl_Element();
31
32   virtual void Render (const Handle(OpenGl_Workspace)& theWorkspace) const = 0;
33
34   //! Release GPU resources.
35   //! Pointer to the context is used because this method might be called
36   //! when the context is already being destroyed and usage of a handle
37   //! would be unsafe
38   virtual void Release (OpenGl_Context* theContext) = 0;
39
40   //! Pointer to the context is used because this method might be called
41   //! when the context is already being destroyed and usage of a handle
42   //! would be unsafe
43   template <typename theResource_t>
44   static void Destroy (OpenGl_Context* theContext,
45                        theResource_t*& theElement)
46   {
47     if (theElement == NULL)
48     {
49       return;
50     }
51
52     theElement->Release (theContext);
53     OpenGl_Element* anElement = theElement;
54     delete anElement;
55     theElement = NULL;
56   }
57
58 public:
59
60   //! Return TRUE if primitive type generates shaded triangulation (to be used in filters).
61   virtual Standard_Boolean IsFillDrawMode() const { return false; }
62
63   //! Returns estimated GPU memory usage for holding data without considering overheads and allocation alignment rules.
64   virtual Standard_Size EstimatedDataSize() const { return 0; }
65
66   //! Update parameters of the drawable elements.
67   virtual void SynchronizeAspects() {}
68
69   //! Dumps the content of me into the stream
70   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
71
72 protected:
73
74   Standard_EXPORT virtual ~OpenGl_Element();
75
76 public:
77
78   DEFINE_STANDARD_ALLOC
79
80 };
81
82 #endif // OpenGl_Element_Header