OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-03 17:56:21 +03:00
Code Packages Releases Activity

0032694: Documentation, Draw Harness Guide - update ViewerTest commands

Browse Source 
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:
kgv 2021-11-27 15:18:53 +03:00 committed by smoskvin
parent 4f5e934445
commit 44f6e8d5e8
9 changed files with 2010 additions and 2501 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
adm/gendoc.tcl
View File

@ -835,6 +835,7 @@ proc OCCDoc_MakeDoxyfile {docType outDir tagFileDir {doxyFileName} {generatorMod
puts $doxyFile "PROJECT_NUMBER = $occt_version" puts $doxyFile "PROJECT_NUMBER = $occt_version"
puts $doxyFile "OUTPUT_DIRECTORY = $outDir/." puts $doxyFile "OUTPUT_DIRECTORY = $outDir/."
puts $doxyFile "PROJECT_LOGO = [OCCDoc_GetDoxDir]/resources/occ_logo.png" puts $doxyFile "PROJECT_LOGO = [OCCDoc_GetDoxDir]/resources/occ_logo.png"
puts $doxyFile "EXAMPLE_PATH = [OCCDoc_GetSourceDir $productsPath]"
set PARAM_INPUT "INPUT =" set PARAM_INPUT "INPUT ="
set PARAM_IMAGEPATH "IMAGE_PATH = [OCCDoc_GetDoxDir]/resources/ " set PARAM_IMAGEPATH "IMAGE_PATH = [OCCDoc_GetDoxDir]/resources/ "

1
dox/CMakeLists.txt
View File

@ -43,6 +43,7 @@ configure_file ("${OCCT_OVERVIEW_RESOURCE_DIR}/occt_ug_html.doxyfile" "${OCCT_CO
file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nPROJECT_NUMBER = ${OCC_VERSION_STRING_EXT}") file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nPROJECT_NUMBER = ${OCC_VERSION_STRING_EXT}")
file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nOUTPUT_DIRECTORY = ${OCCT_GENERATED_OVERVIEW_DIR}/.") file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nOUTPUT_DIRECTORY = ${OCCT_GENERATED_OVERVIEW_DIR}/.")
file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nPROJECT_LOGO = ${OCCT_OVERVIEW_DIR}/resources/occ_logo.png") file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nPROJECT_LOGO = ${OCCT_OVERVIEW_DIR}/resources/occ_logo.png")
file (APPEND ${OCCT_CONFIG_FOR_DOXYGEN} "\nEXAMPLE_PATH = ${CMAKE_SOURCE_DIR}/src")
set (OCCT_ARTICLE_PARAM_INPUT "INPUT =") set (OCCT_ARTICLE_PARAM_INPUT "INPUT =")
set (OCCT_ARTICLE_PARAM_IMAGEPATH "IMAGE_PATH = ${OCCT_OVERVIEW_DIR}/resources/ ") set (OCCT_ARTICLE_PARAM_IMAGEPATH "IMAGE_PATH = ${OCCT_OVERVIEW_DIR}/resources/ ")

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

File diff suppressed because one or more lines are too long

25
src/DrawResources/StandardCommands.tcl
View File

