0024336: Content of OCCT documentation should be updated. Iter 2
[occt.git] / dox / user_guides / draw_test_harness.md
index 406f130..1e0b85a 100644 (file)
@@ -1484,7 +1484,7 @@ vhlrtype  algo_type={algo|polyalgo} [shape_1 ... shape_n]
 Changes the type of HLR algorithm used for shapes.
 If the algo_type is algo, the exact HLR algorithm is used, otherwise the polygonal algorithm is used for defined shapes. 
 
-If no shape is specified through the command arguments, the given HLR algorithm_type is applied to all *AIS_Shape* isntances in the current context, and the command also changes the default HLR algorithm type.
+If no shape is specified through the command arguments, the given HLR algorithm_type is applied to all *AIS_Shape* instances in the current context, and the command also changes the default HLR algorithm type.
 
 **Note** that this command works with instances of *AIS_Shape* or derived classes only, other interactive object types are ignored.
 
@@ -1494,108 +1494,147 @@ If no shape is specified through the command arguments, the given HLR algorithm_
 @subsubsection occt_draw_4_3_1 vdisplay
 
 Syntax:                  
+~~~~~
 vdisplay name1 [name2] … [name n] 
-
+~~~~~
 Displays named objects. 
-**Example:** 
 
+**Example:** 
+~~~~~
 vinit 
 box b 40 40 40 10 10 10 
 psphere s 20 
 vdisplay s b 
 vfit 
+~~~~~
 
+@subsubsection occt_draw_4_3_2 vdonly
 
-@subsubsection occt_draw_4_32 vdonly
-
-Syntax:                  vdonly [name1] … [name n] 
-
+Syntax:                  
+~~~~~
+vdonly [name1] … [name n] 
+~~~~~
 Displays only selected or named objects. If there are no selected or named objects, nothing is done. 
-**Example:** 
 
+**Example:** 
+~~~~~
 vinit 
 box b 40 40 40 10 10 10 
 psphere s 20 
 vdonly b 
 vfit 
-@subsubsection occt_draw_4_33 vdisplayall
+~~~~~
 
-Syntax:                  vdisplayall 
+@subsubsection occt_draw_4_3_3 vdisplayall
 
+Syntax:                  
+~~~~~
+vdisplayall 
+~~~~~
 Displays all created objects. 
-**Example:** 
 
+
+**Example:** 
+~~~~~
 vinit 
 box b 40 40 40 10 10 10 
 psphere s 20 
 vdisplayall 
 vfit 
-@subsubsection occt_draw_4_34 verase
+~~~~~
 
-Syntax:                  verase [name1] [name2] … [name n] 
+@subsubsection occt_draw_4_3_4 verase
+
+Syntax: 
+~~~~~
+verase [name1] [name2] … [name n] 
+~~~~~
 
 Erases some selected or named objects. If there are no selected or named objects, the whole viewer is erased. 
-**Example:** 
 
+**Example:** 
+~~~~~
 vinit 
 box b1 40 40 40 10 10 10 
 box b2 -40 -40 -40 10 10 10 
 psphere s 20 
 vdisplayall 
 vfit 
-# erase only first box 
+# erase only the first box 
 verase b1 
-# erase second box and sphere 
+# erase the second box and sphere 
 verase 
-@subsubsection occt_draw_4_35 veraseall
+~~~~~
 
-Syntax:                  veraseall 
+@subsubsection occt_draw_4_3_5 veraseall
 
+Syntax:                  
+~~~~~
+veraseall 
+~~~~~
 Erases all objects displayed in the viewer. 
+
 **Example:** 
+
+~~~~~
 vinit 
 box b1 40 40 40 10 10 10 
 box b2 -40 -40 -40 10 10 10 
 psphere s 20 
 vdisplayall 
 vfit 
-# erase only first box 
+# erase only the first box 
 verase b1 
-# erase second box and sphere 
+# erase the second box and sphere 
 verseall 
+~~~~~
 
-@subsubsection occt_draw_4_36 vsetdispmode
+@subsubsection occt_draw_4_3_6 vsetdispmode
 
-Syntax:                  vsetdispmode [name] mode(0,1,2,3) 
+Syntax:                  
+
+~~~~~
+vsetdispmode [name] mode(0,1,2,3) 
+~~~~~
+
+Sets display mode for all, selected or named objects to the following values:
+* **0** - WireFrame,
+* **1** - Shading, 
+* **2** - Quick HideLineremoval,
+* **3** - Exact HideLineremoval. 
 
-Sets display mode for all, selected or named objects. 
-**mode** is **0** (**WireFrame**), **1** (**Shading**), **2** (**Quick HideLineremoval**), **3** (**Exact HideLineremoval**). 
 **Example:** 
 
+~~~~~
 vinit 
 box b 10 10 10 
 vdisplay b 
 vsetdispmode 1 
 vfit 
-@subsubsection occt_draw_4_37 vdisplaytype
+~~~~~
+@subsubsection occt_draw_4_39 vtypes
+
+Syntax:                  vtypes 
+
+Makes a list of known types and signatures in AIS. 
+
+@subsubsection occt_draw_4_3_7 vdisplaytype
 
-Syntax:                  vdisplaytype type 
+Syntax:                  
+~~~~~
+vdisplaytype type 
+~~~~~
 
-Displays all objects of a given type. 
-Possible **type**s are **;Point;, ;Axis;, ;Trihedron;, ;PlaneTrihedron;, ;Line;, ;Circle;, ;Plane;, ;Shape;, ;ConnectedShape;, ;MultiConn.Shape;, ;ConnectedInter.;, ;MultiConn.;, ;Constraint; **and** ;Dimension; **(see **vtypes**). 
+Displays all objects of a given type. The following types are possible: **Point, Axis, Trihedron, PlaneTrihedron, Line, Circle, Plane, Shape, ConnectedShape, MultiConn.Shape, ConnectedInter., MultiConn., Constraint** and **Dimension**. 
 
-@subsubsection occt_draw_4_38 verasetype
+@subsubsection occt_draw_4_3_8 verasetype
 
 Syntax:                  verasetype type 
 
 Erases all objects of a given type. 
 Possible** type**s are **;Point;, ;Axis;, ;Trihedron;, ;PlaneTrihedron;, ;Line;, ;Circle;, ;Plane;, ;Shape;, ;ConnectedShape;, ;MultiConn.Shape;, ;ConnectedInter.;, ;MultiConn.;, ;Constraint; **and **;Dimension; **(see **vtypes**). 
 
-@subsubsection occt_draw_4_39 vtypes
-
-Syntax:                  vtypes 
 
-Makes a list of known types and signatures in AIS. 
 
 @subsubsection occt_draw_4_310 vsetcolor
 
@@ -7532,7 +7571,9 @@ Syntax:      DT_SplitSurface result Surface|GridSurf tol split(0|1)
 Divides surface with C1 criterion and returns the result of splitting of a given surface into surface, which is given as parameter result. If the surface has been divided into segments, then each segment is put to an individual result.  This command can correct a given C0 surface at a knot with a given tolerance, if it is impossible, then the given surface is split at that knot. If the last parameter is 1, then 5 knots are added to the given surface, and its surface is split by segments, but this will be performed not for all parametric spaces. 
 **Example:** 
     
-# split surface with name ‘su’ 
+
+~~~~~
+# split surface with name "su"
 DT_SplitSurface res su 0.1 1 
 == single surf 
 == appel a SplitSurface::Init 
@@ -7542,7 +7583,7 @@ DT_SplitSurface res su 0.1 1
 == appel a Surfaces 
 == transfert resultat 
 == res1_1_1 res1_2_1 res1_3_1 res1_4_1 res1_5_1 res1_6_1 
-
+~~~~~
 
 @subsubsection occt_2142243456_1672096717128 DT_ToBspl
 
@@ -7555,10 +7596,10 @@ DT_ToBspl res sh
 == error = 5.20375663162094e-08   spans = 10 
 ==  Surface is aproximated with continuity 2 
 
-@section occt_2142243456_1640587828 Performance evaluation commands
+@section occt_draw_commands_perf Performance evaluation commands
 
 
-@subsubsection occt_2142243456_16405878281.1 VDrawSphere
+@subsection occt_draw_commands_perf_vdrawsphere VDrawSphere
 
 Syntax:      vdrawsphere shapeName Fineness [X=0.0 Y=0.0 Z=0.0] [Radius=100.0] [ToEnableVBO=1] [NumberOfViewerUpdate=1] [ToShowEdges=0] 
 
@@ -7582,12 +7623,14 @@ The following chapters explain how to extend Test Harness with custom commands a
 Custom command implementation has not undergone any changes since the introduction of the plug-in mechanism. The syntax of every command should still be like in the following example. 
 **Example:** 
 
+~~~~~
 static Standard_Integer myadvcurve(Draw_Interpretor& di, 
 Standard_Integer n, 
 char** a) 
 { 
 ... 
 } 
+~~~~~
 
 For examples of existing commands refer to Open CASCADE Technology (e.g. GeomliteTest.cxx). 
 
@@ -7597,6 +7640,7 @@ For examples of existing commands refer to Open CASCADE Technology (e.g. Geomlit
 To become available in the Test Harness the custom command must be registered in it. This should be done as follows. 
 **Example:** 
 
+~~~~~
 void MyPack::CurveCommands(Draw_Interpretor& theCommands) 
 { 
 ... 
@@ -7608,6 +7652,7 @@ char* g = ;Advanced curves creation;;
 __FILE__, myadvcurve, g); 
 ... 
 } 
+~~~~~
 
 @subsection occt_2142243456_7136599993 Creating a toolkit (library) as a plug-in