mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-08-09 13:22:24 +03:00
0032694: Documentation, Draw Harness Guide - update ViewerTest commands
Draw Harness Guide now refers to ViewerTest commands description via @snippet pointing to C++ source code instead of duplicating it. "help" command now tries to beautify output of command's description.
This commit is contained in:
@@ -1924,86 +1924,89 @@ static int VMoveDim (Draw_Interpretor& theDi, Standard_Integer theArgNum, const
|
||||
|
||||
void ViewerTest::RelationCommands(Draw_Interpretor& theCommands)
|
||||
{
|
||||
const char *group = "AISRelations";
|
||||
const char* aGroup = "AIS Viewer";
|
||||
const char* aFileName = __FILE__;
|
||||
auto addCmd = [&](const char* theName, Draw_Interpretor::CommandFunction theFunc, const char* theHelp)
|
||||
{
|
||||
theCommands.Add (theName, theHelp, aFileName, theFunc, aGroup);
|
||||
};
|
||||
|
||||
theCommands.Add("vdimension",
|
||||
"vdimension name {-angle|-length|-radius|-diameter}"
|
||||
"[-shapes shape1 [shape2 [shape3]]\n"
|
||||
"[-selected]\n"
|
||||
"[-text 3d|2d wf|sh|wireframe|shading IntegerSize]\n"
|
||||
"[-font FontName]\n"
|
||||
"[-label left|right|hcenter|hfit top|bottom|vcenter|vfit]\n"
|
||||
"[-arrow external|internal|fit]\n"
|
||||
"[-zoomablearrow]\n"
|
||||
"[{-arrowlength|-arlen} RealArrowLength]\n"
|
||||
"[{-arrowangle|-arangle} ArrowAngle(degrees)]\n"
|
||||
"[-plane xoy|yoz|zox]\n"
|
||||
"[-flyout FloatValue -extension FloatValue]\n"
|
||||
"[-autovalue]\n"
|
||||
"[-value CustomRealValue]\n"
|
||||
"[-textvalue CustomTextValue]\n"
|
||||
"[-dispunits DisplayUnitsString]\n"
|
||||
"[-modelunits ModelUnitsString]\n"
|
||||
"[-showunits | -hideunits]\n"
|
||||
" -Builds angle, length, radius and diameter dimensions.\n"
|
||||
" -See also: vdimparam, vmovedim.\n",
|
||||
__FILE__,VDimBuilder,group);
|
||||
addCmd ("vdimension", VDimBuilder, /* [vdimension] */ R"(
|
||||
vdimension name {-angle|-length|-radius|-diameter}
|
||||
[-shapes shape1 [shape2 [shape3]]
|
||||
[-selected]
|
||||
[-text 3d|2d wf|sh|wireframe|shading IntegerSize]
|
||||
[-font FontName]
|
||||
[-label left|right|hcenter|hfit top|bottom|vcenter|vfit]
|
||||
[-arrow external|internal|fit]
|
||||
[-zoomablearrow]
|
||||
[{-arrowlength|-arlen} RealArrowLength]
|
||||
[{-arrowangle|-arangle} ArrowAngle(degrees)]
|
||||
[-plane xoy|yoz|zox]
|
||||
[-flyout FloatValue -extension FloatValue]
|
||||
[-autovalue]
|
||||
[-value CustomRealValue]
|
||||
[-textvalue CustomTextValue]
|
||||
[-dispunits DisplayUnitsString]
|
||||
[-modelunits ModelUnitsString]
|
||||
[-showunits | -hideunits]
|
||||
Builds angle, length, radius and diameter dimensions.
|
||||
See also: vdimparam, vmovedim.
|
||||
)" /* [vdimension] */);
|
||||
|
||||
theCommands.Add ("vrelation",
|
||||
"vrelation name {-concentric|-equaldistance|-equalradius|-fix|-identic|-offset|-parallel|-perpendicular|-tangent|-symmetric}"
|
||||
"\n\t\t: concentric - 2 circled edges."
|
||||
"\n\t\t: equaldistance - 4 vertex/edges."
|
||||
"\n\t\t: equalradius - 1 or 2 circled edges."
|
||||
"\n\t\t: fix - 1 edge."
|
||||
"\n\t\t: identic - 2 faces, edges or vertices."
|
||||
"\n\t\t: offset - 2 faces."
|
||||
"\n\t\t: parallel - 2 faces or 2 edges."
|
||||
"\n\t\t: perpendicular - 2 faces or 2 edges."
|
||||
"\n\t\t: tangent - two coplanar edges (first the circular edge then the tangent edge) or two faces."
|
||||
"\n\t\t: symmetric - 3 edges or 1 edge and 2 vertices."
|
||||
"-Builds specific relation from selected objects.",
|
||||
__FILE__, VRelationBuilder, group);
|
||||
addCmd ("vrelation", VRelationBuilder, /* [vrelation] */ R"(
|
||||
vrelation name {-concentric|-equaldistance|-equalradius|-fix|
|
||||
-identic|-offset|-parallel|-perpendicular|-tangent|-symmetric}
|
||||
Builds specific relation from selected objects:
|
||||
-concentric - 2 circled edges
|
||||
-equaldistance - 4 vertex/edges
|
||||
-equalradius - 1 or 2 circled edges
|
||||
-fix - 1 edge
|
||||
-identic - 2 faces, edges or vertices
|
||||
-offset - 2 faces
|
||||
-parallel - 2 faces or 2 edges
|
||||
-perpendicular - 2 faces or 2 edges
|
||||
-tangent - two coplanar edges (first the circular edge then the tangent edge) or two faces
|
||||
-symmetric - 3 edges or 1 edge and 2 vertices
|
||||
)" /* [vrelation] */);
|
||||
|
||||
theCommands.Add("vdimparam",
|
||||
"vdimparam name"
|
||||
"[-text 3d|2d wf|sh|wireframe|shading IntegerSize]\n"
|
||||
"[-font FontName]\n"
|
||||
"[-label left|right|hcenter|hfit top|bottom|vcenter|vfit]\n"
|
||||
"[-arrow external|internal|fit]\n"
|
||||
"[-zoomablearrow 0|1]\n"
|
||||
"[{-arrowlength|-arlen} RealArrowLength]\n"
|
||||
"[{-arrowangle|-arangle} ArrowAngle(degrees)]\n"
|
||||
"[-plane xoy|yoz|zox]\n"
|
||||
"[-flyout FloatValue -extension FloatValue]\n"
|
||||
"[-value CustomNumberValue]\n"
|
||||
"[-textvalue CustomTextValue]\n"
|
||||
"[-dispunits DisplayUnitsString]\n"
|
||||
"[-modelunits ModelUnitsString]\n"
|
||||
"[-showunits | -hideunits]\n"
|
||||
" -Sets parameters for angle, length, radius and diameter dimensions.\n"
|
||||
" -See also: vmovedim, vdimension.\n",
|
||||
__FILE__,VDimParam,group);
|
||||
addCmd ("vdimparam", VDimParam, /* [vdimparam] */ R"(
|
||||
vdimparam name
|
||||
[-text 3d|2d wf|sh|wireframe|shading IntegerSize]
|
||||
[-font FontName]
|
||||
[-label left|right|hcenter|hfit top|bottom|vcenter|vfit]
|
||||
[-arrow external|internal|fit]
|
||||
[-zoomablearrow 0|1]
|
||||
[{-arrowlength|-arlen} RealArrowLength]
|
||||
[{-arrowangle|-arangle} ArrowAngle(degrees)]
|
||||
[-plane xoy|yoz|zox]
|
||||
[-flyout FloatValue -extension FloatValue]
|
||||
[-value CustomNumberValue]
|
||||
[-textvalue CustomTextValue]
|
||||
[-dispunits DisplayUnitsString]
|
||||
[-modelunits ModelUnitsString]
|
||||
[-showunits | -hideunits]
|
||||
Sets parameters for angle, length, radius and diameter dimensions.
|
||||
See also: vmovedim, vdimension.
|
||||
)" /* [vdimparam] */);
|
||||
|
||||
theCommands.Add("vlengthparam",
|
||||
"vlengthparam name"
|
||||
"[-direction {ox|oy|oz|x y z|autodirection}]\n"
|
||||
" -Sets parameters for length dimension.\n"
|
||||
" -See also: vdimparam, vdimension.\n",
|
||||
__FILE__,VLengthParam,group);
|
||||
addCmd ("vlengthparam", VLengthParam, /* [vlengthparam] */ R"(
|
||||
vlengthparam name [-direction {ox|oy|oz|x y z|autodirection}]
|
||||
Sets parameters for length dimension.
|
||||
See also: vdimparam, vdimension.
|
||||
)" /* [vlengthparam] */);
|
||||
|
||||
theCommands.Add("vangleparam",
|
||||
"vangleparam name"
|
||||
"[-type interior|exterior]\n"
|
||||
"[-showarrow first|second|both|none]\n"
|
||||
" -Sets parameters for angle dimension.\n"
|
||||
" -See also: vdimparam, vdimension.\n",
|
||||
__FILE__,VAngleParam,group);
|
||||
|
||||
theCommands.Add("vmovedim",
|
||||
"vmovedim : vmovedim [name] [x y z]"
|
||||
"\n\t\t: Moves picked or named (if name defined)"
|
||||
"\n\t\t: dimension to picked mouse position or input point."
|
||||
"\n\t\t: Text label of dimension 'name' is moved to position, another parts of dimensionare adjusted.",
|
||||
__FILE__,VMoveDim,group);
|
||||
addCmd ("vangleparam", VAngleParam, /* [vangleparam] */ R"(
|
||||
vangleparam name [-type interior|exterior]
|
||||
[-showarrow first|second|both|none]
|
||||
Sets parameters for angle dimension.
|
||||
See also: vdimparam, vdimension.
|
||||
)" /* [vangleparam] */);
|
||||
|
||||
addCmd ("vmovedim", VMoveDim, /* [vmovedim] */ R"(
|
||||
vmovedim [name] [x y z]
|
||||
Moves picked or named (if name defined)
|
||||
dimension to picked mouse position or input point.
|
||||
Text label of dimension 'name' is moved to position, another parts of dimension are adjusted.
|
||||
)" /* [vmovedim] */);
|
||||
}
|
||||
|
Reference in New Issue
Block a user