0027130: Visualization, Ray tracing - skip structures with transformation persistence...
[occt.git] / src / OpenGl / OpenGl_Group.hxx
1 // Created on: 2011-08-01
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_Group_Header
17 #define _OpenGl_Group_Header
18
19 #include <Graphic3d_Group.hxx>
20 #include <Graphic3d_Structure.hxx>
21
22 #include <NCollection_List.hxx>
23 #include <OpenGl_Aspects.hxx>
24 #include <OpenGl_Element.hxx>
25
26 class OpenGl_Group;
27 class OpenGl_Structure;
28
29 struct OpenGl_ElementNode
30 {
31   OpenGl_Element*     elem;
32   OpenGl_ElementNode* next;
33   DEFINE_STANDARD_ALLOC
34 };
35
36 //! Implementation of low-level graphic group.
37 class OpenGl_Group : public Graphic3d_Group
38 {
39 public:
40
41   //! Create empty group.
42   //! Will throw exception if not created by OpenGl_Structure.
43   Standard_EXPORT OpenGl_Group (const Handle(Graphic3d_Structure)& theStruct);
44
45   Standard_EXPORT virtual void Clear (const Standard_Boolean theToUpdateStructureMgr) Standard_OVERRIDE;
46
47   //! Return line aspect.
48   virtual Handle(Graphic3d_Aspects) Aspects() const Standard_OVERRIDE
49   {
50     return myAspects != NULL
51          ? myAspects->Aspect()
52          : Handle(Graphic3d_Aspects)();
53   }
54
55   //! Return TRUE if group contains primitives with transform persistence.
56   bool HasPersistence() const { return myStructure != NULL && !myStructure->TransformPersistence().IsNull(); }
57
58   //! Update aspect.
59   Standard_EXPORT virtual void SetGroupPrimitivesAspect (const Handle(Graphic3d_Aspects)& theAspect) Standard_OVERRIDE;
60
61   //! Append aspect as an element.
62   Standard_EXPORT virtual void SetPrimitivesAspect (const Handle(Graphic3d_Aspects)& theAspect) Standard_OVERRIDE;
63
64   //! Update presentation aspects after their modification.
65   Standard_EXPORT virtual void SynchronizeAspects() Standard_OVERRIDE;
66
67   //! Replace aspects specified in the replacement map.
68   Standard_EXPORT virtual void ReplaceAspects (const Graphic3d_MapOfAspectsToAspects& theMap) Standard_OVERRIDE;
69
70   //! Add primitive array element
71   Standard_EXPORT virtual void AddPrimitiveArray (const Graphic3d_TypeOfPrimitiveArray theType,
72                                                   const Handle(Graphic3d_IndexBuffer)& theIndices,
73                                                   const Handle(Graphic3d_Buffer)&      theAttribs,
74                                                   const Handle(Graphic3d_BoundBuffer)& theBounds,
75                                                   const Standard_Boolean               theToEvalMinMax) Standard_OVERRIDE;
76
77   //! Adds a text for display
78   Standard_EXPORT virtual void AddText (const Handle(Graphic3d_Text)& theTextParams,
79                                         const Standard_Boolean theToEvalMinMax) Standard_OVERRIDE;
80   //! Add flipping element
81   Standard_EXPORT virtual void SetFlippingOptions (const Standard_Boolean theIsEnabled,
82                                                    const gp_Ax2&          theRefPlane) Standard_OVERRIDE;
83
84   //! Add stencil test element
85   Standard_EXPORT virtual void SetStencilTestOptions (const Standard_Boolean theIsEnabled) Standard_OVERRIDE;
86
87 public:
88
89   OpenGl_Structure* GlStruct() const { return (OpenGl_Structure* )(myStructure->CStructure().operator->()); }
90
91   Standard_EXPORT void AddElement (OpenGl_Element* theElem);
92
93   Standard_EXPORT virtual void Render  (const Handle(OpenGl_Workspace)& theWorkspace) const;
94   Standard_EXPORT virtual void Release (const Handle(OpenGl_Context)&   theGlCtx);
95
96   //! Returns first OpenGL element node of the group.
97   const OpenGl_ElementNode* FirstNode() const { return myFirst; }
98
99   //! Returns OpenGL aspect.
100   const OpenGl_Aspects* GlAspects() const { return myAspects; }
101
102   //! Is the group ray-tracable (contains ray-tracable elements)?
103   Standard_Boolean IsRaytracable() const { return myIsRaytracable; }
104
105   //! Dumps the content of me into the stream
106   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
107
108 protected:
109
110   Standard_EXPORT virtual ~OpenGl_Group();
111
112 private:
113
114   //! Render element if it passes the filtering procedure.
115   //! This method should be used for elements which can be used in scope of rendering algorithms.
116   //! E.g. elements of groups during recursive rendering.
117   //! If render filter is null, pure rendering is performed.
118   //! @param theWorkspace [in] the rendering workspace
119   //! @param theFilter    [in] the rendering filter to check whether the element should be rendered or not
120   //! @return True if element passes the check and renders
121   Standard_EXPORT bool renderFiltered (const Handle(OpenGl_Workspace)& theWorkspace,
122                                        OpenGl_Element* theElement) const;
123
124 protected:
125
126   OpenGl_Aspects*     myAspects;
127   OpenGl_ElementNode* myFirst;
128   OpenGl_ElementNode* myLast;
129   Standard_Boolean    myIsRaytracable;
130
131 public:
132
133   DEFINE_STANDARD_RTTIEXT(OpenGl_Group,Graphic3d_Group) // Type definition
134
135 };
136
137 DEFINE_STANDARD_HANDLE(OpenGl_Group, Graphic3d_Group)
138
139 #endif // _OpenGl_Group_Header