0024887: Visualization - revise and extend Raytracing controls
[occt.git] / src / ViewerTest / ViewerTest_ViewerCommands.cxx
index 9e3d762..f60b096 100644 (file)
@@ -193,7 +193,7 @@ int Y_Motion = 0;
 int X_ButtonPress = 0; // Last ButtonPress position
 int Y_ButtonPress = 0;
 Standard_Boolean IsDragged = Standard_False;
-Standard_Boolean DragFirst;
+Standard_Boolean DragFirst = Standard_False;
 
 //==============================================================================
 
@@ -1010,6 +1010,22 @@ void ActivateView (const TCollection_AsciiString& theViewName)
   }
 }
 
+//==============================================================================
+//function : RemoveView
+//purpose  :
+//==============================================================================
+void ViewerTest::RemoveView (const Handle(V3d_View)& theView,
+                             const Standard_Boolean  theToRemoveContext)
+{
+  if (!ViewerTest_myViews.IsBound2 (theView))
+  {
+    return;
+  }
+
+  const TCollection_AsciiString aViewName = ViewerTest_myViews.Find2 (theView);
+  RemoveView (aViewName, theToRemoveContext);
+}
+
 //==============================================================================
 //function : RemoveView
 //purpose  : Close and remove view from display, clear maps if neccessary
@@ -1891,24 +1907,16 @@ static LRESULT WINAPI AdvViewerWindowProc( HWND hwnd,
       }
       break;
     case WM_LBUTTONUP:
-      IsDragged = Standard_False;
-      if( !DragFirst )
+      if (!DragFirst)
       {
         HDC hdc = GetDC( hwnd );
         SelectObject( hdc, GetStockObject( HOLLOW_BRUSH ) );
         SetROP2( hdc, R2_NOT );
         Rectangle( hdc, X_ButtonPress, Y_ButtonPress, X_Motion, Y_Motion );
         ReleaseDC( hwnd, hdc );
-
-        const Handle(ViewerTest_EventManager) EM =
-          ViewerTest::CurrentEventManager();
-        if ( fwKeys & MK_SHIFT )
-          EM->ShiftSelect( min( X_ButtonPress, X_Motion ), max( Y_ButtonPress, Y_Motion ),
-          max( X_ButtonPress, X_Motion ), min( Y_ButtonPress, Y_Motion ));
-        else
-          EM->Select( min( X_ButtonPress, X_Motion ), max( Y_ButtonPress, Y_Motion ),
-          max( X_ButtonPress, X_Motion ), min( Y_ButtonPress, Y_Motion ));
+        VT_ProcessButton1Release (fwKeys & MK_SHIFT);
       }
+      IsDragged = Standard_False;
       return ViewerWindowProc( hwnd, Msg, wParam, lParam );
 
     case WM_LBUTTONDOWN:
