OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-06-30 12:14:08 +03:00
Code

0033016: Documentation - Draw Harness User Guide mentions removed commands 'meshdispmode'

Browse Source 
Updated description of MeshVS commands in User's Guide.
This commit is contained in:
kgv 2022-06-14 09:48:09 +03:00 committed by afokin
parent fb30026cf1
commit 88ff1a3834
1 changed files with 82 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

158
dox/user_guides/draw_test_harness/draw_test_harness.md
View File

@ -2044,43 +2044,47 @@ Creates a *MeshVS_Mesh* object based on STL file data. The object will be displa
meshfromstl mesh myfile.stl meshfromstl mesh myfile.stl
~~~~ ~~~~
@subsubsection occt_draw_4_5_2 meshdispmode @subsubsection occt_draw_4_5_2 vsetdispmode
Syntax: Syntax:
~~~~{.php} ~~~~{.php}
meshdispmode meshname displaymode vsetdispmode meshname displaymode
~~~~ ~~~~
Changes the display mode of object **meshname**. The **displaymode** is integer, which can be: Changes the display mode of object **meshname**. The **displaymode** is integer (`MeshVS_DisplayModeFlags`), which can be:
* *1* for *wireframe*, * *1* for *wireframe*,
* *2* for *shading* mode, or * *2* for *shading* mode, or
* *3* for *shrink* mode. * *3* for *shrink* mode.
**Example:** **Example:**
~~~~{.php} ~~~~{.php}
vinit vinit
meshfromstl mesh myfile.stl meshfromstl mesh myfile.stl
meshdispmode mesh 2 vsetdispmode mesh 2
~~~~ ~~~~
@subsubsection occt_draw_4_5_3 meshselmode @subsubsection occt_draw_4_5_3 vselmode
Syntax: Syntax:
~~~~{.php} ~~~~{.php}
meshselmode meshname selectionmode vselmode meshname selectionmode {on|off}
~~~~ ~~~~
Changes the selection mode of object **meshname**. The *selectionmode* is integer OR-combination of mode flags. The basic flags are the following: Changes the selection mode of object **meshname**.
The *selectionmode* is integer OR-combination of mode flags (`MeshVS_SelectionModeFlags`). The basic flags are the following:
* *0* -- selection of mesh as whole;
* *1* -- node selection; * *1* -- node selection;
* *2* -- 0D elements (not supported in STL); * *2* -- 0D elements (not supported in STL);
* *4* -- links (not supported in STL); * *4* -- links (not supported in STL);
* *8* -- faces. * *8* -- faces;
* *16* -- volumes (not supported in STL);
**Example:** * *256* -- groups (not supported in STL).
**Example:**
~~~~{.php} ~~~~{.php}
vinit vinit
meshfromstl mesh myfile.stl meshfromstl mesh myfile.stl
meshselmode mesh 1 vselmode mesh 1
~~~~ ~~~~
@subsubsection occt_draw_4_5_4 meshshadcolor @subsubsection occt_draw_4_5_4 meshshadcolor
@ -2091,11 +2095,11 @@ meshshadcolor meshname red green blue
~~~~ ~~~~
Changes the face interior color of object **meshname**. The *red*, *green* and *blue* are real values between *0* and *1*. Changes the face interior color of object **meshname**. The *red*, *green* and *blue* are real values between *0* and *1*.
**Example:** **Example:**
~~~~{.php} ~~~~{.php}
vinit vinit
meshfromstl mesh myfile.stl meshfromstl mesh myfile.stl
meshshadcolormode mesh 0.5 0.5 0.5 meshshadcolormode mesh 0.5 0.5 0.5
~~~~ ~~~~
@ -2107,11 +2111,11 @@ meshlinkcolor meshname red green blue
~~~~ ~~~~
Changes the color of face borders for object **meshname**. The *red*, *green* and *blue* are real values between *0* and *1*. Changes the color of face borders for object **meshname**. The *red*, *green* and *blue* are real values between *0* and *1*.
**Example:** **Example:**
~~~~{.php} ~~~~{.php}
vinit vinit
meshfromstl mesh myfile.stl meshfromstl mesh myfile.stl
meshlinkcolormode mesh 0.5 0.5 0.5 meshlinkcolormode mesh 0.5 0.5 0.5
~~~~ ~~~~
@ -2119,39 +2123,37 @@ meshlinkcolormode mesh 0.5 0.5 0.5
Syntax: Syntax:
~~~~{.php} ~~~~{.php}
meshmat meshname material meshmat meshname material [transparency]
~~~~ ~~~~
Changes the material of object **meshname**. Changes the material of object **meshname**.
*material* is represented with an integer value as follows (equivalent to enumeration *Graphic3d_NameOfMaterial*): *material* is represented with an integer value as follows (equivalent to enumeration *Graphic3d_NameOfMaterial*):
* *0 -- BRASS,* * *0 -- BRASS*,
* *1 -- BRONZE,* * *1 -- BRONZE*,
* *2 -- COPPER,* * *2 -- COPPER*,
* *3 -- GOLD,* * *3 -- GOLD*,
* *4 -- PEWTER,* * *4 -- PEWTER*,
* *5 -- PLASTER,* * *5 -- PLASTER*,
* *6 -- PLASTIC,* * *6 -- PLASTIC*,
* *7 -- SILVER,* * *7 -- SILVER*,
* *8 -- STEEL,* * *8 -- STEEL*,
* *9 -- STONE,* * *9 -- STONE*,
* *10 -- SHINY_PLASTIC,* * *10 -- SHINY_PLASTIC*,
* *11 -- SATIN,* * *11 -- SATIN*,
* *12 -- METALIZED,* * *12 -- METALIZED*,
* *13 -- NEON_GNC,* * *13 -- NEON_GNC*,
* *14 -- CHROME,* * *14 -- CHROME*,
* *15 -- ALUMINIUM,* * *15 -- ALUMINIUM*,
* *16 -- OBSIDIAN,* * *16 -- OBSIDIAN*,
* *17 -- NEON_PHC,* * *17 -- NEON_PHC*,
* *18 -- JADE,* * *18 -- JADE*.
* *19 -- DEFAULT,*
* *20 -- UserDefined*
**Example:** **Example:**
~~~~{.php} ~~~~{.php}
vinit vinit
meshfromstl mesh myfile.stl meshfromstl mesh myfile.stl
meshmat mesh JADE meshmat mesh 18
~~~~ ~~~~
@subsubsection occt_draw_4_5_7 meshshrcoef @subsubsection occt_draw_4_5_7 meshshrcoef
@ -2161,12 +2163,14 @@ Syntax:
meshshrcoef meshname shrinkcoefficient meshshrcoef meshname shrinkcoefficient
~~~~ ~~~~
Changes the value of shrink coefficient used in the shrink mode. In the shrink mode the face is shown as a congruent part of a usual face, so that *shrinkcoefficient* controls the value of this part. The *shrinkcoefficient* is a positive real number. Changes the value of shrink coefficient used in the shrink mode.
In the shrink mode the face is shown as a congruent part of a usual face, so that *shrinkcoefficient* controls the value of this part.
**Example:** The *shrinkcoefficient* is a positive real number.
**Example:**
~~~~{.php} ~~~~{.php}
vinit vinit
meshfromstl mesh myfile.stl meshfromstl mesh myfile.stl
meshshrcoef mesh 0.05 meshshrcoef mesh 0.05
~~~~ ~~~~
@ -2178,11 +2182,12 @@ meshshow meshname
~~~~ ~~~~
Displays **meshname** in the viewer (if it is erased). Displays **meshname** in the viewer (if it is erased).
The same as calling `vdisplay`.
**Example:** **Example:**
~~~~{.php} ~~~~{.php}
vinit vinit
meshfromstl mesh myfile.stl meshfromstl mesh myfile.stl
meshshow mesh meshshow mesh
~~~~ ~~~~
@ -2193,12 +2198,13 @@ Syntax:
meshhide meshname meshhide meshname
~~~~ ~~~~
Hides **meshname** in the viewer. Hides **meshname** in the viewer.
The same as calling `verase`.
**Example:** **Example:**
~~~~{.php} ~~~~{.php}
vinit vinit
meshfromstl mesh myfile.stl meshfromstl mesh myfile.stl
meshhide mesh meshhide mesh
~~~~ ~~~~
@ -2209,7 +2215,7 @@ Syntax:
meshhidesel meshname meshhidesel meshname
~~~~ ~~~~
Hides only selected entities. The other part of **meshname** remains visible. Hides only selected entities. The other part of **meshname** remains visible.
@subsubsection occt_draw_4_5_11 meshshowsel @subsubsection occt_draw_4_5_11 meshshowsel
@ -2218,7 +2224,7 @@ Syntax:
meshshowsel meshname meshshowsel meshname
~~~~ ~~~~
Shows only selected entities. The other part of **meshname** becomes invisible. Shows only selected entities. The other part of **meshname** becomes invisible.
@subsubsection occt_draw_4_5_12 meshshowall @subsubsection occt_draw_4_5_12 meshshowall
@ -2227,22 +2233,22 @@ Syntax:
meshshowall meshname meshshowall meshname
~~~~ ~~~~
Changes the state of all entities to visible for **meshname**. Changes the state of all entities to visible for **meshname**.
@subsubsection occt_draw_4_5_13 meshdelete @subsubsection occt_draw_4_5_13 vremove
Syntax: Syntax:
~~~~{.php} ~~~~{.php}
meshdelete meshname vremove meshname
~~~~ ~~~~
Deletes MeshVS_Mesh object **meshname**. Deletes MeshVS_Mesh object **meshname**.
**Example:** **Example:**
~~~~{.php} ~~~~{.php}
vinit vinit
meshfromstl mesh myfile.stl meshfromstl mesh myfile.stl
meshdelete mesh vremove mesh
~~~~ ~~~~
@subsection occt_draw_4_6 VIS Viewer commands @subsection occt_draw_4_6 VIS Viewer commands