0024023: Revamp the OCCT Handle -- general
[occt.git] / src / OpenGl / OpenGl_AspectLine.hxx
1 // Created on: 2011-07-13
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_AspectLine_Header
17 #define _OpenGl_AspectLine_Header
18
19 #include <TCollection_AsciiString.hxx>
20
21 #include <InterfaceGraphic_Graphic3d.hxx>
22 #include <Aspect_TypeOfLine.hxx>
23 #include <Graphic3d_CAspectLine.hxx>
24 #include <OpenGl_Element.hxx>
25
26 class OpenGl_ShaderProgram;
27
28 class OpenGl_AspectLine : public OpenGl_Element
29 {
30 public:
31
32   Standard_EXPORT OpenGl_AspectLine();
33
34   Standard_EXPORT OpenGl_AspectLine (const OpenGl_AspectLine &AnOther);
35
36   Standard_EXPORT void SetAspect (const CALL_DEF_CONTEXTLINE& theAspect);
37
38   const TEL_COLOUR&  Color() const { return myColor; }
39   TEL_COLOUR&        ChangeColor() { return myColor; }
40   Aspect_TypeOfLine  Type()  const { return myType; }
41   float              Width() const { return myWidth; }
42
43   //! Init and return OpenGl shader program resource.
44   //! @return shader program resource.
45   const Handle(OpenGl_ShaderProgram)& ShaderProgramRes (const Handle(OpenGl_Context)& theCtx) const
46   {
47     if (!myResources.IsShaderReady())
48     {
49       myResources.BuildShader (theCtx, myShaderProgram);
50       myResources.SetShaderReady();
51     }
52
53     return myResources.ShaderProgram;
54   }
55
56   Standard_EXPORT virtual void Render  (const Handle(OpenGl_Workspace)& theWorkspace) const;
57   Standard_EXPORT virtual void Release (OpenGl_Context* theContext);
58
59 protected:
60
61   TEL_COLOUR                      myColor;
62   Aspect_TypeOfLine               myType;
63   float                           myWidth;
64   Handle(Graphic3d_ShaderProgram) myShaderProgram;
65
66 protected:
67
68   //! OpenGl resources
69   mutable struct Resources
70   {
71   public:
72     Resources() : myIsShaderReady (Standard_False) {}
73
74     Standard_Boolean IsShaderReady() const { return myIsShaderReady; }
75     void SetShaderReady()       { myIsShaderReady = Standard_True; }
76     void ResetShaderReadiness() { myIsShaderReady = Standard_False; }
77
78     Standard_EXPORT void BuildShader (const Handle(OpenGl_Context)&          theCtx,
79                                       const Handle(Graphic3d_ShaderProgram)& theShader);
80
81     Handle(OpenGl_ShaderProgram) ShaderProgram;
82     TCollection_AsciiString      ShaderProgramId;
83
84   private:
85
86     Standard_Boolean myIsShaderReady;
87
88   } myResources;
89
90  public:
91   DEFINE_STANDARD_ALLOC
92 };
93
94 #endif //_OpenGl_AspectLine_Header