@ -59,13 +59,28 @@ proc help {{theCommand ""} {theHelpString ""} {theGroup "Procedures"}} {
} elseif {$theHelpString == ""} { } elseif {$theHelpString == ""} {
# help function # help function
set isFound 0 set isFound 0
foreach f [lsort [array names Draw_Helps]] { foreach aCmdIter [lsort [array names Draw_Helps]] {
if {[string match $theCommand $f]} { if {[string match $theCommand $aCmdIter]} {
dputs -nonewline -intense $f dputs -nonewline -intense $aCmdIter
for {set j [string length $f]} {$j < 15} {incr j} { set aLines [split $Draw_Helps($aCmdIter) "\n"]
set aNbLines [llength $aLines]
set isFirstLine 0
for {set aLineIter 0} {$aLineIter < $aNbLines} {incr aLineIter} {
set aLine [lindex $aLines $aLineIter]
if { "$aLine" == "" && ($aLineIter == 0 || $aLineIter == [expr $aNbLines - 1]) } { continue }
if { $isFirstLine == 0 } {
set isFirstLine 1
for {set j [string length $aCmdIter]} {$j < 15} {incr j} {
puts -nonewline " " puts -nonewline " "
} }
puts " : $Draw_Helps($f)" puts -nonewline " : "
} else {
if { ![string match "\t\t:*" $aLine] } {
puts -nonewline " : "
}
}
puts -nonewline "${aLine}\n"
}
set isFound 1 set isFound 1
} }
} }

659
src/ViewerTest/ViewerTest.cxx
View File

@ -6542,388 +6542,377 @@ void ViewerTest::Commands(Draw_Interpretor& theCommands)
ViewerTest::FilletCommands(theCommands); ViewerTest::FilletCommands(theCommands);
ViewerTest::OpenGlCommands(theCommands); ViewerTest::OpenGlCommands(theCommands);
const char *group = "AIS_Display"; 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);
};
// display // display
theCommands.Add("visos", addCmd ("visos", visos, /* [visos] */ R"(
"visos [name1 ...] [nbUIsos nbVIsos IsoOnPlane(0|1)]\n" visos [name1 ...] [nbUIsos nbVIsos IsoOnPlane(0|1)]
"\tIf last 3 optional parameters are not set prints numbers of U-, V- isolines and IsoOnPlane.\n", If last 3 optional parameters are not set prints numbers of U-, V- isolines and IsoOnPlane.
__FILE__, visos, group); )" /* [visos] */);
theCommands.Add("vdisplay", addCmd ("vdisplay", VDisplay2, /* [vdisplay] */ R"(
"vdisplay [-noupdate|-update] [-local] [-mutable] [-neutral]" vdisplay [-noupdate|-update] [-mutable] [-neutral]
"\n\t\t: [-trsfPers {zoom|rotate|zoomRotate|none}=none]" [-trsfPers {zoom|rotate|zoomRotate|none}=none]
"\n\t\t: [-trsfPersPos X Y [Z]] [-3d]" [-trsfPersPos X Y [Z]] [-3d]
"\n\t\t: [-2d|-trihedron [{top|bottom|left|right|topLeft" [-2d|-trihedron [{top|bottom|left|right|topLeft
"\n\t\t: |topRight|bottomLeft|bottomRight}" |topRight|bottomLeft|bottomRight}
"\n\t\t: [offsetX offsetY]]]" [offsetX offsetY]]]
"\n\t\t: [-dispMode mode] [-highMode mode]" [-dispMode mode] [-highMode mode]
"\n\t\t: [-layer index] [-top|-topmost|-overlay|-underlay]" [-layer index] [-top|-topmost|-overlay|-underlay]
"\n\t\t: [-redisplay] [-erased]" [-redisplay] [-erased]
"\n\t\t: [-noecho] [-autoTriangulation {0|1}]" [-noecho] [-autoTriangulation {0|1}]
"\n\t\t: name1 [name2] ... [name n]" name1 [name2] ... [name n]
"\n\t\t: Displays named objects." Displays named objects.
"\n\t\t: Option -local enables displaying of objects in local" -noupdate Suppresses viewer redraw call.
"\n\t\t: selection context. Local selection context will be opened" -mutable Enables optimizations for mutable objects.
"\n\t\t: if there is not any." -neutral Draws objects in main viewer.
"\n\t\t: -noupdate Suppresses viewer redraw call." -erased Loads the object into context, but does not display it.
"\n\t\t: -mutable Enables optimizations for mutable objects." -layer Sets z-layer for objects.
"\n\t\t: -neutral Draws objects in main viewer." Alternatively -overlay|-underlay|-top|-topmost
"\n\t\t: -erased Loads the object into context, but does not display it." options can be used for the default z-layers.
"\n\t\t: -layer Sets z-layer for objects." -top Draws object on top of main presentations
"\n\t\t: Alternatively -overlay|-underlay|-top|-topmost" but below topmost.
"\n\t\t: options can be used for the default z-layers." -topmost Draws in overlay for 3D presentations.
"\n\t\t: -top Draws object on top of main presentations" with independent Depth.
"\n\t\t: but below topmost." -overlay Draws objects in overlay for 2D presentations.
"\n\t\t: -topmost Draws in overlay for 3D presentations." (On-Screen-Display)
"\n\t\t: with independent Depth." -underlay Draws objects in underlay for 2D presentations.
"\n\t\t: -overlay Draws objects in overlay for 2D presentations." (On-Screen-Display)
"\n\t\t: (On-Screen-Display)" -selectable|-noselect Controls selection of objects.
"\n\t\t: -underlay Draws objects in underlay for 2D presentations." -trsfPers Sets a transform persistence flags.
"\n\t\t: (On-Screen-Display)" -trsfPersPos Sets an anchor point for transform persistence.
"\n\t\t: -selectable|-noselect Controls selection of objects." -2d Displays object in screen coordinates.
"\n\t\t: -trsfPers Sets a transform persistence flags." (DY looks up)
"\n\t\t: -trsfPersPos Sets an anchor point for transform persistence." -dispmode Sets display mode for objects.
"\n\t\t: -2d Displays object in screen coordinates." -highmode Sets hilight mode for objects.
"\n\t\t: (DY looks up)" -redisplay Recomputes presentation of objects.
"\n\t\t: -dispmode Sets display mode for objects." -noecho Avoid printing of command results.
"\n\t\t: -highmode Sets hilight mode for objects." -autoTriang Enable/disable auto-triangulation for displayed shape.
"\n\t\t: -redisplay Recomputes presentation of objects." )" /* [vdisplay] */);
"\n\t\t: -noecho Avoid printing of command results."
"\n\t\t: -autoTriang Enable/disable auto-triangulation for displayed shape.",
__FILE__, VDisplay2, group);
theCommands.Add ("vnbdisplayed", addCmd ("vnbdisplayed", VNbDisplayed, /* [vnbdisplayed] */ R"(
"vnbdisplayed" vnbdisplayed : Returns number of displayed objects
"\n\t\t: Returns number of displayed objects", )" /* [vnbdisplayed] */);
__FILE__, VNbDisplayed, group);
theCommands.Add ("vupdate", addCmd ("vupdate", VUpdate, /* [vupdate] */ R"(
"vupdate name1 [name2] ... [name n]" vupdate name1 [name2] ... [name n]
"\n\t\t: Updates named objects in interactive context", Updates named objects in interactive context
__FILE__, VUpdate, group); )" /* [vupdate] */);
theCommands.Add("verase", addCmd ("verase", VErase, /* [verase] */ R"(
"verase [-noupdate|-update] [-local] [name1] ... [name n] [-noerror]" verase [-noupdate|-update] [name1] ... [name n] [-noerror]
"\n\t\t: Erases selected or named objects." Erases selected or named objects.
"\n\t\t: If there are no selected or named objects the whole viewer is erased." If there are no selected or named objects the whole viewer is erased.
"\n\t\t: Option -local enables erasing of selected or named objects without" Option -noerror prevents exception on non-existing objects.
"\n\t\t: closing local selection context." )" /* [verase] */);
"\n\t\t: Option -noerror prevents exception on non-existing objects.",
__FILE__, VErase, group);
theCommands.Add("vremove", addCmd ("vremove", VRemove, /* [vremove] */ R"(
"vremove [-noupdate|-update] [-context] [-all] [-noinfo] [name1] ... [name n] [-noerror]" vremove [-noupdate|-update] [-context] [-all] [-noinfo] [name1] ... [name n] [-noerror]
"or vremove [-context] -all to remove all objects" or vremove [-context] -all to remove all objects
"\n\t\t: Removes selected or named objects." Removes selected or named objects.
"\n\t\t If -context is in arguments, the objects are not deleted" -context do not delete object from the map of objects and names;
"\n\t\t from the map of objects and names." -noupdate suppresses viewer redraw call;
"\n\t\t: Option -local enables removing of selected or named objects without" -noinfo suppresses displaying the list of removed objects;
"\n\t\t: closing local selection context. Empty local selection context will be" -noerror prevents exception on non-existing objects.
"\n\t\t: closed." )" /* [vremove] */);
"\n\t\t: Option -noupdate suppresses viewer redraw call."
"\n\t\t: Option -noinfo suppresses displaying the list of removed objects."
"\n\t\t: Option -noerror prevents exception on non-existing objects.",
__FILE__, VRemove, group);
theCommands.Add("vdonly", addCmd ("vdonly", VDonly2, /* [vdonly] */ R"(
"vdonly [-noupdate|-update] [name1] ... [name n]" vdonly [-noupdate|-update] [name1] ... [name n]
"\n\t\t: Displays only selected or named objects", Displays only selected or named objects.
__FILE__,VDonly2,group); )" /* [vdonly] */);
theCommands.Add("vdisplayall", addCmd ("vdisplayall", VDisplayAll, /* [vdisplayall] */ R"(
"vdisplayall" vdisplayall : Displays all erased interactive objects (see vdir and vstate).
"\n\t\t: Displays all erased interactive objects (see vdir and vstate).", )" /* [vdisplayall] */);
__FILE__, VDisplayAll, group);
theCommands.Add("veraseall", addCmd ("veraseall", VErase, /* [veraseall] */ R"(
"veraseall" veraseall : Erases all objects displayed in the viewer.
"\n\t\t: Erases all objects displayed in the viewer.", )" /* [veraseall] */);
__FILE__, VErase, group);
theCommands.Add("verasetype", addCmd ("verasetype", VEraseType, /* [verasetype] */ R"(
"verasetype <Type>" verasetype <Type>
"\n\t\t: Erase all the displayed objects of one given kind (see vtypes)", Erase all the displayed objects of one given kind (see vtypes).
__FILE__, VEraseType, group); The following types are possible:
theCommands.Add("vbounding", Point, Axis, Trihedron, PlaneTrihedron, Line, Circle, Plane, Shape,
"vbounding [-noupdate|-update] [-mode] name1 [name2 [...]]" ConnectedShape, MultiConn.Shape, ConnectedInter., MultiConn., Constraint and Dimension.
"\n\t\t: [-print] [-hide]" )" /* [verasetype] */);
"\n\t\t: Temporarily display bounding box of specified Interactive"
"\n\t\t: Objects, or print it to console if -print is specified."
"\n\t\t: Already displayed box might be hidden by -hide option.",
__FILE__,VBounding,group);
theCommands.Add("vdisplaytype", addCmd ("vbounding", VBounding, /* [vbounding] */ R"(
"vdisplaytype : vdisplaytype <Type> <Signature> \n\t display all the objects of one given kind (see vtypes) which are stored the AISContext ", vbounding [-noupdate|-update] [-mode] name1 [name2 [...]]
__FILE__,VDisplayType,group); [-print] [-hide]
Temporarily display bounding box of specified Interactive Objects,
or print it to console if -print is specified.
Already displayed box might be hidden by -hide option.
)" /* [vbounding] */);
theCommands.Add("vsetdispmode", addCmd ("vdisplaytype", VDisplayType, /* [vdisplaytype] */ R"(
"vsetdispmode [name] mode(1,2,..)" vdisplaytype <Type> <Signature>
"\n\t\t: Sets display mode for all, selected or named objects.", Display all the objects of one given kind (see vtypes) which are stored the interactive context.
__FILE__,VDispMode,group); The following types are possible:
Point, Axis, Trihedron, PlaneTrihedron, Line, Circle, Plane, Shape,
ConnectedShape, MultiConn.Shape, ConnectedInter., MultiConn., Constraint and Dimension.
)" /* [vdisplaytype] */);
theCommands.Add("vunsetdispmode", addCmd ("vsetdispmode", VDispMode, /* [vsetdispmode] */ R"(
"vunsetdispmode [name]" vsetdispmode [name] mode(1,2,..)
"\n\t\t: Unsets custom display mode for selected or named objects.", Sets display mode for all, selected or named objects.
__FILE__,VDispMode,group); In case of a shape presentation, 0 defines WireFrame, and 1 defines Shading display modes.
)" /* [vsetdispmode] */);
theCommands.Add("vdir", addCmd ("vunsetdispmode", VDispMode, /* [vunsetdispmode] */ R"(
"vdir [mask] [-list]" vunsetdispmode [name]
"\n\t\t: Lists all objects displayed in 3D viewer" Unsets custom display mode for selected or named objects.
"\n\t\t: mask - name filter like prefix*" )" /* [vunsetdispmode] */);
"\n\t\t: -list - format list with new-line per name; OFF by default",
__FILE__,VDir,group);
#ifdef HAVE_FREEIMAGE addCmd ("vdir", VDir, /* [vdir] */ R"(
#define DUMP_FORMATS "{png|bmp|jpg|gif}" vdir [mask] [-list]
#else Lists all objects displayed in 3D viewer
#define DUMP_FORMATS "{ppm}" mask - name filter like prefix*
#endif -list - format list with new-line per name; OFF by default
theCommands.Add("vdump", )" /* [vdir] */);
"vdump <filename>." DUMP_FORMATS " [-width Width -height Height]"
"\n\t\t: [-buffer rgb|rgba|depth=rgb]"
"\n\t\t: [-stereo mono|left|right|blend|sideBySide|overUnder=mono]"
"\n\t\t: [-xrPose base|head|handLeft|handRight=base]"
"\n\t\t: [-tileSize Size=0]"
"\n\t\t: Dumps content of the active view into image file",
__FILE__,VDump,group);
theCommands.Add("vsub", "vsub 0/1 (off/on) [obj] : Subintensity(on/off) of selected objects", addCmd ("vdump", VDump, /* [vdump] */ R"(
__FILE__,VSubInt,group); vdump <filename>.png [-width Width -height Height]
[-buffer rgb|rgba|depth=rgb]
[-stereo mono|left|right|blend|sideBySide|overUnder=mono]
[-xrPose base|head|handLeft|handRight=base]
[-tileSize Size=0]
Dumps content of the active view into image file.
)" /* [vdump] */);
theCommands.Add("vaspects", addCmd ("vsub", VSubInt, /* [vsub] */ R"(
"vaspects [-noupdate|-update] [name1 [name2 [...]] | -defaults] [-subshapes subname1 [subname2 [...]]]" vsub 0/1 (off/on) [obj] : Subintensity(on/off) of selected objects
"\n\t\t: [-visibility {0|1}]" )" /* [vsub] */);
"\n\t\t: [-color {ColorName | R G B}] [-unsetColor]"
"\n\t\t: [-backfaceColor Color]"
"\n\t\t: [-material MatName] [-unsetMaterial]"
"\n\t\t: [-transparency Transp] [-unsetTransparency]"
"\n\t\t: [-width LineWidth] [-unsetWidth]"
"\n\t\t: [-lineType {solid|dash|dot|dotDash|0xHexPattern} [-stippleFactor factor]]"
"\n\t\t: [-unsetLineType]"
"\n\t\t: [-markerType {.|+|x|O|xcircle|pointcircle|ring1|ring2|ring3|ball|ImagePath}]"
"\n\t\t: [-unsetMarkerType]"
"\n\t\t: [-markerSize Scale] [-unsetMarkerSize]"
"\n\t\t: [-freeBoundary {0|1}]"
"\n\t\t: [-freeBoundaryWidth Width] [-unsetFreeBoundaryWidth]"
"\n\t\t: [-freeBoundaryColor {ColorName | R G B}] [-unsetFreeBoundaryColor]"
"\n\t\t: [-isoOnTriangulation 0|1]"
"\n\t\t: [-maxParamValue {value}]"
"\n\t\t: [-sensitivity {selection_mode} {value}]"
"\n\t\t: [-shadingModel {unlit|flat|gouraud|phong|pbr|pbr_facet}]"
"\n\t\t: [-unsetShadingModel]"
"\n\t\t: [-interior {solid|hatch|hidenline|point}] [-setHatch HatchStyle]"
"\n\t\t: [-unsetInterior]"
"\n\t\t: [-faceBoundaryDraw {0|1}] [-mostContinuity {c0|g1|c1|g2|c2|c3|cn}]"
"\n\t\t: [-faceBoundaryWidth LineWidth] [-faceBoundaryColor R G B] [-faceBoundaryType LineType]"
"\n\t\t: [-drawEdges {0|1}] [-edgeType LineType] [-edgeColor R G B] [-quadEdges {0|1}]"
"\n\t\t: [-drawSilhouette {0|1}]"
"\n\t\t: [-alphaMode {opaque|mask|blend|maskblend|blendauto} [alphaCutOff=0.5]]"
"\n\t\t: [-dumpJson]"
"\n\t\t: [-dumpCompact {0|1}]"
"\n\t\t: [-dumpDepth depth]"
"\n\t\t: Manage presentation properties of all, selected or named objects."
"\n\t\t: When -subshapes is specified than following properties will be assigned to specified sub-shapes."
"\n\t\t: When -defaults is specified than presentation properties will be"
"\n\t\t: assigned to all objects that have not their own specified properties"
"\n\t\t: and to all objects to be displayed in the future."
"\n\t\t: If -defaults is used there should not be any objects' names nor -subshapes specifier."
"\n\t\t: See also vlistcolors and vlistmaterials to list named colors and materials"
"\n\t\t: accepted by arguments -material and -color",
__FILE__,VAspects,group);
theCommands.Add("vsetcolor", addCmd ("vaspects", VAspects, /* [vaspects] */ R"(
"vsetcolor [-noupdate|-update] [name] ColorName" vaspects [-noupdate|-update] [name1 [name2 [...]] | -defaults] [-subshapes subname1 [subname2 [...]]]
"\n\t\t: Sets color for all, selected or named objects." [-visibility {0|1}]
"\n\t\t: Alias for vaspects -setcolor [name] ColorName.", [-color {ColorName | R G B}] [-unsetColor]
__FILE__,VAspects,group); [-backfaceColor Color]
[-material MatName] [-unsetMaterial]
[-transparency Transp] [-unsetTransparency]
[-width LineWidth] [-unsetWidth]
[-lineType {solid|dash|dot|dotDash|0xHexPattern} [-stippleFactor factor]]
[-unsetLineType]
[-markerType {.|+|x|O|xcircle|pointcircle|ring1|ring2|ring3|ball|ImagePath}]
[-unsetMarkerType]
[-markerSize Scale] [-unsetMarkerSize]
[-freeBoundary {0|1}]
[-freeBoundaryWidth Width] [-unsetFreeBoundaryWidth]
[-freeBoundaryColor {ColorName | R G B}] [-unsetFreeBoundaryColor]
[-isoOnTriangulation 0|1]
[-maxParamValue {value}]
[-sensitivity {selection_mode} {value}]
[-shadingModel {unlit|flat|gouraud|phong|pbr|pbr_facet}]
[-unsetShadingModel]
[-interior {solid|hatch|hidenline|point}] [-setHatch HatchStyle]
[-unsetInterior]
[-faceBoundaryDraw {0|1}] [-mostContinuity {c0|g1|c1|g2|c2|c3|cn}]
[-faceBoundaryWidth LineWidth] [-faceBoundaryColor R G B] [-faceBoundaryType LineType]
[-drawEdges {0|1}] [-edgeType LineType] [-edgeColor R G B] [-quadEdges {0|1}]
[-drawSilhouette {0|1}]
[-alphaMode {opaque|mask|blend|maskblend|blendauto} [alphaCutOff=0.5]]
[-dumpJson] [-dumpCompact {0|1}] [-dumpDepth depth]
Manage presentation properties of all, selected or named objects.
When -subshapes is specified than following properties will be assigned to specified sub-shapes.
When -defaults is specified than presentation properties will be
assigned to all objects that have not their own specified properties
and to all objects to be displayed in the future.
If -defaults is used there should not be any objects' names nor -subshapes specifier.
See also vlistcolors and vlistmaterials to list named colors and materials
accepted by arguments -material and -color
)" /* [vaspects] */);
theCommands.Add("vunsetcolor", addCmd ("vsetcolor", VAspects, /* [vsetcolor] */ R"(
"vunsetcolor [-noupdate|-update] [name]" vsetcolor [-noupdate|-update] [name] ColorName
"\n\t\t: Resets color for all, selected or named objects." Sets color for all, selected or named objects.
"\n\t\t: Alias for vaspects -unsetcolor [name].", Alias for vaspects -setcolor [name] ColorName.
__FILE__,VAspects,group); )" /* [vsetcolor] */);
theCommands.Add("vsettransparency", addCmd ("vunsetcolor", VAspects, /* [vunsetcolor] */ R"(
"vsettransparency [-noupdate|-update] [name] Coefficient" vunsetcolor [-noupdate|-update] [name]
"\n\t\t: Sets transparency for all, selected or named objects." Resets color for all, selected or named objects.
"\n\t\t: The Coefficient may be between 0.0 (opaque) and 1.0 (fully transparent)." Alias for vaspects -unsetcolor [name].
"\n\t\t: Alias for vaspects -settransp [name] Coefficient.", )" /* [vunsetcolor] */);
__FILE__,VAspects,group);
theCommands.Add("vunsettransparency", addCmd ("vsettransparency", VAspects, /* [vsettransparency] */ R"(
"vunsettransparency [-noupdate|-update] [name]" vsettransparency [-noupdate|-update] [name] Coefficient
"\n\t\t: Resets transparency for all, selected or named objects." Sets transparency for all, selected or named objects.
"\n\t\t: Alias for vaspects -unsettransp [name].", The Coefficient may be between 0.0 (opaque) and 1.0 (fully transparent).
__FILE__,VAspects,group); Alias for vaspects -settransp [name] Coefficient.
)" /* [vsettransparency] */);
theCommands.Add("vsetmaterial", addCmd ("vunsettransparency", VAspects, /* [vunsettransparency] */ R"(
"vsetmaterial [-noupdate|-update] [name] MaterialName" vunsettransparency [-noupdate|-update] [name]
"\n\t\t: Alias for vaspects -setmaterial [name] MaterialName.", Resets transparency for all, selected or named objects.
__FILE__,VAspects,group); Alias for vaspects -unsettransp [name].
)" /* [vunsettransparency] */);
theCommands.Add("vunsetmaterial", addCmd ("vsetmaterial", VAspects, /* [vsetmaterial] */ R"(
"vunsetmaterial [-noupdate|-update] [name]" vsetmaterial [-noupdate|-update] [name] MaterialName
"\n\t\t: Alias for vaspects -unsetmaterial [name].", n\t\t: Alias for vaspects -setmaterial [name] MaterialName.
__FILE__,VAspects,group); )" /* [vsetmaterial] */);
theCommands.Add("vsetwidth", addCmd ("vunsetmaterial", VAspects, /* [vunsetmaterial] */ R"(
"vsetwidth [-noupdate|-update] [name] width(0->10)" vunsetmaterial [-noupdate|-update] [name]
"\n\t\t: Alias for vaspects -setwidth [name] width.", Alias for vaspects -unsetmaterial [name].
__FILE__,VAspects,group); )" /* [vunsetmaterial] */);
theCommands.Add("vunsetwidth", addCmd ("vsetwidth", VAspects, /* [vsetwidth] */ R"(
"vunsetwidth [-noupdate|-update] [name]" vsetwidth [-noupdate|-update] [name] width(0->10)
"\n\t\t: Alias for vaspects -unsetwidth [name].", Alias for vaspects -setwidth [name] width.
__FILE__,VAspects,group); )" /* [vsetwidth] */);
theCommands.Add("vsetinteriorstyle", addCmd ("vunsetwidth", VAspects, /* [vunsetwidth] */ R"(
"vsetinteriorstyle [-noupdate|-update] [name] Style" vunsetwidth [-noupdate|-update] [name]
"\n\t\t: Alias for vaspects -setInterior [name] Style.", Alias for vaspects -unsetwidth [name].
__FILE__,VAspects,group); )" /* [vunsetwidth] */);
theCommands.Add ("vsetedgetype", addCmd ("vsetinteriorstyle", VAspects, /* [vsetinteriorstyle] */ R"(
"vsetedgetype [name] [-type {solid, dash, dot}] [-color R G B] [-width value]" vsetinteriorstyle [-noupdate|-update] [name] Style
"\n\t\t: Alias for vaspects [name] -setEdgeType Type.", Alias for vaspects -setInterior [name] Style.
__FILE__, VAspects, group); )" /* [vsetinteriorstyle] */);
theCommands.Add ("vunsetedgetype", addCmd ("vsetedgetype", VAspects, /* [vsetedgetype] */ R"(
"vunsetedgetype [name]" vsetedgetype [name] [-type {solid, dash, dot}] [-color R G B] [-width value]
"\n\t\t: Alias for vaspects [name] -unsetEdgeType.", Alias for vaspects [name] -setEdgeType Type.
__FILE__, VAspects, group); )" /* [vsetedgetype] */);
theCommands.Add ("vshowfaceboundary", addCmd ("vunsetedgetype", VAspects, /* [vunsetedgetype] */ R"(
"vshowfaceboundary [name]" vunsetedgetype [name] : Alias for vaspects [name] -unsetEdgeType.
"\n\t\t: Alias for vaspects [name] -setFaceBoundaryDraw on", )" /* [vunsetedgetype] */);
__FILE__, VAspects, group);
theCommands.Add("vsensdis", addCmd ("vshowfaceboundary", VAspects, /* [vshowfaceboundary] */ R"(
"vsensdis : Display active entities (sensitive entities of one of the standard types corresponding to active selection modes)." vshowfaceboundary [name]: Alias for vaspects [name] -setFaceBoundaryDraw on.
"\n\t\t: Standard entity types are those defined in Select3D package:" )" /* [vshowfaceboundary] */);
"\n\t\t: - sensitive box"
"\n\t\t: - sensitive face"
"\n\t\t: - sensitive curve"
"\n\t\t: - sensitive segment"
"\n\t\t: - sensitive circle"
"\n\t\t: - sensitive point"
"\n\t\t: - sensitive triangulation"
"\n\t\t: - sensitive triangle"
"\n\t\t: Custom(application - defined) sensitive entity types are not processed by this command.",
__FILE__,VDispSensi,group);
theCommands.Add("vsensera", addCmd ("vsensdis", VDispSensi, /* [vsensdis] */ R"(
"vsensera : erase active entities", vsensdis : Display active entities
__FILE__,VClearSensi,group); (sensitive entities of one of the standard types corresponding to active selection modes).
Standard entity types are those defined in Select3D package:
- sensitive box, face, curve, segment, circle, point, triangulation, triangle.
Custom (application-defined) sensitive entity types are not processed by this command.
)" /* [vsensdis] */);
theCommands.Add("vsetshading", addCmd ("vsensera", VClearSensi, /* [vsensera] */ R"(
"vsetshading : vsetshading name Quality(default=0.0008) " vsensera : erase active entities
"\n\t\t: Sets deflection coefficient that defines the quality of the shape representation in the shading mode.", )" /* [vsensera] */);
__FILE__,VShading,group);
theCommands.Add("vunsetshading", addCmd ("vsetshading", VShading, /* [vsetshading] */ R"(
"vunsetshading :vunsetshading name " vsetshading name Quality(default=0.0008)
"\n\t\t: Sets default deflection coefficient (0.0008) that defines the quality of the shape representation in the shading mode.", Sets deflection coefficient that defines the quality of the shape representation in the shading mode.
__FILE__,VShading,group); )" /* [vsetshading] */);
theCommands.Add ("vtexture", addCmd ("vunsetshading", VShading, /* [vunsetshading] */ R"(
"vtexture [-noupdate|-update] name [ImageFile|IdOfTexture|off]" vunsetshading name
"\n\t\t: [-tex0 Image0] [-tex1 Image1] [...]" Sets default deflection coefficient (0.0008) that defines the quality of the shape representation in the shading mode.
"\n\t\t: [-origin {u v|off}] [-scale {u v|off}] [-repeat {u v|off}]" )" /* [vunsetshading] */);
"\n\t\t: [-trsfTrans du dv] [-trsfScale su sv] [-trsfAngle Angle]"
"\n\t\t: [-modulate {on|off}] [-srgb {on|off}]=on"
"\n\t\t: [-setFilter {nearest|bilinear|trilinear}]"
"\n\t\t: [-setAnisoFilter {off|low|middle|quality}]"
"\n\t\t: [-default]"
"\n\t\t: The texture can be specified by filepath"
"\n\t\t: or as ID (0<=IdOfTexture<=20) specifying one of the predefined textures."
"\n\t\t: The options are:"
"\n\t\t: -scale Setup texture scaling for generating coordinates; (1, 1) by default"
"\n\t\t: -origin Setup texture origin for generating coordinates; (0, 0) by default"
"\n\t\t: -repeat Setup texture repeat for generating coordinates; (1, 1) by default"
"\n\t\t: -modulate Enable or disable texture color modulation"
"\n\t\t: -srgb Prefer sRGB texture format when applicable; TRUE by default"
"\n\t\t: -trsfAngle Setup dynamic texture coordinates transformation - rotation angle"
"\n\t\t: -trsfTrans Setup dynamic texture coordinates transformation - translation vector"
"\n\t\t: -trsfScale Setup dynamic texture coordinates transformation - scale vector"
"\n\t\t: -setFilter Setup texture filter"
"\n\t\t: -setAnisoFilter Setup anisotropic filter for texture with mip-levels"
"\n\t\t: -default Sets texture mapping default parameters",
__FILE__, VTexture, group);
theCommands.Add("vtexscale", addCmd ("vtexture", VTexture, /* [vtexture] */ R"(
"vtexscale name ScaleU ScaleV" vtexture [-noupdate|-update] name [ImageFile|IdOfTexture|off]
"\n\t\t: Alias for vtexture name -setScale ScaleU ScaleV.", [-tex0 Image0] [-tex1 Image1] [...]
__FILE__,VTexture,group); [-origin {u v|off}] [-scale {u v|off}] [-repeat {u v|off}]
[-trsfTrans du dv] [-trsfScale su sv] [-trsfAngle Angle]
[-modulate {on|off}] [-srgb {on|off}]=on
[-setFilter {nearest|bilinear|trilinear}]
[-setAnisoFilter {off|low|middle|quality}]
[-default]
The texture can be specified by filepath
or as ID (0<=IdOfTexture<=20) specifying one of the predefined textures.
The options are:
-scale Setup texture scaling for generating coordinates; (1, 1) by default
-origin Setup texture origin for generating coordinates; (0, 0) by default
-repeat Setup texture repeat for generating coordinates; (1, 1) by default
-modulate Enable or disable texture color modulation
-srgb Prefer sRGB texture format when applicable; TRUE by default
-trsfAngle Setup dynamic texture coordinates transformation - rotation angle
-trsfTrans Setup dynamic texture coordinates transformation - translation vector
-trsfScale Setup dynamic texture coordinates transformation - scale vector
-setFilter Setup texture filter
-setAnisoFilter Setup anisotropic filter for texture with mip-levels
-default Sets texture mapping default parameters
)" /* [vtexture] */);
theCommands.Add("vtexorigin", addCmd ("vtexscale", VTexture, /* [vtexscale] */ R"(
"vtexorigin name OriginU OriginV" vtexscale name ScaleU ScaleV
"\n\t\t: Alias for vtexture name -setOrigin OriginU OriginV.", Alias for vtexture name -setScale ScaleU ScaleV.
__FILE__,VTexture,group); )" /* [vtexscale] */);
theCommands.Add("vtexrepeat", addCmd ("vtexorigin", VTexture, /* [vtexorigin] */ R"(
"vtexrepeat name RepeatU RepeatV" vtexorigin name OriginU OriginV
"\n\t\t: Alias for vtexture name -setRepeat RepeatU RepeatV.", Alias for vtexture name -setOrigin OriginU OriginV.
__FILE__, VTexture, group); )" /* [vtexorigin] */);
theCommands.Add("vtexdefault", addCmd ("vtexrepeat", VTexture, /* [vtexrepeat] */ R"(
"vtexdefault name" vtexrepeat name RepeatU RepeatV
"\n\t\t: Alias for vtexture name -default.", Alias for vtexture name -setRepeat RepeatU RepeatV.
__FILE__, VTexture, group); )" /* [vtexrepeat] */);
theCommands.Add("vstate", addCmd ("vtexdefault", VTexture, /* [vtexdefault] */ R"(
"vstate [-entities] [-hasSelected] [name1] ... [nameN]" vtexdefault name : Alias for vtexture name -default.
"\n\t\t: Reports show/hidden state for selected or named objects" )" /* [vtexdefault] */);
"\n\t\t: -entities - print low-level information about detected entities"
"\n\t\t: -hasSelected - prints 1 if context has selected shape and 0 otherwise",
__FILE__,VState,group);
theCommands.Add("vpickshapes", addCmd ("vstate", VState, /* [vstate] */ R"(
"vpickshape subtype(VERTEX,EDGE,WIRE,FACE,SHELL,SOLID) [name1 or .] [name2 or .] [name n or .]" vstate [-entities] [-hasSelected] [name1] ... [nameN]
"\n\t\t: Hold Ctrl and pick object by clicking Left mouse button." Reports show/hidden state for selected or named objects.
"\n\t\t: Hold also Shift for multiple selection.", -entities prints low-level information about detected entities;
__FILE__, VPickShape, group); -hasSelected prints 1 if context has selected shape and 0 otherwise.
)" /* [vstate] */);
theCommands.Add("vtypes", addCmd ("vpickshapes", VPickShape, /* [vpickshapes] */ R"(
"vtypes : list of known types and signatures in AIS - To be Used in vpickobject command for selection with filters", vpickshape subtype(VERTEX,EDGE,WIRE,FACE,SHELL,SOLID) [name1 or .] [name2 or .] [name n or .]
__FILE__, VIOTypes, group); Hold Ctrl and pick object by clicking Left mouse button.
Hold also Shift for multiple selection.
)" /* [vpickshapes] */);
theCommands.Add("vselfilter", addCmd ("vtypes", VIOTypes, /* [vtypes] */ R"(
"vselfilter [-contextfilter {AND|OR}]" vtypes : list of known types and signatures in AIS.
"\n [-type {VERTEX|EDGE|WIRE|FACE|SHAPE|SHELL|SOLID}]" To be Used in vpickobject command for selection with filters.
"\n [-secondtype {VERTEX|EDGE|WIRE|FACE|SHAPE|SHELL|SOLID}]" )" /* [vtypes] */);
"\n [-clear]"
"\nSets selection shape type filter in context or remove all filters."
"\n : Option -contextfilter : To define a selection filter for two or more types of entity,"
"\n use value AND (OR by default)."
"\n : Option -type set type of selection filter. Filters are applied with Or combination."
"\n : Option -clear remove all filters in context",
__FILE__,VSelFilter,group);
theCommands.Add("vpickselected", "vpickselected [name]: extract selected shape.", addCmd ("vselfilter", VSelFilter, /* [vselfilter] */ R"(
__FILE__, VPickSelected, group); vselfilter [-contextfilter {AND|OR}]
[-type {VERTEX|EDGE|WIRE|FACE|SHAPE|SHELL|SOLID}]
[-secondtype {VERTEX|EDGE|WIRE|FACE|SHAPE|SHELL|SOLID}]
[-clear]
Sets selection shape type filter in context or remove all filters.
-contextfilter to define a selection filter for two or more types of entity,
use value AND (OR by default).
-type set type of selection filter; filters are applied with Or combination.
-clear remove all filters in context.
)" /* [vselfilter] */);
theCommands.Add ("vloadselection", addCmd ("vpickselected", VPickSelected, /* [vpickselected] */ R"(
"vloadselection [-context] [name1] ... [nameN] : allows to load selection" vpickselected [name]: extract selected shape.
"\n\t\t: primitives for the shapes with names given without displaying them.", )" /* [vpickselected] */);
__FILE__, VLoadSelection, group);
theCommands.Add("vbsdf", "vbsdf [name] [options]" addCmd ("vloadselection", VLoadSelection, /* [vloadselection] */ R"(
"\nAdjusts parameters of material BSDF:" vloadselection [-context] [name1] ... [nameN]
"\n -help : Shows this message" Allows to load selection primitives for the shapes with names given without displaying them.
"\n -print : Print BSDF" )" /* [vloadselection] */);
"\n -kd : Weight of the Lambertian BRDF"
"\n -kr : Weight of the reflection BRDF"
"\n -kt : Weight of the transmission BTDF"
"\n -ks : Weight of the glossy Blinn BRDF"
"\n -le : Self-emitted radiance"
"\n -fresnel : Fresnel coefficients; Allowed fresnel formats are: Constant x,"
"\n Schlick x y z, Dielectric x, Conductor x y"
"\n -roughness : Roughness of material (Blinn's exponent)"
"\n -absorpcoeff : Absorption coefficient (only for transparent material)"
"\n -absorpcolor : Absorption color (only for transparent material)"
"\n -normalize : Normalize BSDF coefficients",
__FILE__, VBsdf, group);
addCmd ("vbsdf", VBsdf, /* [vbsdf] */ R"(
vbsdf [name] [options]
nAdjusts parameters of material BSDF:
-help shows this message
-print print BSDF
-kd weight of the Lambertian BRDF
-kr weight of the reflection BRDF
-kt weight of the transmission BTDF
-ks weight of the glossy Blinn BRDF
-le self-emitted radiance
-fresnel Fresnel coefficients; Allowed fresnel formats are: Constant x,
Schlick x y z, Dielectric x, Conductor x y
-roughness roughness of material (Blinn's exponent)
-absorpcoeff absorption coefficient (only for transparent material)
-absorpcolor absorption color (only for transparent material)
-normalize normalize BSDF coefficients
)" /* [vbsdf] */);
} }
//============================================================================== //==============================================================================

697
src/ViewerTest/ViewerTest_ObjectCommands.cxx
View File

@ -6819,389 +6819,396 @@ static int VNormals (Draw_Interpretor& theDI,
void ViewerTest::ObjectCommands(Draw_Interpretor& theCommands) void ViewerTest::ObjectCommands(Draw_Interpretor& theCommands)
{ {
const char *group ="AISObjects"; 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 ("vtrihedron", addCmd ("vtrihedron", VTrihedron, /* [vtrihedron] */ R"(
"vtrihedron : vtrihedron name" vtrihedron name
"\n\t\t: [-dispMode {wireframe|shading} ]" [-dispMode {wireframe|shading} ]
"\n\t\t: [-origin x y z ]" [-origin x y z ]
"\n\t\t: [-zaxis u v w -xaxis u v w ]" [-zaxis u v w -xaxis u v w ]
"\n\t\t: [-drawAxes {X|Y|Z|XY|YZ|XZ|XYZ}]" [-drawAxes {X|Y|Z|XY|YZ|XZ|XYZ}]
"\n\t\t: [-hideLabels {on|off}]" [-hideLabels {on|off}]
"\n\t\t: [-hideArrows {on|off}]" [-hideArrows {on|off}]
"\n\t\t: [-label {XAxis|YAxis|ZAxis} value]" [-label {XAxis|YAxis|ZAxis} value]
"\n\t\t: [-attribute {XAxisLength|YAxisLength|ZAxisLength" [-attribute {XAxisLength|YAxisLength|ZAxisLength
"\n\t\t: |TubeRadiusPercent|ConeRadiusPercent" |TubeRadiusPercent|ConeRadiusPercent
"\n\t\t: |ConeLengthPercent|OriginRadiusPercent" |ConeLengthPercent|OriginRadiusPercent
"\n\t\t: |ShadingNumberOfFacettes} value]" |ShadingNumberOfFacettes} value]
"\n\t\t: [-color {Origin|XAxis|YAxis|ZAxis|XOYAxis|YOZAxis" [-color {Origin|XAxis|YAxis|ZAxis|XOYAxis|YOZAxis
"\n\t\t: |XOZAxis|Whole} {r g b | colorName}]" |XOZAxis|Whole} {r g b | colorName}]
"\n\t\t: [-textColor [XAxis|YAxis|ZAxis] {r g b | colorName}]" [-textColor [XAxis|YAxis|ZAxis] {r g b | colorName}]
"\n\t\t: [-arrowColor [XAxis|YAxis|ZAxis] {r g b | colorName}]" [-arrowColor [XAxis|YAxis|ZAxis] {r g b | colorName}]
"\n\t\t: [-priority {Origin|XAxis|YAxis|ZAxis|XArrow" [-priority {Origin|XAxis|YAxis|ZAxis|XArrow
"\n\t\t: |YArrow|ZArrow|XOYAxis|YOZAxis" |YArrow|ZArrow|XOYAxis|YOZAxis
"\n\t\t: |XOZAxis|Whole} value]" |XOZAxis|Whole} value]
"\n\t\t:"
"\n\t\t: Creates a new *AIS_Trihedron* object or changes parameters of "
"\n\t\t: existing trihedron. If no argument is set,"
"\n\t\t: the default trihedron (0XYZ) is created."
"\n\t\t: -dispMode mode of visualization: wf - wireframe,"
"\n\t\t: sh - shading."
"\n\t\t: Default value is wireframe."
"\n\t\t: -origin allows to set trihedron location."
"\n\t\t: -zaxis/-xaxis allows to set trihedron X and Z"
"\n\t\t: directions. The directions should"
"\n\t\t: be orthogonal. Y direction is calculated."
"\n\t\t: -drawAxes allows to set what axes are drawn in the"
"\n\t\t: trihedron, default state is XYZ"
"\n\t\t: -hideLabels allows to show/hide trihedron labels"
"\n\t\t: -hideArrows allows to show/hide trihedron arrows"
"\n\t\t: -label allows to change default X/Y/Z titles of axes"
"\n\t\t: -attribute sets parameters of trihedron"
"\n\t\t: -color sets color properties of parts of trihedron"
"\n\t\t: -textColor sets color properties of trihedron labels"
"\n\t\t: -arrowColor sets color properties of trihedron arrows"
"\n\t\t: -priority allows to change default selection priority"
"\n\t\t: of trihedron components",
__FILE__,VTrihedron,group);
theCommands.Add("vtri2d", Creates/changes *AIS_Trihedron* object.
"vtri2d Name" -dispMode mode of visualization: wf - wireframe,
"\n\t\t: Creates a plane with a 2D trihedron from an interactively selected face.", sh - shading;
__FILE__,VTrihedron2D ,group); default value is wireframe;
-origin allows to set trihedron location;
-zaxis/-xaxis allows to set trihedron X and Z directions;
the directions should be orthogonal;
Y direction is calculated;
-drawAxes allows to set what axes are drawn in the
trihedron, default state is XYZ;
-hideLabels allows to show/hide trihedron labels;
-hideArrows allows to show/hide trihedron arrows;
-label allows to change default X/Y/Z titles of axes;
-attribute sets parameters of trihedron;
-color sets color properties of parts of trihedron;
-textColor sets color properties of trihedron labels;
-arrowColor sets color properties of trihedron arrows;
-priority allows to change default selection priority
of trihedron components.
)" /* [vtrihedron] */);
theCommands.Add("vplanetri", addCmd ("vtri2d", VTrihedron2D, /* [vtri2d] */ R"(
"vplanetri name" vtri2d Name : Creates a plane with a 2D trihedron from an interactively selected face.
"\n\t\t: Create a plane from a trihedron selection. If no arguments are set, the default", )" /* [vtri2d] */);
__FILE__,VPlaneTrihedron ,group);
theCommands.Add("vsize", addCmd ("vplanetri", VPlaneTrihedron, /* [vplanetri] */ R"(
"vsize : vsize [name(Default=Current)] [size(Default=100)] " vplanetri name
"\n\t\t: Changes the size of a named or selected trihedron." Create a plane from a trihedron selection.
"\n\t\t: If the name is not defined: it affects the selected trihedrons otherwise nothing is done." If no arguments are set, the default plane is created.
"\n\t\t: If the value is not defined: it is set to 100 by default.", )" /* [vplanetri] */);
__FILE__,VSize,group);
theCommands.Add("vaxis", addCmd ("vsize", VSize, /* [vsize] */ R"(
"vaxis name [Xa] [Ya] [Za] [Xb] [Yb] [Zb]" vsize [name(Default=Current)] [size(Default=100)]
"\n\t\t: Creates an axis. If the values are not defined, an axis is created by interactive selection of two vertices or one edge", Changes the size of a named or selected trihedron.
__FILE__,VAxisBuilder,group); If the name is not defined: it affects the selected trihedrons otherwise nothing is done.
If the value is not defined: it is set to 100 by default.
)" /* [vsize] */);
theCommands.Add("vaxispara", addCmd ("vaxis", VAxisBuilder, /* [vaxis] */ R"(
"vaxispara name " vaxis name [Xa] [Ya] [Za] [Xb] [Yb] [Zb]
"\n\t\t: Creates an axis by interactive selection of an edge and a vertex.", Creates an axis. If the values are not defined,
__FILE__,VAxisBuilder,group); an axis is created by interactive selection of two vertices or one edge.
)" /* [vaxis] */);
theCommands.Add("vaxisortho", addCmd ("vaxispara", VAxisBuilder, /* [vaxispara] */ R"(
"vaxisortho name " vaxispara name
"\n\t\t: Creates an axis by interactive selection of an edge and a vertex. The axis will be orthogonal to the selected edge.", Creates an axis by interactive selection of an edge and a vertex.
__FILE__,VAxisBuilder,group); )" /* [vaxispara] */);
theCommands.Add("vpoint", addCmd ("vaxisortho", VAxisBuilder, /* [vaxisortho] */ R"(
"vpoint name [X Y [Z]] [-2d] [-nosel]" vaxisortho name
"\n\t\t: Creates a point from coordinates." Creates an axis by interactive selection of an edge and a vertex.
"\n\t\t: If the values are not defined, a point is created from selected vertex or edge (center)." The axis will be orthogonal to the selected edge.
"\n\t\t: -2d defines on-screen 2D point from top-left window corner" )" /* [vaxisortho] */);
"\n\t\t: -nosel creates non-selectable presentation",
__FILE__,VPointBuilder,group);
theCommands.Add("vplane", addCmd ("vpoint", VPointBuilder, /* [vpoint] */ R"(
"vplane PlaneName [AxisName/PlaneName/PointName] [PointName/PointName/PointName] [Nothing/Nothing/PointName] [TypeOfSensitivity {0|1}]" vpoint name [X Y [Z]] [-2d] [-nosel]
"\n\t\t: Creates a plane from named or interactively selected entities." Creates a point from coordinates.
"\n\t\t: TypeOfSensitivity:" If the values are not defined, a point is created from selected vertex or edge (center).
"\n\t\t: 0 - Interior" -2d defines on-screen 2D point from top-left window corner;
"\n\t\t: 1 - Boundary", -nosel creates non-selectable presentation.
__FILE__,VPlaneBuilder,group); )" /* [vpoint] */);
theCommands.Add ("vchangeplane", "vchangeplane usage: \n" addCmd ("vplane", VPlaneBuilder, /* [vplane] */ R"(
" vchangeplane <plane_name>" vplane PlaneName [AxisName/PlaneName/PointName]
" [x=center_x y=center_y z=center_z]" [PointName/PointName/PointName] [Nothing/Nothing/PointName] [TypeOfSensitivity {0|1}]
" [dx=dir_x dy=dir_y dz=dir_z]" Creates a plane from named or interactively selected entities. TypeOfSensitivity:
" [sx=size_x sy=size_y]" 0 - Interior;
" [minsize=value]" 1 - Boundary.
" [noupdate]\n" )" /* [vplane] */);
" - changes parameters of the plane:\n"
" - x y z - center\n"
" - dx dy dz - normal\n"
" - sx sy - plane sizes\n"
" - noupdate - do not update/redisplay the plane in context\n"
" Please enter coordinates in format \"param=value\" in arbitrary order.",
__FILE__, VChangePlane, group);
theCommands.Add("vplanepara", addCmd ("vchangeplane", VChangePlane, /* [vchangeplane] */ R"(
"vplanepara PlaneName " vchangeplane plane_name
"\n\t\t: Creates a plane from interactively selected vertex and face.", [x=center_x y=center_y z=center_z]
__FILE__,VPlaneBuilder,group); [dx=dir_x dy=dir_y dz=dir_z]
[sx=size_x sy=size_y]
[minsize=value]
[noupdate]
Changes parameters of the plane:
- x y z - center
- dx dy dz - normal
- sx sy - plane sizes
- noupdate - do not update/redisplay the plane in context
Please enter coordinates in format "param=value" in arbitrary order.
)" /* [vchangeplane] */);
theCommands.Add("vplaneortho", addCmd ("vplanepara", VPlaneBuilder, /* [vplanepara] */ R"(
"vplaneortho PlaneName " vplanepara PlaneName
"\n\t\t: Creates a plane from interactive selected face and coplanar edge. ", Creates a plane from interactively selected vertex and face.
__FILE__,VPlaneBuilder,group); )" /* [vplanepara] */);
theCommands.Add("vline", addCmd ("vplaneortho", VPlaneBuilder, /* [vplaneortho] */ R"(
"vline LineName [Xa/PointName] [Ya/PointName] [Za] [Xb] [Yb] [Zb] " vplaneortho PlaneName
"\n\t\t: Creates a line from coordinates, named or interactively selected vertices. ", Creates a plane from interactive selected face and coplanar edge.
__FILE__,VLineBuilder,group); )" /* [vplaneortho] */);
theCommands.Add("vcircle", addCmd ("vline", VLineBuilder, /* [vline] */ R"(
"vcircle CircleName [PointName PointName PointName IsFilled]\n\t\t\t\t\t[PlaneName PointName Radius IsFilled]" vline LineName [Xa/PointName] [Ya/PointName] [Za] [Xb] [Yb] [Zb]
"\n\t\t: Creates a circle from named or interactively selected entities." Creates a line from coordinates, named or interactively selected vertices.
"\n\t\t: Parameter IsFilled is defined as 0 or 1.", )" /* [vline] */);
__FILE__,VCircleBuilder,group);
theCommands.Add ("vdrawtext", addCmd ("vcircle", VCircleBuilder, /* [vcircle] */ R"(
"vdrawtext name text" vcircle CircleName [PointName PointName PointName IsFilled]
"\n\t\t: [-pos X=0 Y=0 Z=0]" [PlaneName PointName Radius IsFilled]
"\n\t\t: [-color {R G B|name}=yellow]" Creates a circle from named or interactively selected entities.
"\n\t\t: [-halign {left|center|right}=left]" Parameter IsFilled is defined as 0 or 1.
"\n\t\t: [-valign {top|center|bottom|topfirstline}=bottom}]" )" /* [vcircle] */);
"\n\t\t: [-angle angle=0]"
"\n\t\t: [-zoom {0|1}=0]"
"\n\t\t: [-height height=16]"
"\n\t\t: [-wrapping width=40]"
"\n\t\t: [-aspect {regular|bold|italic|boldItalic}=regular]"
"\n\t\t: [-font font=Times]"
"\n\t\t: [-2d]"
"\n\t\t: [-perspos {X Y Z}=0 0 0], where"
"\n\t\t X and Y define the coordinate origin in 2d space relative to the view window"
"\n\t\t Example: X=0 Y=0 is center, X=1 Y=1 is upper right corner etc..."
"\n\t\t Z coordinate defines the gap from border of view window (except center position)."
"\n\t\t: [-disptype {blend|decal|shadow|subtitle|dimension|normal}=normal}"
"\n\t\t: [-subcolor {R G B|name}=white]"
"\n\t\t: [-noupdate]"
"\n\t\t: [-plane NormX NormY NormZ DirX DirY DirZ]"
"\n\t\t: [-flipping]"
"\n\t\t: [-ownanchor {0|1}=1]"
"\n\t\t: Display text label at specified position.",
__FILE__, VDrawText, group);
theCommands.Add("vdrawsphere", addCmd ("vdrawtext", VDrawText, /* [vdrawtext] */ R"(
"vdrawsphere: vdrawsphere shapeName Fineness [X=0.0 Y=0.0 Z=0.0] [Radius=100.0] [ToShowEdges=0] [ToPrintInfo=1]\n", vdrawtext name text
__FILE__,VDrawSphere,group); [-pos X Y Z]={0 0 0}
[-color {R G B|name}]=yellow
[-halign {left|center|right}]=left
[-valign {top|center|bottom|topfirstline}}]=bottom
[-angle angle]=0
[-zoom {0|1}]=0
[-height height]=16
[-wrapping width]=40
[-aspect {regular|bold|italic|boldItalic}]=regular
[-font font]=Times
[-2d] [-perspos {X Y Z}]={0 0 0}
[-disptype {blend|decal|shadow|subtitle|dimension|normal}}=normal
[-subcolor {R G B|name}]=white
[-noupdate]
[-plane NormX NormY NormZ DirX DirY DirZ]
[-flipping] [-ownanchor {0|1}]=1
Display text label at specified position.
Within -perspos, X and Y define the coordinate origin in 2d space relative to the view window.
Example: X=0 Y=0 is center, X=1 Y=1 is upper right corner etc...
Z coordinate defines the gap from border of view window (except center position).
)" /* [vdrawtext] */);
theCommands.Add ("vlocation", addCmd ("vdrawsphere", VDrawSphere, /* [vdrawsphere] */ R"(
"vlocation name" vdrawsphere shapeName Fineness [X=0.0 Y=0.0 Z=0.0] [Radius=100.0] [ToShowEdges=0] [ToPrintInfo=1]
"\n\t\t: [-reset] [-copyFrom otherName]" )" /* [vdrawsphere] */);
"\n\t\t: [-translate X Y [Z]] [-rotate x y z dx dy dz angle] [-scale [X Y Z] scale]"
"\n\t\t: [-pretranslate X Y [Z]] [-prerotate x y z dx dy dz angle] [-prescale [X Y Z] scale]"
"\n\t\t: [-mirror x y z dx dy dz] [-premirror x y z dx dy dz]"
"\n\t\t: [-setLocation X Y [Z]] [-setRotation QX QY QZ QW] [-setScale [X Y Z] scale]"
"\n\t\t: Object local transformation management:"
"\n\t\t: -reset resets transformation to identity"
"\n\t\t: -translate applies translation vector"
"\n\t\t: -rotate applies rotation around axis"
"\n\t\t: -scale applies scale factor with optional anchor"
"\n\t\t: -mirror applies mirror transformation"
"\n\t\t: -pretranslate pre-multiplies translation vector"
"\n\t\t: -prerotate pre-multiplies rotation around axis"
"\n\t\t: -prescale pre-multiplies scale transformation"
"\n\t\t: -premirror pre-multiplies mirror transformation"
"\n\t\t: -setLocation overrides translation part"
"\n\t\t: -setRotation overrides rotation part with specified quaternion"
"\n\t\t: -setScale overrides scale factor",
__FILE__, VSetLocation, group);
theCommands.Add ("vsetlocation",
"alias for vlocation",
__FILE__, VSetLocation, group);
theCommands.Add ("vchild",
"vchild parent [-add] [-remove] [-ignoreParentTrsf {0|1}] child1 [child2] [...]"
"\n\t\t: Command for testing low-level presentation connections."
"\n\t\t: vconnect command should be used instead.",
__FILE__, VChild, group);
theCommands.Add("vparent",
"vparent parent [-ignoreVisu]"
"\n\t\t: Command for testing object properties as parent in the hierarchy."
"\n\t\t: Arguments:"
"\n\t\t: -ignoreVisu do not propagate the visual state (display/erase/color) to children objects",
__FILE__, VParent, group);
theCommands.Add ("vcomputehlr",
"vcomputehlr shapeInput hlrResult [-algoType {algo|polyAlgo}=polyAlgo]"
"\n\t\t: [eyeX eyeY eyeZ dirX dirY dirZ upX upY upZ]"
"\n\t\t: [-showTangentEdges {on|off}=off] [-nbIsolines N=0] [-showHiddenEdges {on|off}=off]"
"\n\t\t: Arguments:"
"\n\t\t: shapeInput - name of the initial shape"
"\n\t\t: hlrResult - result HLR object from initial shape"
"\n\t\t: eye, dir are eye position and look direction"
"\n\t\t: up is the look up direction vector"
"\n\t\t: -algoType HLR algorithm to use"
"\n\t\t: -showTangentEdges include tangent edges"
"\n\t\t: -nbIsolines include isolines"
"\n\t\t: -showHiddenEdges include hidden edges"
"\n\t\t: Use vtop to see projected HLR shape.",
__FILE__, VComputeHLR, group);
theCommands.Add("vdrawparray", addCmd ("vlocation", VSetLocation, /* [vlocation] */ R"(
"vdrawparray name TypeOfArray={points|segments|polylines|triangles" vlocation name
"\n\t\t: |trianglefans|trianglestrips|quads|quadstrips|polygons}" [-reset] [-copyFrom otherName]
"\n\t\t: [-deinterleaved|-mutable]" [-translate X Y [Z]] [-rotate x y z dx dy dz angle] [-scale [X Y Z] scale]
"\n\t\t: [vertex={'v' x y z [normal={'n' nx ny nz}] [color={'c' r g b}] [texel={'t' tx ty}]]" [-pretranslate X Y [Z]] [-prerotate x y z dx dy dz angle] [-prescale [X Y Z] scale]
"\n\t\t: [bound= {'b' nbVertices [bound_color={'c' r g b}]]" [-mirror x y z dx dy dz] [-premirror x y z dx dy dz]
"\n\t\t: [edge= {'e' vertexId]" [-setLocation X Y [Z]] [-setRotation QX QY QZ QW] [-setScale [X Y Z] scale]
"\n\t\t: [-shape shapeName] [-patch]" Object local transformation management:
"\n\t\t: Commands create an Interactive Object for specified Primitive Array definition (Graphic3d_ArrayOfPrimitives)" -reset resets transformation to identity
"\n\t\t: with the main purpose is covering various combinations by tests", -translate applies translation vector
__FILE__,VDrawPArray,group); -rotate applies rotation around axis
-scale applies scale factor with optional anchor
-mirror applies mirror transformation
-pretranslate pre-multiplies translation vector
-prerotate pre-multiplies rotation around axis
-prescale pre-multiplies scale transformation
-premirror pre-multiplies mirror transformation
-setLocation overrides translation part
-setRotation overrides rotation part with specified quaternion
-setScale overrides scale factor
)" /* [vlocation] */);
theCommands.Add("vconnect", addCmd ("vsetlocation", VSetLocation, /* [vsetlocation] */ R"(
"vconnect name Xo Yo Zo object1 object2 ... [color=NAME]" Alias for vlocation
"\n\t\t: Creates and displays AIS_ConnectedInteractive object from input object and location.", )" /* [vsetlocation] */);
__FILE__, VConnect, group);
theCommands.Add("vconnectto", addCmd ("vchild", VChild, /* [vchild] */ R"(
"vconnectto : instance_name Xo Yo Zo object [-nodisplay|-noupdate|-update]" vchild parent [-add] [-remove] [-ignoreParentTrsf {0|1}] child1 [child2] [...]
" Makes an instance 'instance_name' of 'object' with position (Xo Yo Zo)." Command for testing low-level presentation connections.
"\n\t\t: -nodisplay - only creates interactive object, but not displays it", vconnect command should be used instead.
__FILE__, VConnectTo,group); )" /* [vchild] */);
theCommands.Add("vdisconnect", addCmd ("vparent", VParent, /* [vparent] */ R"(
"vdisconnect assembly_name (object_name | object_number | 'all')" vparent parent [-ignoreVisu]
" Disconnects all objects from assembly or disconnects object by name or number (use vlistconnected to enumerate assembly children).", Command for testing object properties as parent in the hierarchy.
__FILE__,VDisconnect,group); -ignoreVisu do not propagate the visual state (display/erase/color) to children objects
)" /* [vparent] */);
theCommands.Add("vaddconnected", addCmd ("vcomputehlr", VComputeHLR, /* [vcomputehlr] */ R"(
"vaddconnected assembly_name object_name" vcomputehlr shapeInput hlrResult [-algoType {algo|polyAlgo}=polyAlgo]
"Adds object to assembly.", [eyeX eyeY eyeZ dirX dirY dirZ upX upY upZ]
__FILE__,VAddConnected,group); [-showTangentEdges {on|off}=off] [-nbIsolines N=0] [-showHiddenEdges {on|off}=off]
Arguments:
shapeInput - name of the initial shape
hlrResult - result HLR object from initial shape
eye, dir are eye position and look direction
up is the look up direction vector
-algoType HLR algorithm to use
-showTangentEdges include tangent edges
-nbIsolines include isolines
-showHiddenEdges include hidden edges
Use vtop to see projected HLR shape.
)" /* [vcomputehlr] */);
theCommands.Add("vlistconnected", addCmd ("vdrawparray", VDrawPArray, /* [vdrawparray] */ R"(
"vlistconnected assembly_name" vdrawparray name TypeOfArray={points|segments|polylines|triangles
"Lists objects in assembly.", |trianglefans|trianglestrips|quads|quadstrips|polygons}
__FILE__,VListConnected,group); [-deinterleaved|-mutable]
[vertex={'v' x y z [normal={'n' nx ny nz}] [color={'c' r g b}] [texel={'t' tx ty}]]
[bound= {'b' nbVertices [bound_color={'c' r g b}]]
[edge= {'e' vertexId]
[-shape shapeName] [-patch]
Commands create an Interactive Object for specified Primitive Array definition
with the main purpose is covering various combinations by tests.
)" /* [vdrawparray] */);
addCmd ("vconnect", VConnect, /* [vconnect] */ R"(
vconnect name Xo Yo Zo object1 object2 ... [color=NAME]
Creates and displays AIS_ConnectedInteractive object from input object and location.
)" /* [vconnect] */);
theCommands.Add("vselmode", addCmd ("vconnectto", VConnectTo, /* [vconnectto] */ R"(
"vselmode [object] selectionMode {on|off}" vconnectto instance_name Xo Yo Zo object [-nodisplay|-noupdate|-update]
"\n\t\t: [{-add|-set|-globalOrLocal}=-globalOrLocal]" Makes an instance 'instance_name' of 'object' with position (Xo Yo Zo).
"\n\t\t: Switches selection mode for the specified object or for all objects in context." -nodisplay - only creates interactive object, but not displays it.
"\n\t\t: Selection mode is either an integer number specific to Interactive Object," )" /* [vconnectto] */);
"\n\t\t: or sub-shape type in case of AIS_Shape:"
"\n\t\t: Shape, Vertex, Edge, Wire, Face, Shell, Solid, CompSolid, Compound"
"\n\t\t: The integer mode 0 (Shape in case of AIS_Shape) is reserved for selecting object as whole."
"\n\t\t: Additional options:"
"\n\t\t: -add already activated selection modes will be left activated"
"\n\t\t: -set already activated selection modes will be deactivated"
"\n\t\t: -globalOrLocal (default) if new mode is Global selection mode,"
"\n\t\t: then active local selection modes will be deactivated"
"\n\t\t: and the samthen active local selection modes will be deactivated",
__FILE__, VSetSelectionMode, group);
theCommands.Add("vselnext", addCmd ("vdisconnect", VDisconnect, /* [vdisconnect] */ R"(
"vselnext : hilight next detected", vdisconnect assembly_name {object_name|object_number|'all'}
__FILE__, VSelectionNext, group); Disconnects all objects from assembly or disconnects object by name or number.
Use vlistconnected to enumerate assembly children.
)" /* [vdisconnect] */);
theCommands.Add("vselprev", addCmd ("vaddconnected", VAddConnected, /* [vaddconnected] */ R"(
"vselnext : hilight previous detected", vaddconnected assembly_name object_name
__FILE__, VSelectionPrevious, group); Adds object to assembly.
)" /* [vaddconnected] */);
theCommands.Add("vtriangle", addCmd ("vlistconnected", VListConnected, /* [vlistconnected] */ R"(
"vtriangle Name PointName PointName PointName" vlistconnected assembly_name
"\n\t\t: Creates and displays a filled triangle from named points.", Lists objects in assembly.
__FILE__, VTriangle,group); )" /* [vlistconnected] */);
theCommands.Add("vsegment", addCmd ("vselmode", VSetSelectionMode, /* [vselmode] */ R"(
"vsegment Name PointName PointName" vselmode [object] selectionMode {on|off}
"\n\t\t: Creates and displays a segment from named points.", [{-add|-set|-globalOrLocal}=-globalOrLocal]
__FILE__, VTriangle,group); Switches selection mode for the specified object or for all objects in context.
Selection mode is either an integer number specific to Interactive Object,
or sub-shape type in case of AIS_Shape:
Shape, Vertex, Edge, Wire, Face, Shell, Solid, CompSolid, Compound
The integer mode 0 (Shape in case of AIS_Shape) is reserved for selecting object as whole.
Additional options:
-add already activated selection modes will be left activated
-set already activated selection modes will be deactivated
-globalOrLocal (default) if new mode is Global selection mode,
then active local selection modes will be deactivated
and the samthen active local selection modes will be deactivated
)" /* [vselmode] */);
theCommands.Add ("vtorus", addCmd ("vselnext", VSelectionNext, /* [vselnext] */ R"(
"vtorus name [R1 R2 [Angle1=0 Angle2=360] [Angle=360]]" vselnext : hilight next detected
"\n\t\t: [-radius R1] [-pipeRadius R2]" )" /* [vselnext] */);
"\n\t\t: [-pipeAngle Angle=360] [-segmentAngle1 Angle1=0 -segmentAngle2 Angle2=360]"
"\n\t\t: [-nbSlices Number=100] [-nbStacks Number=100] [-noupdate]"
"\n\t\t: Creates and displays a torus or torus segment."
"\n\t\t: Parameters of the torus :"
"\n\t\t: - R1 distance from the center of the pipe to the center of the torus"
"\n\t\t: - R2 radius of the pipe"
"\n\t\t: - Angle1 first angle to create a torus ring segment"
"\n\t\t: - Angle2 second angle to create a torus ring segment"
"\n\t\t: - Angle angle to create a torus pipe segment",
__FILE__, VTorus, group);
theCommands.Add ("vcylinder", addCmd ("vselprev", VSelectionPrevious, /* [vselprev] */ R"(
"vcylinder name [R1 R2 Height] [-height H] [-radius R] [-bottomRadius R1 -topRadius R2]" vselnext : hilight previous detected
"\n\t\t: [-nbSlices Number=100] [-noupdate]" )" /* [vselprev] */);
"\n\t\t: Creates and displays a cylinder."
"\n\t\t: Parameters of the cylinder :"
"\n\t\t: - R1 cylinder bottom radius"
"\n\t\t: - R2 cylinder top radius"
"\n\t\t: - Height cylinder height",
__FILE__, VCylinder, group);
theCommands.Add ("vsphere", addCmd ("vtriangle", VTriangle, /* [vtriangle] */ R"(
"vsphere name [-radius] R" vtriangle Name PointName PointName PointName
"\n\t\t: [-nbSlices Number=100] [-nbStacks Number=100] [-noupdate]" Creates and displays a filled triangle from named points.
"\n\t\t: Creates and displays a sphere.", )" /* [vtriangle] */);
__FILE__, VSphere, group);
theCommands.Add("vobjzlayer", addCmd ("vsegment", VTriangle, /* [vsegment] */ R"(
"vobjzlayer : set/get object [layerid] - set or get z layer id for the interactive object", vsegment Name PointName PointName
__FILE__, VObjZLayer, group); Creates and displays a segment from named points.
)" /* [vsegment] */);
theCommands.Add("vpolygonoffset", addCmd ("vtorus", VTorus, /* [vtorus] */ R"(
"vpolygonoffset : [object [mode factor units]] - sets/gets polygon offset parameters for an object, without arguments prints the default values", vtorus name [R1 R2 [Angle1=0 Angle2=360] [Angle=360]]
__FILE__, VPolygonOffset, group); [-radius R1] [-pipeRadius R2]
[-pipeAngle Angle=360] [-segmentAngle1 Angle1=0 -segmentAngle2 Angle2=360]
[-nbSlices Number=100] [-nbStacks Number=100] [-noupdate]
Creates and displays a torus or torus segment.
Parameters of the torus:
- R1 distance from the center of the pipe to the center of the torus
- R2 radius of the pipe
- Angle1 first angle to create a torus ring segment
- Angle2 second angle to create a torus ring segment
- Angle angle to create a torus pipe segment
)" /* [vtorus] */);
theCommands.Add ("vmarkerstest", addCmd ("vcylinder", VCylinder, /* [vcylinder] */ R"(
"vmarkerstest: name X Y Z [PointsOnSide=10] [MarkerType=0] [Scale=1.0] [FileName=ImageFile]\n", vcylinder name [R1 R2 Height] [-height H] [-radius R] [-bottomRadius R1 -topRadius R2]
__FILE__, VMarkersTest, group); [-nbSlices Number=100] [-noupdate]
Creates and displays a cylinder.
Parameters of the cylinder:
- R1 cylinder bottom radius
- R2 cylinder top radius
- Height cylinder height
)" /* [vcylinder] */);
theCommands.Add ("text2brep", addCmd ("vsphere", VSphere, /* [vsphere] */ R"(
"text2brep: name text" vsphere name [-radius] R
"\n\t\t: [-pos X=0 Y=0 Z=0]" [-nbSlices Number=100] [-nbStacks Number=100] [-noupdate]
"\n\t\t: [-halign {left|center|right}=left]" Creates and displays a sphere.
"\n\t\t: [-valign {top|center|bottom|topfirstline}=bottom}]" )" /* [vsphere] */);
"\n\t\t: [-height height=16]"
"\n\t\t: [-aspect {regular|bold|italic|boldItalic}=regular]"
"\n\t\t: [-font font=Courier] [-strict {strict|aliases|any}=any]"
"\n\t\t: [-composite {on|off}=off]"
"\n\t\t: [-plane NormX NormY NormZ DirX DirY DirZ]",
__FILE__, TextToBRep, group);
theCommands.Add ("vfont",
"vfont [-add pathToFont [fontName] [regular,bold,italic,boldItalic=undefined] [singleStroke]]"
"\n\t\t: [-strict {any|aliases|strict}] [-find fontName [regular,bold,italic,boldItalic=undefined]] [-verbose {on|off}]"
"\n\t\t: [-findAll fontNameMask] [-findInfo fontName]"
"\n\t\t: [-unicodeFallback {on|off}]"
"\n\t\t: [-clear] [-init] [-list] [-names]"
"\n\t\t: [-aliases [aliasName]] [-addAlias Alias FontName] [-removeAlias Alias FontName] [-clearAlias Alias] [-clearAliases]"
"\n\t\t: Work with font registry - register font, list available fonts, find font."
"\n\t\t: -findAll is same as -find, but can print more than one font when mask is passed."
"\n\t\t: -findInfo is same as -find, but prints complete font information instead of family name.",
__FILE__, VFont, group);
theCommands.Add ("vvertexmode", addCmd ("vobjzlayer", VObjZLayer, /* [vobjzlayer] */ R"(
"vvertexmode [name | -set {isolated | all | inherited} [name1 name2 ...]]\n" vobjzlayer : set/get object [layerid] - set or get z layer id for the interactive object
"vvertexmode - prints the default vertex draw mode\n" )" /* [vobjzlayer] */);
"vvertexmode name - prints the vertex draw mode of the given object\n"
"vvertexmode -set {isolated | all | inherited} - sets the default vertex draw mode and updates the mode for all displayed objects\n"
"vvertexmode -set {isolated | all | inherited} name1 name2 ... - sets the vertex draw mode for the specified object(s)\n",
__FILE__, VVertexMode, group);
theCommands.Add ("vpointcloud", addCmd ("vpolygonoffset", VPolygonOffset, /* [vpolygonoffset] */ R"(
"vpointcloud name shape [-randColor] [-normals] [-noNormals] [-uv]" vpolygonoffset [object [mode factor units]]
"\n\t\t: Create an interactive object for arbitrary set of points" Sets/gets polygon offset parameters for an object; without arguments prints the default values
"\n\t\t: from triangulated shape." )" /* [vpolygonoffset] */);
"\n"
"vpointcloud name x y z r npts {surface|volume}\n"
" ... [-randColor] [-normals] [-noNormals] [-uv]"
"\n\t\t: Create arbitrary set of points (npts) randomly distributed"
"\n\t\t: on spheric surface or within spheric volume (x y z r)."
"\n\t\t:"
"\n\t\t: Additional options:"
"\n\t\t: -randColor - generate random color per point"
"\n\t\t: -normals - generate normal per point (default)"
"\n\t\t: -noNormals - do not generate normal per point"
"\n",
__FILE__, VPointCloud, group);
theCommands.Add("vpriority", addCmd ("vmarkerstest", VMarkersTest, /* [vmarkerstest] */ R"(
"vpriority [-noupdate|-update] name [value]\n\t\t prints or sets the display priority for an object", vmarkerstest: name X Y Z [PointsOnSide=10] [MarkerType=0] [Scale=1.0] [FileName=ImageFile]
__FILE__, )" /* [vmarkerstest] */);
VPriority, group);
theCommands.Add ("vnormals", addCmd ("text2brep", TextToBRep, /* [text2brep] */ R"(
"vnormals usage:\n" text2brep name text"
"vnormals Shape [{on|off}=on] [-length {10}] [-nbAlongU {1}] [-nbAlongV {1}] [-nbAlong {1}]" [-pos X=0 Y=0 Z=0]"
"\n\t\t: [-useMesh] [-oriented {0}1}=0]" [-halign {left|center|right}=left]"
"\n\t\t: Displays/Hides normals calculated on shape geometry or retrieved from triangulation", [-valign {top|center|bottom|topfirstline}=bottom}]"
__FILE__, VNormals, group); [-height height=16]"
[-aspect {regular|bold|italic|boldItalic}=regular]"
[-font font=Courier] [-strict {strict|aliases|any}=any]"
[-composite {on|off}=off]"
[-plane NormX NormY NormZ DirX DirY DirZ]",
)" /* [text2brep] */);
addCmd ("vfont", VFont, /* [vfont] */ R"(
vfont [-add pathToFont [fontName] [regular,bold,italic,boldItalic=undefined] [singleStroke]]
[-strict {any|aliases|strict}] [-find fontName [regular,bold,italic,boldItalic=undefined]]
[-verbose {on|off}]
[-findAll fontNameMask] [-findInfo fontName]
[-unicodeFallback {on|off}]
[-clear] [-init] [-list] [-names]
[-aliases [aliasName]] [-addAlias Alias FontName] [-removeAlias Alias FontName]
[-clearAlias Alias] [-clearAliases]
Work with font registry - register font, list available fonts, find font.
-findAll is same as -find, but can print more than one font when mask is passed.
-findInfo is same as -find, but prints complete font information instead of family name.
)" /* [vfont] */);
addCmd ("vvertexmode", VVertexMode, /* [vvertexmode] */ R"(
vvertexmode [name | -set {isolated|all|inherited} [name1 name2 ...]]
Sets the vertex draw mode for the specified object(s)
or sets default vertex draw mode and updates the mode for all displayed objects.
Prints the default vertex draw mode without -set parameter.
)" /* [vvertexmode] */);
addCmd ("vpointcloud", VPointCloud, /* [vpointcloud] */ R"(
vpointcloud name shape [-randColor] [-normals] [-noNormals] [-uv]
Create an interactive object for arbitrary set of points from triangulated shape.
vpointcloud name x y z r npts {surface|volume}
... [-randColor] [-normals] [-noNormals] [-uv]
Create arbitrary set of points (npts) randomly distributed
on spheric surface or within spheric volume (x y z r).
Additional options:
-randColor - generate random color per point
-normals - generate normal per point (default)
-noNormals - do not generate normal per point
)" /* [vpointcloud] */);
addCmd ("vpriority", VPriority, /* [vpriority] */ R"(
vpriority [-noupdate|-update] name [value]
Prints or sets the display priority for an object.
)" /* [vpriority] */);
addCmd ("vnormals", VNormals, /* [vnormals] */ R"(
vnormals Shape [{on|off}=on] [-length {10}] [-nbAlongU {1}] [-nbAlongV {1}] [-nbAlong {1}]
[-useMesh] [-oriented {0}1}=0]
Displays/Hides normals calculated on shape geometry or retrieved from triangulation
)" /* [vnormals] */);
} }

99
src/ViewerTest/ViewerTest_OpenGlCommands.cxx
View File

@ -1161,48 +1161,61 @@ static Standard_Integer VGenEnvLUT (Draw_Interpretor&,
void ViewerTest::OpenGlCommands(Draw_Interpretor& theCommands) void ViewerTest::OpenGlCommands(Draw_Interpretor& theCommands)
{ {
const char* aGroup ="Commands for low-level TKOpenGl features"; 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("vimmediatefront", addCmd ("vimmediatefront", VImmediateFront, /* [vimmediatefront] */ R"(
"vimmediatefront : render immediate mode to front buffer or to back buffer", vimmediatefront : render immediate mode to front buffer or to back buffer
__FILE__, VImmediateFront, aGroup); )" /* [vimmediatefront] */);
theCommands.Add("vglinfo",
"vglinfo [-short|-basic|-complete] [-lineWidth Value=80]" addCmd ("vglinfo", VGlInfo, /* [vglinfo] */ R"(
"\n\t\t: [GL_VENDOR] [GL_RENDERER] [GL_VERSION]" vglinfo [-short|-basic|-complete] [-lineWidth Value=80]
"\n\t\t: [GL_SHADING_LANGUAGE_VERSION] [GL_EXTENSIONS]" [GL_VENDOR] [GL_RENDERER] [GL_VERSION]
"\n\t\t: print OpenGL info." [GL_SHADING_LANGUAGE_VERSION] [GL_EXTENSIONS]
"\n\t\t: -lineWidth split values longer than specified value into multiple lines;" Print OpenGL info.
"\n\t\t: -1 disables splitting.", -lineWidth split values longer than specified value into multiple lines;
__FILE__, VGlInfo, aGroup); -1 disables splitting.
theCommands.Add("vshader", )" /* [vglinfo] */);
"vshader name -vert VertexShader -frag FragmentShader [-geom GeometryShader]"
"\n\t\t: [-off] [-phong] [-aspect {shading|line|point|text}=shading]" addCmd ("vshader", VShaderProg, /* [vshader] */ R"(
"\n\t\t: [-header VersionHeader]" vshader name -vert VertexShader -frag FragmentShader [-geom GeometryShader]
"\n\t\t: [-tessControl TessControlShader -tesseval TessEvaluationShader]" [-off] [-phong] [-aspect {shading|line|point|text}=shading]
"\n\t\t: [-uniform Name FloatValue]" [-header VersionHeader]
"\n\t\t: Assign custom GLSL program to presentation aspects.", [-tessControl TessControlShader -tessEval TessEvaluationShader]
__FILE__, VShaderProg, aGroup); [-uniform Name FloatValue]
theCommands.Add("vshaderprog", "Alias for vshader", __FILE__, VShaderProg, aGroup); Assign custom GLSL program to presentation aspects.
theCommands.Add("vlistmaterials", )" /* [vshader] */);
"vlistmaterials [*] [MaterialName1 [MaterialName2 [...]]] [dump.obj|dump.html]"
"\n\t\t: Without arguments, command prints the list of standard materials." addCmd ("vshaderprog", VShaderProg, /* [vshaderprog] */ R"(
"\n\t\t: Otherwise, properties of specified materials will be printed" Alias for vshader
"\n\t\t: or dumped into specified file." )" /* [vshaderprog] */);
"\n\t\t: * can be used to refer to complete list of standard materials.",
__FILE__, VListMaterials, aGroup); addCmd ("vlistmaterials", VListMaterials, /* [vlistmaterials] */ R"(
theCommands.Add("vlistcolors", vlistmaterials [*] [MaterialName1 [MaterialName2 [...]]] [dump.obj|dump.html]
"vlistcolors [*] [ColorName1 [ColorName2 [...]]] [dump.html]" Without arguments, command prints the list of standard materials.
"\n\t\t: Without arguments, command prints the list of standard colors." Otherwise, properties of specified materials will be printed
"\n\t\t: Otherwise, properties of specified colors will be printed" or dumped into specified file.
"\n\t\t: or dumped into specified file." * can be used to refer to complete list of standard materials.
"\n\t\t: * can be used to refer to complete list of standard colors.", )" /* [vlistmaterials] */);
__FILE__, VListColors, aGroup);
theCommands.Add("vgenenvlut", addCmd ("vlistcolors", VListColors, /* [vlistcolors] */ R"(
"vgenenvlut [-size size = 128] [-nbsamples nbsamples = 1024]" vlistcolors [*] [ColorName1 [ColorName2 [...]]] [dump.html]
"\n\t\t: Generates PBR environment look up table." Without arguments, command prints the list of standard colors.
"\n\t\t: Saves it as C++ source file which is expected to be included in code." Otherwise, properties of specified colors will be printed
"\n\t\t: The path where result will be located is 'Graphic3d_TextureRoot::TexturesFolder()'." or dumped into specified file.
"\n\t\t: -size size of one side of resulted square table" * can be used to refer to complete list of standard colors.
"\n\t\t: -nbsamples number of samples used in Monte-Carlo integration", )" /* [vlistcolors] */);
__FILE__, VGenEnvLUT, aGroup);
addCmd ("vgenenvlut", VGenEnvLUT, /* [vgenenvlut] */ R"(
vgenenvlut [-size size = 128] [-nbsamples nbsamples = 1024]
Generates PBR environment look up table.
Saves it as C++ source file which is expected to be included in code.
The path where result will be located is 'Graphic3d_TextureRoot::TexturesFolder()'.
-size size of one side of resulted square table
-nbsamples number of samples used in Monte-Carlo integration
)" /* [vgenenvlut] */);
} }

155
src/ViewerTest/ViewerTest_RelationCommands.cxx
View File

@ -1924,86 +1924,89 @@ static int VMoveDim (Draw_Interpretor& theDi, Standard_Integer theArgNum, const
void ViewerTest::RelationCommands(Draw_Interpretor& theCommands) 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", addCmd ("vdimension", VDimBuilder, /* [vdimension] */ R"(
"vdimension name {-angle|-length|-radius|-diameter}" vdimension name {-angle|-length|-radius|-diameter}
"[-shapes shape1 [shape2 [shape3]]\n" [-shapes shape1 [shape2 [shape3]]
"[-selected]\n" [-selected]
"[-text 3d|2d wf|sh|wireframe|shading IntegerSize]\n" [-text 3d|2d wf|sh|wireframe|shading IntegerSize]
"[-font FontName]\n" [-font FontName]
"[-label left|right|hcenter|hfit top|bottom|vcenter|vfit]\n" [-label left|right|hcenter|hfit top|bottom|vcenter|vfit]
"[-arrow external|internal|fit]\n" [-arrow external|internal|fit]
"[-zoomablearrow]\n" [-zoomablearrow]
"[{-arrowlength|-arlen} RealArrowLength]\n" [{-arrowlength|-arlen} RealArrowLength]
"[{-arrowangle|-arangle} ArrowAngle(degrees)]\n" [{-arrowangle|-arangle} ArrowAngle(degrees)]
"[-plane xoy|yoz|zox]\n" [-plane xoy|yoz|zox]
"[-flyout FloatValue -extension FloatValue]\n" [-flyout FloatValue -extension FloatValue]
"[-autovalue]\n" [-autovalue]
"[-value CustomRealValue]\n" [-value CustomRealValue]
"[-textvalue CustomTextValue]\n" [-textvalue CustomTextValue]
"[-dispunits DisplayUnitsString]\n" [-dispunits DisplayUnitsString]
"[-modelunits ModelUnitsString]\n" [-modelunits ModelUnitsString]
"[-showunits | -hideunits]\n" [-showunits | -hideunits]
" -Builds angle, length, radius and diameter dimensions.\n" Builds angle, length, radius and diameter dimensions.
" -See also: vdimparam, vmovedim.\n", See also: vdimparam, vmovedim.
__FILE__,VDimBuilder,group); )" /* [vdimension] */);
theCommands.Add ("vrelation", addCmd ("vrelation", VRelationBuilder, /* [vrelation] */ R"(
"vrelation name {-concentric|-equaldistance|-equalradius|-fix|-identic|-offset|-parallel|-perpendicular|-tangent|-symmetric}" vrelation name {-concentric|-equaldistance|-equalradius|-fix|
"\n\t\t: concentric - 2 circled edges." -identic|-offset|-parallel|-perpendicular|-tangent|-symmetric}
"\n\t\t: equaldistance - 4 vertex/edges." Builds specific relation from selected objects:
"\n\t\t: equalradius - 1 or 2 circled edges." -concentric - 2 circled edges
"\n\t\t: fix - 1 edge." -equaldistance - 4 vertex/edges
"\n\t\t: identic - 2 faces, edges or vertices." -equalradius - 1 or 2 circled edges
"\n\t\t: offset - 2 faces." -fix - 1 edge
"\n\t\t: parallel - 2 faces or 2 edges." -identic - 2 faces, edges or vertices
"\n\t\t: perpendicular - 2 faces or 2 edges." -offset - 2 faces
"\n\t\t: tangent - two coplanar edges (first the circular edge then the tangent edge) or two faces." -parallel - 2 faces or 2 edges
"\n\t\t: symmetric - 3 edges or 1 edge and 2 vertices." -perpendicular - 2 faces or 2 edges
"-Builds specific relation from selected objects.", -tangent - two coplanar edges (first the circular edge then the tangent edge) or two faces
__FILE__, VRelationBuilder, group); -symmetric - 3 edges or 1 edge and 2 vertices
)" /* [vrelation] */);
theCommands.Add("vdimparam", addCmd ("vdimparam", VDimParam, /* [vdimparam] */ R"(
"vdimparam name" vdimparam name
"[-text 3d|2d wf|sh|wireframe|shading IntegerSize]\n" [-text 3d|2d wf|sh|wireframe|shading IntegerSize]
"[-font FontName]\n" [-font FontName]
"[-label left|right|hcenter|hfit top|bottom|vcenter|vfit]\n" [-label left|right|hcenter|hfit top|bottom|vcenter|vfit]
"[-arrow external|internal|fit]\n" [-arrow external|internal|fit]
"[-zoomablearrow 0|1]\n" [-zoomablearrow 0|1]
"[{-arrowlength|-arlen} RealArrowLength]\n" [{-arrowlength|-arlen} RealArrowLength]
"[{-arrowangle|-arangle} ArrowAngle(degrees)]\n" [{-arrowangle|-arangle} ArrowAngle(degrees)]
"[-plane xoy|yoz|zox]\n" [-plane xoy|yoz|zox]
"[-flyout FloatValue -extension FloatValue]\n" [-flyout FloatValue -extension FloatValue]
"[-value CustomNumberValue]\n" [-value CustomNumberValue]
"[-textvalue CustomTextValue]\n" [-textvalue CustomTextValue]
"[-dispunits DisplayUnitsString]\n" [-dispunits DisplayUnitsString]
"[-modelunits ModelUnitsString]\n" [-modelunits ModelUnitsString]
"[-showunits | -hideunits]\n" [-showunits | -hideunits]
" -Sets parameters for angle, length, radius and diameter dimensions.\n" Sets parameters for angle, length, radius and diameter dimensions.
" -See also: vmovedim, vdimension.\n", See also: vmovedim, vdimension.
__FILE__,VDimParam,group); )" /* [vdimparam] */);
theCommands.Add("vlengthparam", addCmd ("vlengthparam", VLengthParam, /* [vlengthparam] */ R"(
"vlengthparam name" vlengthparam name [-direction {ox|oy|oz|x y z|autodirection}]
"[-direction {ox|oy|oz|x y z|autodirection}]\n" Sets parameters for length dimension.
" -Sets parameters for length dimension.\n" See also: vdimparam, vdimension.
" -See also: vdimparam, vdimension.\n", )" /* [vlengthparam] */);
__FILE__,VLengthParam,group);
theCommands.Add("vangleparam", addCmd ("vangleparam", VAngleParam, /* [vangleparam] */ R"(
"vangleparam name" vangleparam name [-type interior|exterior]
"[-type interior|exterior]\n" [-showarrow first|second|both|none]
"[-showarrow first|second|both|none]\n" Sets parameters for angle dimension.
" -Sets parameters for angle dimension.\n" See also: vdimparam, vdimension.
" -See also: vdimparam, vdimension.\n", )" /* [vangleparam] */);
__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 ("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] */);
} }

1835
src/ViewerTest/ViewerTest_ViewerCommands.cxx
View File

File diff suppressed because it is too large Load Diff