0024001: Stereographic rendering support
[occt.git] / src / OpenGl / OpenGl_Structure.hxx
index 5b1f513..520a784 100644 (file)
@@ -1,21 +1,17 @@
 // Created on: 2011-08-01
 // Created by: Sergey ZERCHANINOV
-// Copyright (c) 2011-2012 OPEN CASCADE SAS
+// Copyright (c) 2011-2014 OPEN CASCADE SAS
 //
-// The content of this file is subject to the Open CASCADE Technology Public
-// License Version 6.5 (the "License"). You may not use the content of this file
-// except in compliance with the License. Please obtain a copy of the License
-// at http://www.opencascade.org and read it completely before using this file.
+// This file is part of Open CASCADE Technology software library.
 //
-// The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-// main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
+// This library is free software; you can redistribute it and / or modify it
+// under the terms of the GNU Lesser General Public version 2.1 as published
+// by the Free Software Foundation, with special exception defined in the file
+// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
+// distribution for complete text of the license and disclaimer of any warranty.
 //
-// The Original Code and all software distributed under the License is
-// distributed on an "AS IS" basis, without warranty of any kind, and the
-// Initial Developer hereby disclaims all such warranties, including without
-// limitation, any warranties of merchantability, fitness for a particular
-// purpose or non-infringement. Please see the License for the specific terms
-// and conditions governing the rights and limitations under the License.
+// Alternatively, this file may be used under the terms of Open CASCADE
+// commercial license or contractual agreement.
 
 #ifndef OpenGl_Structure_Header
 #define OpenGl_Structure_Header
 
 #include <OpenGl_Group.hxx>
 #include <OpenGl_Matrix.hxx>
+#include <OpenGl_NamedStatus.hxx>
+
+#include <Graphic3d_SequenceOfHClipPlane.hxx>
 
 class OpenGl_Structure;
 
 typedef NCollection_List<const OpenGl_Structure* > OpenGl_ListOfStructure;
-typedef NCollection_List<const OpenGl_Group*     > OpenGl_ListOfGroup;
 
 class OpenGl_Structure : public OpenGl_Element
 {
+  friend class OpenGl_Group;
 
 public:
 
@@ -47,16 +46,13 @@ public:
 
   void SetTransformPersistence (const CALL_DEF_TRANSFORM_PERSISTENCE &ATransPers);
 
-  void SetDegenerateModel (const Standard_Integer AMode, const float ASkipRatio);
-
-  void SetAspectLine (const CALL_DEF_CONTEXTLINE &AContext);
-  void SetAspectFace (const Handle(OpenGl_Context)&   theCtx,
-                      const CALL_DEF_CONTEXTFILLAREA& theAspect);
-  void SetAspectMarker (const CALL_DEF_CONTEXTMARKER &AContext);
-  void SetAspectText (const CALL_DEF_CONTEXTTEXT &AContext);
+  void SetAspectLine   (const CALL_DEF_CONTEXTLINE &theAspect);
+  void SetAspectFace   (const CALL_DEF_CONTEXTFILLAREA& theAspect);
+  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);
+                        const CALL_DEF_BOUNDBOX& theBoundBox);
 
   void ClearHighlightBox (const Handle(OpenGl_Context)& theGlCtx);
 
@@ -67,7 +63,11 @@ public:
 
   void ClearHighlightColor (const Handle(OpenGl_Context)& theGlCtx);
 
-  void SetNamedStatus (const Standard_Integer aStatus) { myNamedStatus = aStatus; }
+  void SetNamedStatus (const Standard_Integer aStatus);
+
+  Standard_Boolean IsVisible() const { return !(myNamedStatus & OPENGL_NS_HIDE); }
+
+  void SetClipPlanes (const Graphic3d_SequenceOfHClipPlane& thePlanes) { myClipPlanes = thePlanes; }
 
   void Connect (const OpenGl_Structure *astructure);
   void Disconnect (const OpenGl_Structure *astructure);
@@ -87,23 +87,72 @@ public:
   virtual void Release (const Handle(OpenGl_Context)&   theGlCtx);
 
   //! This method releases GL resources without actual elements destruction.
-  //! As result structure could be correctly destroyed layter without GL context
+  //! As result structure could be correctly destroyed layer without GL context
   //! (after last window was closed for example).
   //!
   //! 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.
+  const OpenGl_ListOfGroup& Groups() const { return myGroups; }
+
+  //! Returns list of connected OpenGL structures.
+  const OpenGl_ListOfStructure& ConnectedStructures() const { return myConnected; }
+
+  //! Returns OpenGL face aspect.
+  const OpenGl_AspectFace* AspectFace() const { return myAspectFace; }
+
+  //! Returns OpenGL transformation matrix.
+  const OpenGl_Matrix* Transformation() const { return myTransformation; }
+  
+  //! 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; }
+
+  //! Resets structure modification state (for ray-tracing)
+  void ResetModificationState() const { myModificationState = 0; }
+
+  //! Is the structure ray-tracable (contains ray-tracable elements)?
+  Standard_Boolean IsRaytracable() const { return myIsRaytracable; }
+
+#endif
+
 protected:
 
   virtual ~OpenGl_Structure();
 
+#ifdef HAVE_OPENCL
+
+  //! Registers ancestor connected structure (for updating ray-tracing state).
+  void RegisterAncestorStructure (const OpenGl_Structure* theStructure) const;
+
+  //! Unregisters ancestor connected structure (for updating ray-tracing state).
+  void UnregisterAncestorStructure (const OpenGl_Structure* theStructure) const;
+
+  //! Unregisters structure from ancestor structure (for updating ray-tracing state).
+  void UnregisterFromAncestorStructure() const;
+
+  //! Updates modification state for structure and its parents.
+  void UpdateStateWithAncestorStructures() const;
+
+  //! Updates ray-tracable status for structure and its parents.
+  void UpdateRaytracableWithAncestorStructures() const;
+
+  //! Sets ray-tracable status for structure and its parents.
+  void SetRaytracableWithAncestorStructures() const;
+
+#endif
+
 protected:
 
   //Structure_LABBegin
   OpenGl_Matrix*             myTransformation;
   TEL_TRANSFORM_PERSISTENCE* myTransPers;
-  DEGENERATION*              myDegenerateModel;
   OpenGl_AspectLine*         myAspectLine;
   OpenGl_AspectFace*         myAspectFace;
   OpenGl_AspectMarker*       myAspectMarker;
@@ -116,8 +165,15 @@ protected:
   int                        myNamedStatus; //Structure_LABNameSet
   int                        myZLayer;
 
-  OpenGl_ListOfStructure     myConnected;
-  OpenGl_ListOfGroup         myGroups;
+  OpenGl_ListOfStructure           myConnected;
+  OpenGl_ListOfGroup               myGroups;
+  Graphic3d_SequenceOfHClipPlane   myClipPlanes;
+
+#ifdef HAVE_OPENCL
+  mutable OpenGl_ListOfStructure   myAncestorStructures;
+  mutable Standard_Boolean         myIsRaytracable;
+  mutable Standard_Size            myModificationState;
+#endif
 
 public: