mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-09-03 14:10:33 +03:00
0026533: Draw command vdisplay requires vclear to update the presentation since OCC 6.9.0.
Update documentation related to vdisplay command and similar.
This commit is contained in:
@@ -5479,9 +5479,11 @@ void ViewerTest::Commands(Draw_Interpretor& theCommands)
|
||||
__FILE__, visos, group);
|
||||
|
||||
theCommands.Add("vdisplay",
|
||||
"vdisplay [-noupdate|-update] [-local] [-mutable] [-overlay|-underlay]"
|
||||
"\n\t\t: [-trsfPers flags] [-trsfPersPos X Y [Z]] [-3d|-2d|-2dTopDown]"
|
||||
"vdisplay [-noupdate|-update] [-local] [-mutable] [-neutral]"
|
||||
"\n\t\t: [-trsfPers {pan|zoom|rotate|trihedron|full|none}=none] [-trsfPersPos X Y [Z]] [-3d|-2d|-2dTopDown]"
|
||||
"\n\t\t: [-dispMode mode] [-highMode mode]"
|
||||
"\n\t\t: [-layer index] [-top|-topmost|-overlay|-underlay]"
|
||||
"\n\t\t: [-redisplay]"
|
||||
"\n\t\t: name1 [name2] ... [name n]"
|
||||
"\n\t\t: Displays named objects."
|
||||
"\n\t\t: Option -local enables displaying of objects in local"
|
||||
@@ -5489,12 +5491,19 @@ void ViewerTest::Commands(Draw_Interpretor& theCommands)
|
||||
"\n\t\t: if there is not any."
|
||||
"\n\t\t: -noupdate suppresses viewer redraw call."
|
||||
"\n\t\t: -mutable enables optimizations for mutable objects."
|
||||
"\n\t\t: -overlay draws objects in overlay."
|
||||
"\n\t\t: -underlay draws objects in underlay."
|
||||
"\n\t\t: -neutral draws objects in main viewer."
|
||||
"\n\t\t: -layer sets z-layer for objects. It can use -overlay|-underlay|-top|-topmost instead of -layer index for the default z-layers."
|
||||
"\n\t\t: -top draws objects on top of main presentations but below topmost."
|
||||
"\n\t\t: -topmost draws in overlay for 3D presentations with independent Depth."
|
||||
"\n\t\t: -overlay draws objects in overlay for 2D presentations (On-Screen-Display)."
|
||||
"\n\t\t: -underlay draws objects in underlay for 2D presentations (On-Screen-Display)."
|
||||
"\n\t\t: -selectable|-noselect controls selection of objects."
|
||||
"\n\t\t: -trsfPers sets a transform persistence flags."
|
||||
"\n\t\t: -trsfPers sets a transform persistence flags. Flag 'full' is pan, zoom and rotate."
|
||||
"\n\t\t: -trsfPersPos sets an anchor point for transform persistence."
|
||||
"\n\t\t: -2d|-2dTopDown displays object in screen coordinates.",
|
||||
"\n\t\t: -2d|-2dTopDown displays object in screen coordinates."
|
||||
"\n\t\t: -dispmode sets display mode for objects."
|
||||
"\n\t\t: -highmode sets hilight mode for objects."
|
||||
"\n\t\t: -redisplay recomputes presentation of objects.",
|
||||
__FILE__, VDisplay2, group);
|
||||
|
||||
theCommands.Add ("vupdate",
|
||||
@@ -5670,11 +5679,22 @@ void ViewerTest::Commands(Draw_Interpretor& theCommands)
|
||||
__FILE__,VSetInteriorStyle,group);
|
||||
|
||||
theCommands.Add("vsensdis",
|
||||
"vardisp : display active entities",
|
||||
__FILE__,VDispSensi,group);
|
||||
"vsensdis : Display active entities (sensitive entities of one of the standard types corresponding to active selection modes)."
|
||||
"\n\t\t: Standard entity types are those defined in Select3D package:"
|
||||
"\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",
|
||||
"vardisp : erase active entities",
|
||||
__FILE__,VClearSensi,group);
|
||||
"vsensera : erase active entities",
|
||||
__FILE__,VClearSensi,group);
|
||||
|
||||
theCommands.Add("vselprecision",
|
||||
"vselprecision [-unset] [tolerance_value]"
|
||||
@@ -5683,20 +5703,23 @@ void ViewerTest::Commands(Draw_Interpretor& theCommands)
|
||||
__FILE__,VSelPrecision,group);
|
||||
|
||||
theCommands.Add("vperf",
|
||||
"vperf: vperf ShapeName 1/0(Transfo/Location) 1/0(Primitives sensibles ON/OFF)",
|
||||
__FILE__,VPerf,group);
|
||||
"vperf: vperf ShapeName 1/0(Transfo/Location) 1/0(Primitives sensibles ON/OFF)"
|
||||
"\n\t\t: Tests the animation of an object along a predefined trajectory.",
|
||||
__FILE__,VPerf,group);
|
||||
|
||||
theCommands.Add("vanimation",
|
||||
"vanimation CrankArmFile CylinderHeadFile PropellerFile EngineBlockFile",
|
||||
__FILE__,VAnimation,group);
|
||||
|
||||
theCommands.Add("vsetshading",
|
||||
"vsetshading : vsetshading name Quality(default=0.0008) ",
|
||||
__FILE__,VShading,group);
|
||||
"vsetshading : vsetshading name Quality(default=0.0008) "
|
||||
"\n\t\t: Sets deflection coefficient that defines the quality of the shape<70>s representation in the shading mode.",
|
||||
__FILE__,VShading,group);
|
||||
|
||||
theCommands.Add("vunsetshading",
|
||||
"vunsetshading :vunsetshading name ",
|
||||
__FILE__,VShading,group);
|
||||
"vunsetshading :vunsetshading name "
|
||||
"\n\t\t: Sets default deflection coefficient (0.0008) that defines the quality of the shape<70>s representation in the shading mode.",
|
||||
__FILE__,VShading,group);
|
||||
|
||||
theCommands.Add ("vtexture",
|
||||
"\n'vtexture NameOfShape [TextureFile | IdOfTexture]\n"
|
||||
@@ -5743,12 +5766,22 @@ void ViewerTest::Commands(Draw_Interpretor& theCommands)
|
||||
VTexture,group);
|
||||
|
||||
theCommands.Add("vsetam",
|
||||
"vsetActivatedModes: vsetam mode(1->7) ",
|
||||
__FILE__,VActivatedMode,group);
|
||||
"vsetam [shapename] mode"
|
||||
"\n\t\t: Activates selection mode for all selected or named shapes."
|
||||
"\n\t\t: Mod can be:"
|
||||
"\n\t\t: 0 - for shape itself"
|
||||
"\n\t\t: 1 - vertices"
|
||||
"\n\t\t: 2 - edges"
|
||||
"\n\t\t: 3 - wires"
|
||||
"\n\t\t: 4 - faces"
|
||||
"\n\t\t: 5 - shells"
|
||||
"\n\t\t: 6 - solids"
|
||||
"\n\t\t: 7 - compounds"
|
||||
__FILE__,VActivatedMode,group);
|
||||
|
||||
theCommands.Add("vunsetam",
|
||||
"vunsetActivatedModes: vunsetam ",
|
||||
__FILE__,VActivatedMode,group);
|
||||
"vunsetam : Deactivates all selection modes for all shapes.",
|
||||
__FILE__,VActivatedMode,group);
|
||||
|
||||
theCommands.Add("vstate",
|
||||
"vstate [-entities] [-hasSelected] [name1] ... [nameN]"
|
||||
@@ -5765,7 +5798,9 @@ void ViewerTest::Commands(Draw_Interpretor& theCommands)
|
||||
"vtypes : list of known types and signatures in AIS - To be Used in vpickobject command for selection with filters",
|
||||
VIOTypes,group);
|
||||
|
||||
theCommands.Add("vr", "vr : reading of the shape",
|
||||
theCommands.Add("vr",
|
||||
"vr filename"
|
||||
"\n\t\t: Reads shape from BREP-format file and displays it in the viewer. ",
|
||||
__FILE__,vr, group);
|
||||
|
||||
theCommands.Add("vpickselected", "vpickselected [name]: extract selected shape.",
|
||||
|
@@ -6224,39 +6224,54 @@ void ViewerTest::ObjectCommands(Draw_Interpretor& theCommands)
|
||||
{
|
||||
const char *group ="AISObjects";
|
||||
theCommands.Add("vtrihedron",
|
||||
"vtrihedron : vtrihedron name [Xo] [Yo] [Zo] [Zu] [Zv] [Zw] [Xu] [Xv] [Xw] ",
|
||||
"vtrihedron : vtrihedron name [Xo] [Yo] [Zo] [Zu] [Zv] [Zw] [Xu] [Xv] [Xw] "
|
||||
"\n\t\t: Creates a new *AIS_Trihedron* object. If no argument is set, the default trihedron (0XYZ) is created.",
|
||||
__FILE__,VTrihedron,group);
|
||||
|
||||
theCommands.Add("vtri2d",
|
||||
"vtri2d Name Selection in the viewer only ",
|
||||
"vtri2d Name"
|
||||
"\n\t\t: Creates a plane with a 2D trihedron from an interactively selected face.",
|
||||
__FILE__,VTrihedron2D ,group);
|
||||
|
||||
theCommands.Add("vplanetri",
|
||||
"vplanetri Name Selection in the viewer only ",
|
||||
"vplanetri name"
|
||||
"\n\t\t: Create a plane from a trihedron selection. If no arguments are set, the default",
|
||||
__FILE__,VPlaneTrihedron ,group);
|
||||
|
||||
theCommands.Add("vsize",
|
||||
"vsize : vsize [name(Default=Current)] [size(Default=100)] ",
|
||||
"vsize : vsize [name(Default=Current)] [size(Default=100)] "
|
||||
"\n\t\t: Changes the size of a named or selected trihedron."
|
||||
"\n\t\t: If the name is not defined: it affects the selected trihedrons otherwise nothing is done."
|
||||
"\n\t\t: If the value is not defined: it is set to 100 by default.",
|
||||
__FILE__,VSize,group);
|
||||
|
||||
theCommands.Add("vaxis",
|
||||
"vaxis nom [Xa] [Ya] [Za] [Xb] [Yb] [Zb]",
|
||||
"vaxis name [Xa] [Ya] [Za] [Xb] [Yb] [Zb]"
|
||||
"\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",
|
||||
__FILE__,VAxisBuilder,group);
|
||||
|
||||
theCommands.Add("vaxispara",
|
||||
"vaxispara nom ",
|
||||
"vaxispara name "
|
||||
"\n\t\t: Creates an axis by interactive selection of an edge and a vertex.",
|
||||
__FILE__,VAxisBuilder,group);
|
||||
|
||||
theCommands.Add("vaxisortho",
|
||||
"vaxisotho nom ",
|
||||
"vaxisortho 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.",
|
||||
__FILE__,VAxisBuilder,group);
|
||||
|
||||
theCommands.Add("vpoint",
|
||||
"vpoint PointName [Xa] [Ya] [Za] ",
|
||||
"vpoint PointName [Xa] [Ya] [Za] "
|
||||
"\n\t\t: Creates a point from coordinates. If the values are not defined,"
|
||||
"\n\t\t: a point is created by interactive selection of a vertice or an edge (in the center of the edge).",
|
||||
__FILE__,VPointBuilder,group);
|
||||
|
||||
theCommands.Add("vplane",
|
||||
"vplane PlaneName [AxisName/PlaneName/PointName] [PointName/PointName/PointName] [Nothing/Nothing/PointName] [TypeOfSensitivity]",
|
||||
"vplane PlaneName [AxisName/PlaneName/PointName] [PointName/PointName/PointName] [Nothing/Nothing/PointName] [TypeOfSensitivity {0|1}]"
|
||||
"\n\t\t: Creates a plane from named or interactively selected entities."
|
||||
"\n\t\t: TypeOfSensitivity:"
|
||||
"\n\t\t: 0 - Interior"
|
||||
"\n\t\t: 1 - Boundary",
|
||||
__FILE__,VPlaneBuilder,group);
|
||||
|
||||
theCommands.Add ("vchangeplane", "vchangeplane usage: \n"
|
||||
@@ -6274,19 +6289,24 @@ void ViewerTest::ObjectCommands(Draw_Interpretor& theCommands)
|
||||
__FILE__, VChangePlane, group);
|
||||
|
||||
theCommands.Add("vplanepara",
|
||||
"vplanepara PlaneName ",
|
||||
"vplanepara PlaneName "
|
||||
"\n\t\t: Creates a plane from interactively selected vertex and face.",
|
||||
__FILE__,VPlaneBuilder,group);
|
||||
|
||||
theCommands.Add("vplaneortho",
|
||||
"vplaneortho PlaneName ",
|
||||
"vplaneortho PlaneName "
|
||||
"\n\t\t: Creates a plane from interactive selected face and coplanar edge. ",
|
||||
__FILE__,VPlaneBuilder,group);
|
||||
|
||||
theCommands.Add("vline",
|
||||
"vline: vline LineName [Xa/PointName] [Ya/PointName] [Za] [Xb] [Yb] [Zb] ",
|
||||
"vline LineName [Xa/PointName] [Ya/PointName] [Za] [Xb] [Yb] [Zb] "
|
||||
"\n\t\t: Creates a line from coordinates, named or interactively selected vertices. ",
|
||||
__FILE__,VLineBuilder,group);
|
||||
|
||||
theCommands.Add("vcircle",
|
||||
"vcircle CircleName [PointName PointName PointName IsFilled]\n\t\t\t\t\t[PlaneName PointName Radius IsFilled]",
|
||||
"vcircle CircleName [PointName PointName PointName IsFilled]\n\t\t\t\t\t[PlaneName PointName Radius IsFilled]"
|
||||
"\n\t\t: Creates a circle from named or interactively selected entities."
|
||||
"\n\t\t: Parameter IsFilled is defined as 0 or 1.",
|
||||
__FILE__,VCircleBuilder,group);
|
||||
|
||||
theCommands.Add ("vdrawtext",
|
||||
@@ -6331,8 +6351,8 @@ void ViewerTest::ObjectCommands(Draw_Interpretor& theCommands)
|
||||
__FILE__,VDrawPArray,group);
|
||||
|
||||
theCommands.Add("vconnect",
|
||||
"vconnect : assembly_name Xo Yo Zo object1 object2 ..."
|
||||
" Makes an assembly of object instances located in point (Xo Yo Zo).",
|
||||
"vconnect name Xo Yo Zo object1 object2 ... [color=NAME]"
|
||||
"\n\t\t: Creates and displays AIS_ConnectedInteractive object from input object and location.",
|
||||
__FILE__, VConnect, group);
|
||||
|
||||
theCommands.Add("vconnectto",
|
||||
@@ -6387,11 +6407,13 @@ void ViewerTest::ObjectCommands(Draw_Interpretor& theCommands)
|
||||
__FILE__, VSelectionPrevious, group);
|
||||
|
||||
theCommands.Add("vtriangle",
|
||||
"vtriangle Name PointName PointName PointName",
|
||||
"vtriangle Name PointName PointName PointName"
|
||||
"\n\t\t: Creates and displays a filled triangle from named points.",
|
||||
__FILE__, VTriangle,group);
|
||||
|
||||
theCommands.Add("vsegment",
|
||||
"vsegment Name PointName PointName",
|
||||
"vsegment Name PointName PointName"
|
||||
"\n\t\t: Creates and displays a segment from named points.",
|
||||
__FILE__, VSegment,group);
|
||||
|
||||
theCommands.Add("vobjzlayer",
|
||||
|
@@ -2864,8 +2864,10 @@ void ViewerTest::RelationCommands(Draw_Interpretor& theCommands)
|
||||
__FILE__,VSymmetricBuilder ,group);
|
||||
|
||||
theCommands.Add("vmovedim",
|
||||
"vmovedim [name] [x y z]: moves picked or named (if name defined) "
|
||||
"dimension to picked mouse position or input point.",
|
||||
"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);
|
||||
|
||||
}
|
||||
|
@@ -8750,7 +8750,8 @@ void ViewerTest::ViewerCommands(Draw_Interpretor& theCommands)
|
||||
"vrepaint : vrepaint, force redraw",
|
||||
__FILE__,VRepaint,group);
|
||||
theCommands.Add("vclear",
|
||||
"vclear : vclear",
|
||||
"vclear : vclear"
|
||||
"\n\t\t: remove all the object from the viewer",
|
||||
__FILE__,VClear,group);
|
||||
theCommands.Add("vsetbg",
|
||||
"vsetbg : vsetbg imagefile [filltype] : Load image as background",
|
||||
@@ -8970,7 +8971,9 @@ void ViewerTest::ViewerCommands(Draw_Interpretor& theCommands)
|
||||
"- 1) single click selection\n"
|
||||
"- 2) selection with rectangle having corners at pixel positions (x1,y1) and (x2,y2)\n"
|
||||
"- 3) selection with polygon having corners in pixel positions (x1,y1), (x2,y2),...,(xn,yn)\n"
|
||||
"- 4) -allowoverlap determines will partially included objects be selected in rectangular selection"
|
||||
"- 4) -allowoverlap manages overlap and inclusion detection in rectangular selection.\n"
|
||||
" If the flag is set to 1, both sensitives that were included completely and overlapped partially by defined rectangle will be detected,\n"
|
||||
" otherwise algorithm will chose only fully included sensitives. Default behavior is to detect only full inclusion. "
|
||||
" (partial inclusion - overlap - is not allowed by default)\n"
|
||||
"- 5) any of these selections with shift button pressed",
|
||||
__FILE__, VSelect, group);
|
||||
@@ -9004,7 +9007,8 @@ void ViewerTest::ViewerCommands(Draw_Interpretor& theCommands)
|
||||
"- gets or sets ZClipping mode, width and depth",
|
||||
__FILE__,VZClipping,group);
|
||||
theCommands.Add ("vnbselected",
|
||||
"vnbselected", __FILE__, VNbSelected, group);
|
||||
"vnbselected"
|
||||
"\n\t\t: Returns number of selected objects", __FILE__, VNbSelected, group);
|
||||
theCommands.Add ("vcamera",
|
||||
"vcamera [-ortho] [-projtype]"
|
||||
"\n\t\t: [-persp]"
|
||||
@@ -9040,7 +9044,8 @@ void ViewerTest::ViewerCommands(Draw_Interpretor& theCommands)
|
||||
" vzrange [znear] [zfar] - applies provided values to view",
|
||||
__FILE__,VZRange, group);
|
||||
theCommands.Add("vantialiasing",
|
||||
"vantialiasing 1|0",
|
||||
"vantialiasing 1|0"
|
||||
"\n\t\t: Switches altialiasing on or off",
|
||||
__FILE__,VAntialiasing,group);
|
||||
theCommands.Add ("vpurgedisplay",
|
||||
"vpurgedisplay"
|
||||
|
Reference in New Issue
Block a user