Skip to content

Commit d2c9091

Browse files
ndsbugmaster
authored andcommitted
0029018: Documentation - Provide user guide for Qt browser
Documentation is added in a new "Inspector" page of "User Guides". Inspector plugins has some improvements by the documentation needs. New DRAW scripts are implemented for 'tinspector' command.
1 parent 4340981 commit d2c9091

117 files changed

Lines changed: 3167 additions & 464 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

dox/FILES_HTML.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ user_guides/xde/xde.md
3232
user_guides/ocaf/ocaf.md
3333
user_guides/tobj/tobj.md
3434
user_guides/draw_test_harness/draw_test_harness.md
35+
user_guides/inspector/inspector.md
3536
user_guides/brep_wp/brep_wp.md
3637
user_guides/vis/vis.md
3738

dox/FILES_PDF.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ user_guides/shape_healing/shape_healing.md
1414
user_guides/ocaf/ocaf.md
1515
user_guides/step/step.md
1616
user_guides/draw_test_harness/draw_test_harness.md
17+
user_guides/inspector/inspector.md
1718
user_guides/tobj/tobj.md
1819
user_guides/visualization/visualization.md
1920
user_guides/xde/xde.md

dox/dev_guides/building/cmake/cmake.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ The following table gives the full list of environment variables used at the con
9797
| BUILD_ADDITIONAL_TOOLKITS | String | Semicolon-separated individual toolkits to include into build process. If you want to build some particular libraries (toolkits) only, then you may uncheck all modules in the corresponding *BUILD_MODUE_\<MODULE\>* options and provide the list of necessary libraries here. Of course, all dependencies will be resolved automatically |
9898
| BUILD_YACCLEX | Boolean flag | Enables Flex/Bison lexical analyzers. OCCT source files relating to STEP reader and ExprIntrp functionality are generated automatically with Flex/Bison. Checking this option leads to automatic search of Flex/Bison binaries and regeneration of the mentioned files |
9999
| BUILD_MODULE_MfcSamples | Boolean flag | Indicates whether MFC samples should be built together with OCCT. This option is only relevant to Windows platforms |
100+
| BUILD_Inspector | Boolean flag | Indicates whether Inspector should be built together with OCCT. |
100101
| BUILD_DOC_Overview | Boolean flag | Indicates whether OCCT overview documentation project should be created together with OCCT. It is not built together with OCCT. Checking this option leads to automatic search of Doxygen binaries. Its building calls Doxygen command to generate the documentation in HTML format |
101102
| BUILD_PATCH | Path | Points to the directory recognized as a "patch" for OCCT. If specified, the files from this directory take precedence over the corresponding native OCCT sources. This way you are able to introduce patches to Open CASCADE Technology not affecting the original source distribution |
102103
| BUILD_WITH_DEBUG | Boolean flag | Enables extended messages of many OCCT algorithms, usually printed to cout. These include messages on internal errors and special cases encountered, timing, etc. |

dox/user_guides/draw_test_harness/draw_test_harness.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10687,6 +10687,87 @@ Example:
1068710687
mdist
1068810688
~~~~~
1068910689

10690+
@section occt_draw_13 Inspector commands
10691+
10692+
10693+
This section describes commands that make possible to use Inspector.
10694+
10695+
@subsection occt_draw_13_1 tinspector
10696+
10697+
Syntax:
10698+
~~~~~
10699+
tinspector [-plugins {name1 ... [nameN] | all}]
10700+
[-activate name]
10701+
[-shape object [name1] ... [nameN]]
10702+
[-open file_name [name1] ... [nameN]]
10703+
[-update]
10704+
[-select {object | name1 ... [nameN]}]
10705+
[-show {0|1} = 1]
10706+
~~~~~
10707+
Starts tool of inspection.
10708+
Options:
10709+
* *plugins* enters plugins that should be added in the inspector.
10710+
Available names are: dfbrowser, vinspector and shapeview.
10711+
Plugins order will be the same as defined in arguments.
10712+
'all' adds all available plugins in the order:
10713+
DFBrowser, VInspector and ShapeView.
10714+
If at the first call this option is not used, 'all' option is applyed;
10715+
* *activate* activates the plugin in the tool view.
10716+
If at the first call this option is not used, the first plugin is activated;
10717+
* *shape* initializes plugin/s by the shape object. If 'name' is empty, initializes all plugins;
10718+
* *open* gives the file to the plugin/s. If the plugin is active, after open, update content will be done;
10719+
* *update* updates content of the active plugin;
10720+
* *select* sets the parameter that should be selected in an active tool view.
10721+
Depending on active tool the parameter is:
10722+
ShapeView: 'object' is an instance of TopoDS_Shape TShape,
10723+
DFBrowser: 'name' is an entry of TDF_Label and name2(optionaly) for TDF_Attribute type name,
10724+
VInspector: 'object' is an instance of AIS_InteractiveObject;
10725+
* *show* sets Inspector view visible or hidden. The first call of this command will show it.
10726+
10727+
**Example:**
10728+
~~~~~
10729+
pload DCAF INSPECTOR
10730+
10731+
NewDocument Doc BinOcaf
10732+
10733+
set aSetAttr1 100
10734+
set aLabel 0:2
10735+
SetInteger Doc ${aLabel} ${aSetAttr1}
10736+
10737+
tinspector -plugins dfbrowser -select 0:2 TDataStd_Integer
10738+
~~~~~
10739+
10740+
**Example:**
10741+
~~~~~
10742+
pload ALL INSPECTOR
10743+
10744+
box b1 200 100 120
10745+
box b2 100 200 220 100 120 100
10746+
10747+
tinspector -plugins shapeview -shape b1 -shape b2 -select b1
10748+
~~~~~
10749+
10750+
**Example:**
10751+
~~~~~
10752+
pload ALL INSPECTOR
10753+
10754+
tinspector -plugins vinspector
10755+
10756+
vinit
10757+
box box_1 100 100 100
10758+
vdisplay box_1
10759+
10760+
box box_2 180 120 200 150 150 150
10761+
vdisplay box_2
10762+
10763+
vfit
10764+
vselmode box_1 1 1
10765+
vselmode box_1 3 1
10766+
10767+
tinspector -update -select box_1
10768+
~~~~~
10769+
10770+
1069010771
@section occt_draw_11 Extending Test Harness with custom commands
1069110772

1069210773

5.16 KB
Loading
Lines changed: 224 additions & 0 deletions
Loading
22 KB
Loading
18.1 KB
Loading
22.1 KB
Loading
38 KB
Loading

0 commit comments

Comments
 (0)