@@ -2161,7 +2169,7 @@ int ViewerMainLoop(Standard_Integer argc, const char** argv)
   switch (aReport.type) {
       case ClientMessage:
         {
-          if(aReport.xclient.data.l[0] == GetDisplayConnection()->GetAtom(Aspect_XA_DELETE_WINDOW))
+          if((Atom)aReport.xclient.data.l[0] == GetDisplayConnection()->GetAtom(Aspect_XA_DELETE_WINDOW))
           {
             // Close the window
             ViewerTest::RemoveView(FindViewIdByWindowHandle (aReport.xclient.window));
@@ -2534,38 +2542,6 @@ while (ViewerMainLoop( argc, argv)) {
 return 0;
 }
 
-//==============================================================================
-//function : InitViewerTest
-//purpose  : initialisation de toutes les variables static de  ViewerTest (dp)
-//==============================================================================
-
-void ViewerTest_InitViewerTest (const Handle(AIS_InteractiveContext)& theContext)
-{
-  Handle(V3d_Viewer) aViewer = theContext->CurrentViewer();
-  ViewerTest::SetAISContext(theContext);
-  aViewer->InitActiveViews();
-  Handle(V3d_View) aView = aViewer->ActiveView();
-  if (aViewer->MoreActiveViews()) ViewerTest::CurrentView(aView);
-  ViewerTest::ResetEventManager();
-  Handle(Aspect_Window) aWindow = aView->Window();
-#if !defined(_WIN32) && !defined(__WIN32__) && (!defined(__APPLE__) || defined(MACOSX_USE_GLX))
-  // X11
-  VT_GetWindow() = Handle(Xw_Window)::DownCast(aWindow);
-  OSWindowSetup();
-  static int aFirst = 1;
-  if ( aFirst ) {
-#if TCL_MAJOR_VERSION  < 8
-    Tk_CreateFileHandler((void*)XConnectionNumber(GetDisplayConnection()->GetDisplay()),
-      TK_READABLE, VProcessEvents, (ClientData) 0);
-#else
-    Tk_CreateFileHandler(XConnectionNumber(GetDisplayConnection()->GetDisplay()),
-      TK_READABLE, VProcessEvents, (ClientData) 0);
-#endif
-    aFirst = 0;
-  }
-#endif
-}
-
 //==============================================================================
 //function : VSetBg
 //purpose  : Load image as background
@@ -3377,12 +3353,21 @@ static int VZLayer (Draw_Interpretor& di, Standard_Integer argc, const char** ar
   }
   else if (argc < 2)
   {
-    di << "Use: vzlayer " << argv[0];
-    di << " add/del/get [id]\n";
+    di << "Use: vzlayer ";
+    di << " add/del/get/settings/enable/disable [id]\n";
     di << " add - add new z layer to viewer and print its id\n";
     di << " del - del z layer by its id\n";
     di << " get - print sequence of z layers in increasing order of their overlay level\n";
-    di << "id - the layer identificator value defined when removing z layer\n";
+    di << " settings - print status of z layer settings\n";
+    di << " enable ([depth]test/[depth]write/[depth]clear/[depth]offset) \n    enables given setting for the z layer\n";
+    di << " enable (p[ositive]offset/n[egative]offset) \n    enables given setting for the z layer\n";
+    di << " disable ([depth]test/[depth]write/[depth]clear/[depth]offset) \n    disables given setting for the z layer\n";
+    di << "\nWhere id is the layer identificator\n";
+    di << "\nExamples:\n";
+    di << "   vzlayer add\n";
+    di << "   vzlayer enable poffset 1\n";
+    di << "   vzlayer disable depthtest 1\n";
+    di << "   vzlayer del 1\n";
     return 1;
   }
 
@@ -3434,9 +3419,123 @@ static int VZLayer (Draw_Interpretor& di, Standard_Integer argc, const char** ar
 
     di << "\n";
   }
+  else if (anOp == "settings")
+  {
+    if (argc < 3)
+    {
+      di << "Please also provide an id\n";
+      return 1;
+    }
+
+    Standard_Integer anId = Draw::Atoi (argv[2]);
+    Graphic3d_ZLayerSettings aSettings = aViewer->ZLayerSettings (anId);
+
+    di << "Depth test - " << (aSettings.IsSettingEnabled (Graphic3d_ZLayerDepthTest) ? "enabled" : "disabled") << "\n";
+    di << "Depth write - " << (aSettings.IsSettingEnabled (Graphic3d_ZLayerDepthWrite) ? "enabled" : "disabled") << "\n";
+    di << "Depth buffer clearing - " << (aSettings.IsSettingEnabled (Graphic3d_ZLayerDepthClear) ? "enabled" : "disabled") << "\n";
+    di << "Depth offset - " << (aSettings.IsSettingEnabled (Graphic3d_ZLayerDepthOffset) ? "enabled" : "disabled") << "\n";
+
+  }
+  else if (anOp == "enable")
+  {
+    if (argc < 3)
+    {
+      di << "Please also provide an option to enable\n";
+      return 1;
+    }
+
+    if (argc < 4)
+    {
+      di << "Please also provide a layer id\n";
+      return 1;
+    }
+
+    TCollection_AsciiString aSubOp = TCollection_AsciiString (argv[2]);
+    Standard_Integer anId = Draw::Atoi (argv[3]);
+    Graphic3d_ZLayerSettings aSettings = aViewer->ZLayerSettings (anId);
+
+    if (aSubOp == "depthtest" || aSubOp == "test")
+    {
+      aSettings.EnableSetting (Graphic3d_ZLayerDepthTest);
+    }
+    else if (aSubOp == "depthwrite" || aSubOp == "write")
+    {
+      aSettings.EnableSetting (Graphic3d_ZLayerDepthWrite);
+    }
+    else if (aSubOp == "depthclear" || aSubOp == "clear")
+    {
+      aSettings.EnableSetting (Graphic3d_ZLayerDepthClear);
+    }
+    else if (aSubOp == "depthoffset" || aSubOp == "offset")
+    {
+      if (argc < 6)
+      {
+        di << "Please also provide a factor and units values for depth offset\n";
+        di << "Format is: vzlayer enable offset [factor] [units] [layerId]\n";
+        return 1;
+      }
+
+      Standard_ShortReal aFactor = static_cast<Standard_ShortReal> (Draw::Atof (argv[3]));
+      Standard_ShortReal aUnits  = static_cast<Standard_ShortReal> (Draw::Atof (argv[4]));
+      anId = Draw::Atoi (argv[5]);
+      aSettings = aViewer->ZLayerSettings (anId);
+
+      aSettings.DepthOffsetFactor = aFactor;
+      aSettings.DepthOffsetUnits  = aUnits;
+
+      aSettings.EnableSetting (Graphic3d_ZLayerDepthOffset);
+    }
+    else if (aSubOp == "positiveoffset" || aSubOp == "poffset")
+    {
+      aSettings.SetDepthOffsetPositive();
+    }
+    else if (aSubOp == "negativeoffset" || aSubOp == "noffset")
+    {
+      aSettings.SetDepthOffsetNegative();
+    }
+
+    aViewer->SetZLayerSettings (anId, aSettings);
+  }
+  else if (anOp == "disable")
+  {
+    if (argc < 3)
+    {
+      di << "Please also provide an option to disable\n";
+      return 1;
+    }
+
+    if (argc < 4)
+    {
+      di << "Please also provide a layer id\n";
+      return 1;
+    }
+
+    TCollection_AsciiString aSubOp = TCollection_AsciiString (argv[2]);
+    Standard_Integer anId = Draw::Atoi (argv[3]);
+    Graphic3d_ZLayerSettings aSettings = aViewer->ZLayerSettings (anId);
+
+    if (aSubOp == "depthtest" || aSubOp == "test")
+    {
+      aSettings.DisableSetting (Graphic3d_ZLayerDepthTest);
+    }
+    else if (aSubOp == "depthwrite" || aSubOp == "write")
+    {
+      aSettings.DisableSetting (Graphic3d_ZLayerDepthWrite);
+    }
+    else if (aSubOp == "depthclear" || aSubOp == "clear")
+    {
+      aSettings.DisableSetting (Graphic3d_ZLayerDepthClear);
+    }
+    else if (aSubOp == "depthoffset" || aSubOp == "offset")
+    {
+      aSettings.DisableSetting (Graphic3d_ZLayerDepthOffset);
+    }
+
+    aViewer->SetZLayerSettings (anId, aSettings);
+  }
   else
   {
-    di << "Invalid operation, please use { add / del / get }\n";
+    di << "Invalid operation, please use { add / del / get / settings / enable / disable}\n";
     return 1;
   }
 
@@ -6296,122 +6395,207 @@ static int VLight (Draw_Interpretor& theDi,
   return 0;
 }
 
-
-
-//==============================================================================
-//function : VClInfo
-//purpose  : Prints info about active OpenCL device
-//==============================================================================
-
-static Standard_Integer VClInfo (Draw_Interpretor& theDi,
-                                 Standard_Integer,
-                                 const char**)
+inline Standard_Boolean parseOnOff (Standard_CString  theArg,
+                                    Standard_Boolean& theIsOn)
 {
-  Handle(AIS_InteractiveContext) aContextAIS = ViewerTest::GetAISContext();
-  if (aContextAIS.IsNull())
+  TCollection_AsciiString aFlag (theArg);
+  aFlag.LowerCase();
+  if (aFlag == "on")
   {
-    std::cerr << "Call vinit before!\n";
-    return 1;
+    theIsOn = Standard_True;
+    return Standard_True;
   }
-
-  Handle(OpenGl_GraphicDriver) aDrv = Handle(OpenGl_GraphicDriver)::DownCast (aContextAIS->CurrentViewer()->Driver());
-  Graphic3d_CView* aCView = static_cast<Graphic3d_CView*> (ViewerTest::CurrentView()->View()->CView());
-  NCollection_DataMap<TCollection_AsciiString, TCollection_AsciiString> anInfo;
-  if (aDrv.IsNull()
-   || aCView == NULL
-   || !aDrv->GetOpenClDeviceInfo (*aCView, anInfo))
+  else if (aFlag == "off")
   {
-    theDi << "OpenCL device info is unavailable!\n";
-    return 0;
+    theIsOn = Standard_False;
+    return Standard_True;
   }
-
-  theDi << "OpenCL device info:\n";
-  for (NCollection_DataMap<TCollection_AsciiString, TCollection_AsciiString>::Iterator anIter (anInfo);
-       anIter.More(); anIter.Next())
-  {
-    theDi << anIter.Key() << ": \t" << anIter.Value() << "\n";
-  }
-  return 0;
+  return Standard_False;
 }
 
 //=======================================================================
-//function : VRaytrace
-//purpose  : Enables/disables OpenCL-based ray-tracing
+//function : VRenderParams
+//purpose  : Enables/disables rendering features
 //=======================================================================
 
-static Standard_Integer VRaytrace (Draw_Interpretor& ,
-                                   Standard_Integer  theArgNb,
-                                   const char**      theArgVec)
+static Standard_Integer VRenderParams (Draw_Interpretor& theDI,
+                                       Standard_Integer  theArgNb,
+                                       const char**      theArgVec)
 {
   Handle(V3d_View) aView = ViewerTest::CurrentView();
   if (aView.IsNull())
   {
-    std::cerr << "Use 'vinit' command before " << theArgVec[0] << "\n";
+    std::cerr << "Error: no active viewer!\n";
     return 1;
   }
 
-  if (theArgNb < 2
-   || Draw::Atoi (theArgVec[1]))
-  {
-    aView->SetRaytracingMode();
-  }
-  else
-  {
-    aView->SetRasterizationMode();
-  }
-  aView->Redraw();
-  return 0;
-}
-
-//=======================================================================
-//function : VSetRaytraceMode
-//purpose  : Enables/disables features of OpenCL-based ray-tracing
-//=======================================================================
+  Graphic3d_RenderingParams& aParams = aView->ChangeRenderingParams();
 
-static Standard_Integer VSetRaytraceMode (Draw_Interpretor&,
-                                          Standard_Integer theArgNb,
-                                          const char ** theArgVec)
-{
-  Handle(V3d_View) aView = ViewerTest::CurrentView();
-  if (aView.IsNull())
-  {
-    std::cerr << "Use 'vinit' command before " << theArgVec[0] << "\n";
-    return 1;
-  }
-  else if (theArgNb < 2)
+  if (theArgNb < 2)
   {
-    std::cerr << "Usage : " << theArgVec[0] << " [shad=0|1] [refl=0|1] [aa=0|1]\n";
-    return 1;
+    theDI << "renderMode:  ";
+    switch (aParams.Method)
+    {
+      case Graphic3d_RM_RASTERIZATION: theDI << "rasterization "; break;
+      case Graphic3d_RM_RAYTRACING:    theDI << "raytrace ";      break;
+    }
+    theDI << "\n";
+    theDI << "fsaa:        " << (aParams.IsAntialiasingEnabled      ? "on" : "off") << "\n";
+    theDI << "shadows:     " << (aParams.IsShadowEnabled            ? "on" : "off") << "\n";
+    theDI << "reflections: " << (aParams.IsReflectionEnabled        ? "on" : "off") << "\n";
+    theDI << "rayDepth:    " <<  aParams.RaytracingDepth                            << "\n";
+    theDI << "gleam:       " << (aParams.IsTransparentShadowEnabled ? "on" : "off") << "\n";
+    return 0;
   }
 
+  Standard_Boolean toPrint = Standard_False;
   for (Standard_Integer anArgIter = 1; anArgIter < theArgNb; ++anArgIter)
   {
-    const TCollection_AsciiString anArg (theArgVec[anArgIter]);
-
-    if (anArg.Search ("shad=") > -1)
+    Standard_CString        anArg (theArgVec[anArgIter]);
+    TCollection_AsciiString aFlag (anArg);
+    aFlag.LowerCase();
+    if (aFlag == "-echo"
+     || aFlag == "-print")
     {
-      if (anArg.Token ("=", 2).IntegerValue() != 0)
-        aView->EnableRaytracedShadows();
-      else
-        aView->DisableRaytracedShadows();
+      toPrint = Standard_True;
     }
-    else if (anArg.Search ("refl=") > -1)
+    else if (aFlag == "-mode"
+          || aFlag == "-rendermode"
+          || aFlag == "-render_mode")
     {
-      if (anArg.Token ("=", 2).IntegerValue() != 0)
-        aView->EnableRaytracedReflections();
+      if (toPrint)
+      {
+        switch (aParams.Method)
+        {
+          case Graphic3d_RM_RASTERIZATION: theDI << "rasterization "; break;
+          case Graphic3d_RM_RAYTRACING:    theDI << "ray-tracing ";   break;
+        }
+        continue;
+      }
       else
-        aView->DisableRaytracedReflections();
+      {
+        std::cerr << "Error: wrong syntax at argument '" << anArg << "'\n";
+        return 1;
+      }
+    }
+    else if (aFlag == "-ray"
+          || aFlag == "-raytrace")
+    {
+      if (toPrint)
+      {
+        theDI << (aParams.Method == Graphic3d_RM_RAYTRACING ? "true" : "false") << " ";
+        continue;
+      }
+
+      aParams.Method = Graphic3d_RM_RAYTRACING;
+    }
+    else if (aFlag == "-rast"
+          || aFlag == "-raster"
+          || aFlag == "-rasterization")
+    {
+      if (toPrint)
+      {
+        theDI << (aParams.Method == Graphic3d_RM_RASTERIZATION ? "true" : "false") << " ";
+        continue;
+      }
+
+      aParams.Method = Graphic3d_RM_RASTERIZATION;
     }
-    else if (anArg.Search ("aa=") > -1)
+    else if (aFlag == "-raydepth"
+          || aFlag == "-ray_depth")
     {
-      if (anArg.Token ("=", 2).IntegerValue() != 0)
-        aView->EnableRaytracedAntialiasing();
+      if (toPrint)
+      {
+        theDI << aParams.RaytracingDepth << " ";
+        continue;
+      }
+      else if (++anArgIter >= theArgNb)
+      {
+        std::cerr << "Error: wrong syntax at argument '" << anArg << "'\n";
+        return 1;
+      }
+
+      const Standard_Integer aDepth = Draw::Atoi (theArgVec[anArgIter]);
+      if (aDepth < 1 || aDepth > 10)
+      {
+        std::cerr << "Error: invalid ray-tracing depth " << aDepth << ". Should be within range [1; 10]\n";
+        return 1;
+      }
       else
-        aView->DisableRaytracedAntialiasing();
+      {
+        aParams.RaytracingDepth = aDepth;
+      }
+    }
+    else if (aFlag == "-shad"
+          || aFlag == "-shadows")
+    {
+      if (toPrint)
+      {
+        theDI << (aParams.IsShadowEnabled ? "on" : "off") << " ";
+        continue;
+      }
+
+      Standard_Boolean toEnable = Standard_True;
+      if (++anArgIter < theArgNb
+      && !parseOnOff (theArgVec[anArgIter], toEnable))
+      {
+        --anArgIter;
+      }
+      aParams.IsShadowEnabled = toEnable;
+    }
+    else if (aFlag == "-refl"
+          || aFlag == "-reflections")
+    {
+      if (toPrint)
+      {
+        theDI << (aParams.IsReflectionEnabled ? "on" : "off") << " ";
+        continue;
+      }
+
+      Standard_Boolean toEnable = Standard_True;
+      if (++anArgIter < theArgNb
+      && !parseOnOff (theArgVec[anArgIter], toEnable))
+      {
+        --anArgIter;
+      }
+      aParams.IsReflectionEnabled = toEnable;
+    }
+    else if (aFlag == "-fsaa")
+    {
+      if (toPrint)
+      {
+        theDI << (aParams.IsAntialiasingEnabled ? "on" : "off") << " ";
+        continue;
+      }
+
+      Standard_Boolean toEnable = Standard_True;
+      if (++anArgIter < theArgNb
+      && !parseOnOff (theArgVec[anArgIter], toEnable))
+      {
+        --anArgIter;
+      }
+      aParams.IsAntialiasingEnabled = toEnable;
+    }
+    else if (aFlag == "-gleam")
+    {
+      if (toPrint)
+      {
+        theDI << (aParams.IsTransparentShadowEnabled ? "on" : "off") << " ";
+        continue;
+      }
+
+      Standard_Boolean toEnable = Standard_True;
+      if (++anArgIter < theArgNb
+      && !parseOnOff (theArgVec[anArgIter], toEnable))
+      {
+        --anArgIter;
+      }
+      aParams.IsTransparentShadowEnabled = toEnable;
     }
     else
     {
-      std::cerr << "Unknown argument: " << anArg << "\n";
+      std::cout << "Error: wrong syntax, unknown flag '" << anArg << "'\n";
+      return 1;
     }
   }
 
@@ -6552,7 +6736,20 @@ void ViewerTest::ViewerCommands(Draw_Interpretor& theCommands)
     "vprintview : width height filename [algo=0] [tile_width tile_height] : Test print algorithm: algo = 0 - stretch, algo = 1 - tile",
     __FILE__,VPrintView,group);
   theCommands.Add("vzlayer",
-    "vzlayer : add/del/get [id] : Z layer operations in v3d viewer: add new z layer, delete z layer, get z layer ids",
+    "vzlayer add/del/get/settings/enable/disable [id]\n"
+    " add - add new z layer to viewer and print its id\n"
+    " del - del z layer by its id\n"
+    " get - print sequence of z layers in increasing order of their overlay level\n"
+    " settings - print status of z layer settings\n"
+    " enable ([depth]test/[depth]write/[depth]clear/[depth]offset) \n    enables given setting for the z layer\n"
+    " enable (p[ositive]offset/n[egative]offset) \n    enables given setting for the z layer\n"
+    " disable ([depth]test/[depth]write/[depth]clear/[depth]offset) \n    disables given setting for the z layer\n"
+    "\nWhere id is the layer identificator\n"
+    "\nExamples:\n"
+    "   vzlayer add\n"
+    "   vzlayer enable poffset 1\n"
+    "   vzlayer disable depthtest 1\n"
+    "   vzlayer del 1\n",
     __FILE__,VZLayer,group);
   theCommands.Add("voverlaytext",
     "voverlaytext : text x y [height] [font_name] [text_color: R G B] [display_type] [background_color: R G B]"
@@ -6761,13 +6958,14 @@ void ViewerTest::ViewerCommands(Draw_Interpretor& theCommands)
     "\n\n        example: vlight add positional head 1 pos 0 1 1 color red"
     "\n        example: vlight change 0 direction 0 -1 0 linearAttenuation 0.2",
     __FILE__, VLight, group);
-  theCommands.Add("vraytrace",
-    "vraytrace 0|1",
-    __FILE__,VRaytrace,group);
-  theCommands.Add("vclinfo",
-    "vclinfo",
-    __FILE__,VClInfo,group);
-  theCommands.Add("vsetraytracemode",
-    "vsetraytracemode [shad=0|1] [refl=0|1] [aa=0|1]",
-    __FILE__,VSetRaytraceMode,group);
+  theCommands.Add("vrenderparams",
+    "\n    Manages rendering parameters: "
+    "\n      '-rayTrace'            Enables  GPU ray-tracing"
+    "\n      '-raster'              Disables GPU ray-tracing"
+    "\n      '-rayDepth    0..10'   Defines maximum ray-tracing depth"
+    "\n      '-shadows     on|off'  Enables/disables shadows rendering"
+    "\n      '-reflections on|off'  Enables/disables specular reflections"
+    "\n      '-fsaa        on|off'  Enables/disables adaptive anti-aliasing"
+    "\n      '-gleam       on|off'  Enables/disables transparency shadow effects",
+    __FILE__, VRenderParams, group);
 }