0025442: Visualization, TKOpenGl - prevent inclusion of system header glxext.h
[occt.git] / src / OpenGl / OpenGl_Structure.hxx
index 2d72030..24ce516 100644 (file)
@@ -27,6 +27,8 @@
 #include <OpenGl_Group.hxx>
 #include <OpenGl_Matrix.hxx>
 #include <OpenGl_NamedStatus.hxx>
+#include <OpenGl_Vec.hxx>
+#include <OpenGl_Workspace.hxx>
 
 #include <NCollection_List.hxx>
 #include <InterfaceGraphic_Graphic3d.hxx>
@@ -36,45 +38,77 @@ class OpenGl_GraphicDriver;
 
 typedef NCollection_List<const OpenGl_Structure* > OpenGl_ListOfStructure;
 
+//! Implementation of low-level graphic structure.
 class OpenGl_Structure : public Graphic3d_CStructure
 {
   friend class OpenGl_Group;
 
 public:
 
+  //! Auxiliary wrapper to iterate OpenGl_Group sequence.
+  class GroupIterator
+  {
+
+  public:
+    GroupIterator (const Graphic3d_SequenceOfGroup& theGroups) : myIter (theGroups) {}
+    Standard_Boolean More() const     { return myIter.More(); }
+    void Next()                       { myIter.Next(); }
+    const OpenGl_Group* Value() const { return (const OpenGl_Group* )(myIter.Value().operator->()); }
+    OpenGl_Group*       ChangeValue() { return (OpenGl_Group* )(myIter.ChangeValue().operator->()); }
+
+  private:
+    Graphic3d_SequenceOfGroup::Iterator myIter;
+
+  };
+
+public:
+
   //! Create empty structure
-  OpenGl_Structure (const Handle(Graphic3d_StructureManager)& theManager);
+  Standard_EXPORT OpenGl_Structure (const Handle(Graphic3d_StructureManager)& theManager);
 
   //! Setup structure graphic state
-  virtual void UpdateNamedStatus();
+  Standard_EXPORT virtual void UpdateNamedStatus();
 
   //! Clear graphic data
-  virtual void Clear();
+  Standard_EXPORT virtual void Clear();
 
   //! Connect other structure to this one
-  virtual void Connect    (Graphic3d_CStructure& theStructure);
+  Standard_EXPORT virtual void Connect    (Graphic3d_CStructure& theStructure);
 
   //! Disconnect other structure to this one
-  virtual void Disconnect (Graphic3d_CStructure& theStructure);
+  Standard_EXPORT virtual void Disconnect (Graphic3d_CStructure& theStructure);
 
   //! Synchronize structure aspects
-  virtual void UpdateAspects();
+  Standard_EXPORT virtual void UpdateAspects();
 
   //! Synchronize structure transformation
-  virtual void UpdateTransformation();
+  Standard_EXPORT virtual void UpdateTransformation();
 
   //! Highlight entire structure with color
-  virtual void HighlightWithColor  (const Graphic3d_Vec3&  theColor,
-                                    const Standard_Boolean theToCreate);
+  Standard_EXPORT virtual void HighlightWithColor (const Graphic3d_Vec3&  theColor,
+                                                   const Standard_Boolean theToCreate);
 
   //! Highlight structure using boundary box
-  virtual void HighlightWithBndBox (const Standard_Boolean theToCreate);
+  Standard_EXPORT virtual void HighlightWithBndBox (const Handle(Graphic3d_Structure)& theStruct,
+                                                    const Standard_Boolean             theToCreate);
 
   //! Create shadow link to this structure
-  virtual Handle(Graphic3d_CStructure) ShadowLink (const Handle(Graphic3d_StructureManager)& theManager) const;
+  Standard_EXPORT virtual Handle(Graphic3d_CStructure) ShadowLink (const Handle(Graphic3d_StructureManager)& theManager) const;
+
+  //! Create new group within this structure
+  Standard_EXPORT virtual Handle(Graphic3d_Group) NewGroup (const Handle(Graphic3d_Structure)& theStruct);
+
+  //! Remove group from this structure
+  Standard_EXPORT virtual void RemoveGroup (const Handle(Graphic3d_Group)& theGroup);
 
 public:
 
+  //! @return graphic groups
+  virtual const Graphic3d_SequenceOfGroup& DrawGroups() const
+  {
+    return myGroups;
+  }
+
   //! Access graphic driver
   OpenGl_GraphicDriver* GlDriver() const
   {
@@ -88,31 +122,59 @@ public:
   void SetAspectMarker (const CALL_DEF_CONTEXTMARKER& theAspect);
   void SetAspectText   (const CALL_DEF_CONTEXTTEXT &theAspect);
 
-  void SetHighlightBox (const Handle(OpenGl_Context)& theGlCtx,
-                        const CALL_DEF_BOUNDBOX& theBoundBox);
+  void clearHighlightBox (const Handle(OpenGl_Context)& theGlCtx);
 
-  void ClearHighlightBox (const Handle(OpenGl_Context)& theGlCtx);
-
-  void SetHighlightColor (const Handle(OpenGl_Context)& theGlCtx,
+  void setHighlightColor (const Handle(OpenGl_Context)& theGlCtx,
                           const Graphic3d_Vec3&         theColor);
 
-  void ClearHighlightColor (const Handle(OpenGl_Context)& theGlCtx);
+  void clearHighlightColor (const Handle(OpenGl_Context)& theGlCtx);
 
   Standard_Boolean IsVisible() const { return !(myNamedStatus & OPENGL_NS_HIDE); }
 
-  OpenGl_Group* AddGroup();
-  void RemoveGroup (const Handle(OpenGl_Context)& theGlCtx,
-                    const OpenGl_Group*           theGroup);
-  void Clear (const Handle(OpenGl_Context)& theGlCtx);
+  Standard_EXPORT void Clear (const Handle(OpenGl_Context)& theGlCtx);
 
   //! Set z layer ID to display the structure in specified layer
-  void SetZLayer (const Standard_Integer theLayerIndex);
+  Standard_EXPORT void SetZLayer (const Standard_Integer theLayerIndex);
 
   //! Get z layer ID
-  Standard_Integer GetZLayer () const;
+  Standard_EXPORT Standard_Integer GetZLayer() const;
+
+  //! Renders groups of structure without applying any attributes (i.e. transform, material etc).
+  virtual void RenderGeometry  (const Handle(OpenGl_Workspace)& theWorkspace) const;
 
+  //! Renders the structure.
   virtual void Render  (const Handle(OpenGl_Workspace)& theWorkspace) const;
-  virtual void Release (const Handle(OpenGl_Context)&   theGlCtx);
+
+  //! Releases structure resources.
+  virtual void Release (const Handle(OpenGl_Context)& theGlCtx);
+
+  //! Marks structure as not overlapping view volume (as it is by default).
+  void ResetCullingStatus() const
+  {
+    if (!IsAlwaysRendered())
+    {
+      myIsCulled = Standard_True;
+    }
+  }
+
+  //! Marks structure as overlapping the current view volume one.
+  //! The method is called during traverse of BVH tree.
+  void MarkAsNotCulled() const { myIsCulled = Standard_False; }
+
+  //! Returns Standard_False if the structure hits the current view volume, otherwise
+  //! returns Standard_True. The default value for all structures before each traverse
+  //! of BVH tree is Standard_True.
+  Standard_Boolean IsCulled() const { return myIsCulled; }
+
+  //! Checks if the structure should be included into BVH tree or not.
+  const Standard_Boolean IsAlwaysRendered() const
+  {
+    return IsInfinite
+        || IsForHighlight
+        || IsMutable
+        || Is2dText
+        || TransformPersistence.Flag != 0;
+  }
 
   //! This method releases GL resources without actual elements destruction.
   //! As result structure could be correctly destroyed layer without GL context
@@ -120,10 +182,7 @@ public:
   //!
   //! Notice however that reusage of this structure after calling this method is incorrect
   //! and will lead to broken visualization due to loosed data.
-  void ReleaseGlResources (const Handle(OpenGl_Context)& theGlCtx);
-
-  //! Returns list of OpenGL groups.
-  virtual const OpenGl_ListOfGroup& Groups() const { return myGroups; }
+  Standard_EXPORT void ReleaseGlResources (const Handle(OpenGl_Context)& theGlCtx);
 
   //! Returns list of connected OpenGL structures.
   const OpenGl_ListOfStructure& ConnectedStructures() const { return myConnected; }
@@ -137,8 +196,6 @@ public:
   //! Returns OpenGL persistent translation.
   const TEL_TRANSFORM_PERSISTENCE* PersistentTranslation() const { return myTransPers; }
 
-#ifdef HAVE_OPENCL
-
   //! Returns structure modification state (for ray-tracing).
   Standard_Size ModificationState() const { return myModificationState; }
 
@@ -148,13 +205,9 @@ public:
   //! Is the structure ray-tracable (contains ray-tracable elements)?
   Standard_Boolean IsRaytracable() const { return myIsRaytracable; }
 
-#endif
-
 protected:
 
-  virtual ~OpenGl_Structure();
-
-#ifdef HAVE_OPENCL
+  Standard_EXPORT virtual ~OpenGl_Structure();
 
   //! Registers ancestor connected structure (for updating ray-tracing state).
   void RegisterAncestorStructure (const OpenGl_Structure* theStructure) const;
@@ -174,8 +227,6 @@ protected:
   //! Sets ray-tracable status for structure and its parents.
   void SetRaytracableWithAncestorStructures() const;
 
-#endif
-
 protected:
 
   OpenGl_Matrix*             myTransformation;
@@ -185,20 +236,21 @@ protected:
   OpenGl_AspectMarker*       myAspectMarker;
   OpenGl_AspectText*         myAspectText;
 
-  OpenGl_Group*              myHighlightBox;
+  Handle(OpenGl_Group)       myHighlightBox;
   TEL_COLOUR*                myHighlightColor;
 
   int                        myNamedStatus;
   int                        myZLayer;
 
   OpenGl_ListOfStructure           myConnected;
-  OpenGl_ListOfGroup               myGroups;
 
-#ifdef HAVE_OPENCL
   mutable OpenGl_ListOfStructure   myAncestorStructures;
   mutable Standard_Boolean         myIsRaytracable;
   mutable Standard_Size            myModificationState;
-#endif
+
+  mutable Standard_Boolean         myIsCulled; //!< A status specifying is structure needs to be rendered after BVH tree traverse.
+
+  Standard_Boolean                 myIsMirrored; //!< Used to tell OpenGl to interpret polygons in clockwise order.
 
 public: