0024637: Visualization - clean up implementation of rendering in immediate mode
[occt.git] / src / V3d / V3d_Viewer_4.cxx
index 38591f2..4d1a1a1 100644 (file)
 // Alternatively, this file may be used under the terms of Open CASCADE
 // commercial license or contractual agreement.
 
-/***********************************************************************
-     FONCTION :
-     ----------
-        Classe V3d_Viewer :
-     HISTORIQUE DES MODIFICATIONS   :
-     --------------------------------
-      16-07-98 : CAL ; S3892. Ajout grilles 3d.
-      22-09-98 : CAL ; Erreur de compilation sur WNT dans V3d_Viewer_4.cxx.
-
-************************************************************************/
-
-#define IMP200100      //GG 
-//                     -> Add GridDrawMode() method.
-//                     -> Compute the case Aspect_TDM_None
-//                        in ActivateGrid(..)
-
-#define IMP240100      //GG
-//                     -> Add SetGridEcho() & GridEcho() methods
-//                     -> Add ShowGridEcho() private method.
-
-#define OCC281          //SAV added new field to store grid echo aspect
-
-/*----------------------------------------------------------------------*/
-/*
- * Includes
- */
 #include <V3d_Viewer.jxx>
 
-/*----------------------------------------------------------------------*/
-
-Handle(Aspect_Grid) V3d_Viewer::Grid () const {
-
-       if (myGridType == Aspect_GT_Circular)
-               return myCGrid; 
-       else if (myGridType == Aspect_GT_Rectangular)
-                    return myRGrid;
-            else
-                    return myRGrid;
+#include <Graphic3d_ArrayOfPoints.hxx>
+#include <Visual3d_View.hxx>
+
+// =======================================================================
+// function : Grid
+// purpose  :
+// =======================================================================
+Handle(Aspect_Grid) V3d_Viewer::Grid() const
+{
+  switch (myGridType)
+  {
+    case Aspect_GT_Circular:    return myCGrid;
+    case Aspect_GT_Rectangular: return myRGrid;
+  }
+  return myRGrid;
 }
 
-Aspect_GridType V3d_Viewer::GridType () const {
-
-       return myGridType;
+// =======================================================================
+// function : GridType
+// purpose  :
+// =======================================================================
+Aspect_GridType V3d_Viewer::GridType() const
+{
+  return myGridType;
 }
 
-#ifdef IMP200100
-Aspect_GridDrawMode V3d_Viewer::GridDrawMode () const {
-
-       return Grid()->DrawMode();
+// =======================================================================
+// function : GridDrawMode
+// purpose  :
+// =======================================================================
+Aspect_GridDrawMode V3d_Viewer::GridDrawMode() const
+{
+  return Grid()->DrawMode();
 }
-#endif
 
-void V3d_Viewer::ActivateGrid (const Aspect_GridType aType, const Aspect_GridDrawMode aMode) {
-
-       Grid ()->Erase ();
-       myGridType = aType;
-       Grid ()->SetDrawMode (aMode);
-#ifdef IMP200100
-       if( aMode != Aspect_GDM_None ) Grid ()->Display ();
-#else
-       Grid ()->Display ();
-#endif
-       Grid ()->Activate ();
-       for (InitActiveViews (); MoreActiveViews (); NextActiveViews ()) {
-               ActiveView ()->SetGrid (myPrivilegedPlane, Grid ());
-#ifndef IMP200100      //Do nothing more than the previous Grid()->Activate()
-               ActiveView ()->SetGridActivity (Standard_True);
-#endif
-       }
-       Update ();
+// =======================================================================
+// function : ActivateGrid
+// purpose  :
+// =======================================================================
+void V3d_Viewer::ActivateGrid (const Aspect_GridType     theType,
+                               const Aspect_GridDrawMode theMode)
+{
+  Grid()->Erase();
+  myGridType = theType;
+  Grid()->SetDrawMode (theMode);
+  if (theMode != Aspect_GDM_None)
+  {
+    Grid()->Display();
+  }
+  Grid()->Activate();
+  for (InitActiveViews(); MoreActiveViews(); NextActiveViews())
+  {
+    ActiveView()->SetGrid (myPrivilegedPlane, Grid());
+  }
+  Update();
 }
 
-void V3d_Viewer::DeactivateGrid () {
-
-       Grid ()->Erase ();
-       myGridType = Aspect_GT_Rectangular;
-       Grid ()->Deactivate ();
-       for (InitActiveViews (); MoreActiveViews (); NextActiveViews ()) {
-               ActiveView ()->SetGridActivity (Standard_False);
-       }
-       Update ();
+// =======================================================================
+// function : DeactivateGrid
+// purpose  :
+// =======================================================================
+void V3d_Viewer::DeactivateGrid()
+{
+  Grid()->Erase();
+  myGridType = Aspect_GT_Rectangular;
+  Grid()->Deactivate();
+  for (InitActiveViews(); MoreActiveViews(); NextActiveViews())
+  {
+    ActiveView()->SetGridActivity (Standard_False);
+    if (myGridEcho
+    && !myGridEchoStructure.IsNull())
+    {
+      ActiveView()->View()->EraseImmediate (myGridEchoStructure);
+    }
+  }
+  Update();
 }
 
-Standard_Boolean V3d_Viewer::IsActive () const {
-
-       return Grid ()->IsActive ();
+// =======================================================================
+// function : IsActive
+// purpose  :
+// =======================================================================
+Standard_Boolean V3d_Viewer::IsActive() const
+{
+  return Grid()->IsActive();
 }
 
-void V3d_Viewer::RectangularGridValues (Quantity_Length& theXOrigin, Quantity_Length& theYOrigin, Quantity_Length& theXStep, Quantity_Length& theYStep, Quantity_PlaneAngle& theRotationAngle) const {
+// =======================================================================
+// function : RectangularGridValues
+// purpose  :
+// =======================================================================
+void V3d_Viewer::RectangularGridValues (Quantity_Length&     theXOrigin,
+                                        Quantity_Length&     theYOrigin,
+                                        Quantity_Length&     theXStep,
+                                        Quantity_Length&     theYStep,
+                                        Quantity_PlaneAngle& theRotationAngle) const
+{
+  theXOrigin       = myRGrid->XOrigin();
+  theYOrigin       = myRGrid->YOrigin();
+  theXStep         = myRGrid->XStep();
+  theYStep         = myRGrid->YStep();
+  theRotationAngle = myRGrid->RotationAngle();
+}
 
-       theXOrigin = myRGrid->XOrigin ();
-       theYOrigin = myRGrid->YOrigin ();
-       theXStep = myRGrid->XStep ();
-       theYStep = myRGrid->YStep ();
-       theRotationAngle = myRGrid->RotationAngle ();
+// =======================================================================
+// function : SetRectangularGridValues
+// purpose  :
+// =======================================================================
+void V3d_Viewer::SetRectangularGridValues (const Quantity_Length     theXOrigin,
+                                           const Quantity_Length     theYOrigin,
+                                           const Quantity_Length     theXStep,
+                                           const Quantity_Length     theYStep,
+                                           const Quantity_PlaneAngle theRotationAngle)
+{
+  myRGrid->SetGridValues (theXOrigin, theYOrigin, theXStep, theYStep, theRotationAngle);
+  for (InitActiveViews(); MoreActiveViews(); NextActiveViews())
+  {
+    ActiveView()->SetGrid (myPrivilegedPlane, myRGrid);
+  }
+  Update();
 }
 
-void V3d_Viewer::SetRectangularGridValues (const Quantity_Length theXOrigin, const Quantity_Length theYOrigin, const Quantity_Length theXStep, const Quantity_Length theYStep, const Quantity_PlaneAngle theRotationAngle) {
+// =======================================================================
+// function : CircularGridValues
+// purpose  :
+// =======================================================================
+void V3d_Viewer::CircularGridValues (Quantity_Length&     theXOrigin,
+                                     Quantity_Length&     theYOrigin,
+                                     Quantity_Length&     theRadiusStep,
+                                     Standard_Integer&    theDivisionNumber,
+                                     Quantity_PlaneAngle& theRotationAngle) const
+{
+  theXOrigin        = myCGrid->XOrigin();
+  theYOrigin        = myCGrid->YOrigin();
+  theRadiusStep     = myCGrid->RadiusStep();
+  theDivisionNumber = myCGrid->DivisionNumber();
+  theRotationAngle  = myCGrid->RotationAngle();
+}
 
-       myRGrid->SetGridValues
-               (theXOrigin, theYOrigin, theXStep, theYStep, theRotationAngle);
-       for (InitActiveViews (); MoreActiveViews (); NextActiveViews ())
-               ActiveView ()->SetGrid (myPrivilegedPlane, myRGrid);
-       Update ();
+// =======================================================================
+// function : SetCircularGridValues
+// purpose  :
+// =======================================================================
+void V3d_Viewer::SetCircularGridValues (const Quantity_Length     theXOrigin,
+                                        const Quantity_Length     theYOrigin,
+                                        const Quantity_Length     theRadiusStep,
+                                        const Standard_Integer    theDivisionNumber,
+                                        const Quantity_PlaneAngle theRotationAngle)
+{
+  myCGrid->SetGridValues (theXOrigin, theYOrigin, theRadiusStep,
+                          theDivisionNumber, theRotationAngle);
+  for (InitActiveViews(); MoreActiveViews(); NextActiveViews())
+  {
+    ActiveView()->SetGrid (myPrivilegedPlane, myCGrid);
+  }
+  Update();
 }
 
-void V3d_Viewer::CircularGridValues (Quantity_Length& theXOrigin, Quantity_Length& theYOrigin, Quantity_Length& theRadiusStep, Standard_Integer& theDivisionNumber, Quantity_PlaneAngle& theRotationAngle) const {
+// =======================================================================
+// function : RectangularGridGraphicValues
+// purpose  :
+// =======================================================================
+void V3d_Viewer::RectangularGridGraphicValues (Quantity_Length& theXSize,
+                                               Quantity_Length& theYSize,
+                                               Quantity_Length& theOffSet) const
+{
+  myRGrid->GraphicValues (theXSize, theYSize, theOffSet);
+}
 
-       theXOrigin = myCGrid->XOrigin ();
-       theYOrigin = myCGrid->YOrigin ();
-       theRadiusStep = myCGrid->RadiusStep ();
-       theDivisionNumber = myCGrid->DivisionNumber ();
-       theRotationAngle = myCGrid->RotationAngle ();
+// =======================================================================
+// function : SetRectangularGridGraphicValues
+// purpose  :
+// =======================================================================
+void V3d_Viewer::SetRectangularGridGraphicValues (const Quantity_Length theXSize,
+                                                  const Quantity_Length theYSize,
+                                                  const Quantity_Length theOffSet)
+{
+  myRGrid->SetGraphicValues (theXSize, theYSize, theOffSet);
+  for (InitActiveViews(); MoreActiveViews(); NextActiveViews())
+  {
+    ActiveView()->SetGridGraphicValues (myRGrid);
+  }
+  Update();
 }
 
-void V3d_Viewer::SetCircularGridValues (const Quantity_Length theXOrigin, const Quantity_Length theYOrigin, const Quantity_Length theRadiusStep, const Standard_Integer theDivisionNumber, const Quantity_PlaneAngle theRotationAngle) {
+// =======================================================================
+// function : CircularGridGraphicValues
+// purpose  :
+// =======================================================================
+void V3d_Viewer::CircularGridGraphicValues (Quantity_Length& theRadius,
+                                            Quantity_Length& theOffSet) const
+{
+  myCGrid->GraphicValues (theRadius, theOffSet);
+}
 
-       myCGrid->SetGridValues
-               (theXOrigin, theYOrigin, theRadiusStep,
-                theDivisionNumber, theRotationAngle);
-       for (InitActiveViews (); MoreActiveViews (); NextActiveViews ())
-               ActiveView ()->SetGrid (myPrivilegedPlane, myCGrid);
-       Update ();
+// =======================================================================
+// function : SetCircularGridGraphicValues
+// purpose  :
+// =======================================================================
+void V3d_Viewer::SetCircularGridGraphicValues (const Quantity_Length theRadius,
+                                               const Quantity_Length theOffSet)
+{
+  myCGrid->SetGraphicValues (theRadius, theOffSet);
+  for (InitActiveViews(); MoreActiveViews(); NextActiveViews())
+  {
+    ActiveView()->SetGridGraphicValues (myCGrid);
+  }
+  Update();
 }
 
-void V3d_Viewer::RectangularGridGraphicValues (Quantity_Length& theXSize, Quantity_Length& theYSize, Quantity_Length& theOffSet) const {
+// =======================================================================
+// function : SetGridEcho
+// purpose  :
+// =======================================================================
+void V3d_Viewer::SetGridEcho (const Standard_Boolean theToShowGrid)
+{
+  if (myGridEcho == theToShowGrid)
+  {
+    return;
+  }
+
+  myGridEcho = theToShowGrid;
+  if (theToShowGrid
+   || myGridEchoStructure.IsNull())
+  {
+    return;
+  }
 
-       myRGrid->GraphicValues (theXSize, theYSize, theOffSet);
+  for (InitActiveViews(); MoreActiveViews(); NextActiveViews())
+  {
+    ActiveView()->View()->EraseImmediate (myGridEchoStructure);
+  }
 }
 
-void V3d_Viewer::SetRectangularGridGraphicValues (const Quantity_Length theXSize, const Quantity_Length theYSize, const Quantity_Length theOffSet) {
+// =======================================================================
+// function : SetGridEcho
+// purpose  :
+// =======================================================================
+void V3d_Viewer::SetGridEcho (const Handle(Graphic3d_AspectMarker3d)& theMarker)
+{
+  if (myGridEchoStructure.IsNull())
+  {
+    myGridEchoStructure = new Graphic3d_Structure (Viewer());
+    myGridEchoGroup     = new Graphic3d_Group (myGridEchoStructure);
+  }
 
-       myRGrid->SetGraphicValues (theXSize, theYSize, theOffSet);
-       for (InitActiveViews (); MoreActiveViews (); NextActiveViews ())
-               ActiveView ()->SetGridGraphicValues (myRGrid);
-       Update ();
+  myGridEchoAspect = theMarker;
+  myGridEchoGroup->SetPrimitivesAspect (theMarker);
 }
 
-void V3d_Viewer::CircularGridGraphicValues (Quantity_Length& theRadius, Quantity_Length& theOffSet) const {
-
-       myCGrid->GraphicValues (theRadius, theOffSet);
+// =======================================================================
+// function : GridEcho
+// purpose  :
+// =======================================================================
+Standard_Boolean V3d_Viewer::GridEcho() const
+{
+  return myGridEcho;
 }
 
-void V3d_Viewer::SetCircularGridGraphicValues (const Quantity_Length theRadius, const Quantity_Length theOffSet) {
+// =======================================================================
+// function : ShowGridEcho
+// purpose  :
+// =======================================================================
+void V3d_Viewer::ShowGridEcho (const Handle(V3d_View)& theView,
+                               const Graphic3d_Vertex& theVertex)
+{
+  if (!myGridEcho)
+  {
+    return;
+  }
 
-       myCGrid->SetGraphicValues (theRadius, theOffSet);
-       for (InitActiveViews (); MoreActiveViews (); NextActiveViews ())
-               ActiveView ()->SetGridGraphicValues (myCGrid);
-       Update ();
-}
+  if (myGridEchoStructure.IsNull())
+  {
+    myGridEchoStructure = new Graphic3d_Structure (Viewer());
+    myGridEchoGroup     = new Graphic3d_Group (myGridEchoStructure);
 
-#ifdef IMP240100
-void V3d_Viewer::SetGridEcho( const Standard_Boolean showGrid ) {
+    myGridEchoAspect    = new Graphic3d_AspectMarker3d (Aspect_TOM_STAR, Quantity_Color (Quantity_NOC_GRAY90), 3.0);
+    myGridEchoGroup->SetPrimitivesAspect (myGridEchoAspect);
+  }
 
-  myGridEcho = showGrid; 
-}
+  if (theVertex.X() == myGridEchoLastVert.X()
+   && theVertex.Y() == myGridEchoLastVert.Y()
+   && theVertex.Z() == myGridEchoLastVert.Z())
+  {
+    return;
+  }
 
-void V3d_Viewer::SetGridEcho( const Handle(Graphic3d_AspectMarker3d)& aMarker ) {
-    if( myGridEchoStructure.IsNull() ) {
-      myGridEchoStructure = new Graphic3d_Structure(Viewer());
-      myGridEchoGroup = new Graphic3d_Group (myGridEchoStructure);
-    }
-#ifdef OCC281
-    myGridEchoAspect = aMarker;
-#endif
-    myGridEchoGroup->SetPrimitivesAspect (aMarker);
-}
+  myGridEchoLastVert = theVertex;
+  myGridEchoGroup->Clear();
+  myGridEchoGroup->SetPrimitivesAspect (myGridEchoAspect);
 
-Standard_Boolean V3d_Viewer::GridEcho() const {
+  Handle(Graphic3d_ArrayOfPoints) anArrayOfPoints = new Graphic3d_ArrayOfPoints (1);
+  anArrayOfPoints->AddVertex (theVertex.X(), theVertex.Y(), theVertex.Z());
+  myGridEchoGroup->AddPrimitiveArray (anArrayOfPoints);
 
-  return myGridEcho;
+  theView->View()->DisplayImmediate (myGridEchoStructure, Standard_True);
 }
 
-#include <Graphic3d_ArrayOfPoints.hxx>
-#include <Visual3d_TransientManager.hxx>
-void V3d_Viewer::ShowGridEcho( const Handle(V3d_View)& aView, 
-                                       const Graphic3d_Vertex& aVertex ) {
-  if( myGridEcho ) {
-    if( myGridEchoStructure.IsNull() ) {
-      myGridEchoStructure = new Graphic3d_Structure(Viewer());
-      myGridEchoGroup = new Graphic3d_Group (myGridEchoStructure);
-#ifdef OCC281
-      myGridEchoAspect = new Graphic3d_AspectMarker3d( Aspect_TOM_STAR, 
-                                                       Quantity_Color( Quantity_NOC_GRAY90 ),
-                                                       3.0 );
-      myGridEchoGroup->SetPrimitivesAspect( myGridEchoAspect );
-#else
-      Handle(Graphic3d_AspectMarker3d) markerAttrib =
-       new Graphic3d_AspectMarker3d(Aspect_TOM_STAR,
-               Quantity_Color(Quantity_NOC_GRAY90),3.0);
-      myGridEchoGroup->SetPrimitivesAspect (markerAttrib);
-#endif
-    }
-
-    static Graphic3d_Vertex lastVertex;
-    if( aVertex.Distance(lastVertex) != 0.0 ) {
-      lastVertex = aVertex;
-      myGridEchoGroup->Clear();
-#ifdef OCC281
-      myGridEchoGroup->SetPrimitivesAspect( myGridEchoAspect );
-#endif
-      Handle(Graphic3d_ArrayOfPoints) anArrayOfPoints = new Graphic3d_ArrayOfPoints (1);
-      anArrayOfPoints->AddVertex (aVertex.X(), aVertex.Y(), aVertex.Z());
-      myGridEchoGroup->AddPrimitiveArray (anArrayOfPoints);
-
-      Visual3d_TransientManager::BeginDraw(
-               aView->View(), Standard_False, Standard_False);
-      Visual3d_TransientManager::DrawStructure (myGridEchoStructure);
-      Visual3d_TransientManager::EndDraw (Standard_True);
-    }
+// =======================================================================
+// function : HideGridEcho
+// purpose  :
+// =======================================================================
+void V3d_Viewer::HideGridEcho (const Handle(V3d_View)& theView)
+{
+  if (myGridEchoStructure.IsNull())
+  {
+    return;
   }
+
+  myGridEchoLastVert.SetCoord (ShortRealLast(), ShortRealLast(), ShortRealLast());
+  theView->View()->EraseImmediate (myGridEchoStructure);
 }
-#endif