Fix for the bug bug IPAL22851: Sub-shapes spelling

This commit is contained in:
ana 2012-01-13 12:25:13 +00:00
parent 7d247af0ad
commit 12e003c944
23 changed files with 73 additions and 73 deletions

View File

@ -16,7 +16,7 @@ The \b Result will be any \b GEOM_Object.
<b>TUI Command:</b> <em>geompy.MakeCommon(s1, s2)</em>
<b>Arguments:</b> Name + 2 shapes.
<b>Advanced option:</b>
\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
\image html bool2.png

View File

@ -11,7 +11,7 @@ Entity - > Build - > Compound</b>.
\n <b>TUI Command:</b> <em>geompy.MakeCompound(ListOfShape)</em>
\n <b>Arguments:</b> Name + List of shapes.
\n <b>Advanced option:</b>
\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
\image html neo-obj7.png

View File

@ -2,12 +2,12 @@
\page create_explode_page Explode
\n To \b Explode an object into subshapes, in the <b>Main Menu</b>
\n To \b Explode an object into sub-shapes, in the <b>Main Menu</b>
select <b>New Entity > Explode</b>.
\n To create a list of subshapes (vertices, edges, wires etc.) of the
\n To create a list of sub-shapes (vertices, edges, wires etc.) of the
given shape using the \b Explode operation, you need to define the <b>Main
Object</b>, which will be exploded and the <b>Type of Subshapes</b> you wish to
Object</b>, which will be exploded and the <b>Type of Sub-shapes</b> you wish to
obtain from it.
\n The \b Result of the operation will be a List of \b GEOM_Objects
(vertexes, edges, wires, faces, shells or solids).
@ -16,19 +16,19 @@ obtain from it.
variety of ways:
<ul>
<li><em>geompy.ExtractShapes(Shape, Type, isSorted)</em> explodes a
Shape into subshapes of a given Type and returns a List of sub-shapes.
Shape into sub-shapes of a given Type and returns a List of sub-shapes.
This method does not return the Shape itself if it matches the
Type.</li>
<li><em>geompy.SubShapeAll(Shape, Type)</em> explodes a Shape on
subshapes of a given Type and returns a List of sub-shapes.</li>
sub-shapes of a given Type and returns a List of sub-shapes.</li>
<li><em>geompy.SubShapeAllIDs(Shape, Type)</em> explodes a Shape on
subshapes of a given Type and returns a List of IDs of
sub-shapes of a given Type and returns a List of IDs of
sub-shapes.</li>
<li><em>geompy.SubShapeAllSortedCentres(Shape, Type)</em> explodes a
shape on subshapes of a given type and sorts them by coordinates of
shape on sub-shapes of a given type and sorts them by coordinates of
their gravity centers, returning a list of sub-shapes.</li>
<li><em>geompy.SubShapeAllSortedCentresIDs(Shape, Type)</em> explodes
a shape on subshapes of a given type and sorts them by coordinates of
a shape on sub-shapes of a given type and sorts them by coordinates of
their gravity centers, returning a List of IDs of sub-shapes.</li>
<li><em>geompy.SubShape(Shape, Type, ListOfInd)</em> allows to obtain
a compound of sub-shapes of the Shape, selected by they indices in a

View File

@ -8,7 +8,7 @@
selecting them in the object browser or in the viewer holding Shift
button.
It is possible to select wires or edges from objects. To specify subshape type, use
It is possible to select wires or edges from objects. To specify sub-shape type, use
the <b>Object Type</b> radio buttons.
Select \b Tolerance which will be used to check the

View File

@ -14,7 +14,7 @@ This operation cuts a shape with another one.
The \b Result will be any \b GEOM_Object.
<b>Arguments:</b> Name + 2 shapes.
<b>Advanced option:</b>
\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
<b>Dialog Box:</b>

View File

@ -17,7 +17,7 @@ The \b Result will be any \b GEOM_Object.
<b>TUI Command:</b> <em>geompy.MakeFuse(s1, s2)</em>
<b>Arguments:</b> Name + 2 shapes.
<b>Advanced option:</b>
\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
\image html bool1.png

View File

@ -9,7 +9,7 @@ given tolerance value.
\n <b>Arguments:</b> Name + Compound of shapes + Tolerance value.
\n <b>Advanced option:</b>
\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
\n The \b Result will be a \b GEOM_Object.
@ -40,14 +40,14 @@ The selected edges will be marked in white.
\n where \em theShape is a compound of shapes to be glued, \em
theTolerance is a maximum distance between two edges, which can
be considered as coincident. The \b Result will be a list of \b
GEOM_Objects, containing one sub shape per each detected set of
coincident sub shapes.
GEOM_Objects, containing one sub-shape per each detected set of
coincident sub-shapes.
\n <em>geompy.MakeGlueEdgesByList(theShape,theTolerance,theEdges)</em>,
\n where \em theShape is a compound of shapes to be glued, \em
theTolerance is a maximum distance between two edges, which can
be considered as coincident, \em theEdges is a list of
subshapes to be glued.
sub-shapes to be glued.
\n <b>Example:</b>

View File

@ -10,7 +10,7 @@ given tolerance value.
\n <b>Arguments:</b> Name + Compound of shapes + Tolerance value.
\n <b>Advanced option:</b>
\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
\n The \b Result will be a \b GEOM_Object.
\image html glue1.png
@ -47,14 +47,14 @@ checkbox.
\n where \em theShape is a compound of shapes to be glued, \em
theTolerance is a maximum distance between two faces, which can
be considered as coincident. The \b Result will be a list of \b
GEOM_Objects, containing one sub shape per each detected set of
coincident sub shapes.
GEOM_Objects, containing one sub-shape per each detected set of
coincident sub-shapes.
\n <em>geompy.MakeGlueFacesByList(theShape,theTolerance,theFaces,doKeepNonSolids,doGlueAllEdges)</em>,
\n where \em theShape is a compound of shapes to be glued, \em
theTolerance is a maximum distance between two faces, which can
be considered as coincident, \em theFaces is a list of
subshapes to be glued. The \em doKeepNonSolids flag allows to throw
sub-shapes to be glued. The \em doKeepNonSolids flag allows to throw
away non-solids from the result, if false. The \em doGlueAllEdges
allows to glue all edges, not only owned by glued faces. The \b
Result will be a new \b GEOM_Object.

View File

@ -13,7 +13,7 @@ with the origin of the Local Coordinate System.
will be removed.
\n <b>Arguments:</b> Name + one or several objects + End Coordinate System.
\n <b>Advanced option:</b>
\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
\image html transformation5.png
@ -34,7 +34,7 @@ otherwise it will be removed.
\n <b>Arguments:</b> Name + one or several objects + Start Coordinate System + End
Coordinate System.
\n <b>Advanced option:</b>
\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
\image html transformation6.png
@ -58,13 +58,13 @@ The third algorithm modifies the location of an object using the Path object (Wi
and the Distance parameter (ranging from 0 to 1) defining how far the object will move along the path.
\n <b>Create a copy</b> checkbox allows to keep the initial object,
otherwise it will be removed.
\n <b>Select Unpublished edges</b> checkbox allows to select subshape edges on
\n <b>Select Unpublished edges</b> checkbox allows to select sub-shape edges on
the other objects.
\n <b>Reverse Direction</b> checkbox allows to REVERSE the direction of the object movement along its path.
<b>Arguments:</b> Name + one or several objects + Translation path.
\n <b>Advanced option:</b>
\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
\image html transformation13.png

View File

@ -16,7 +16,7 @@ the offset.
\n <b>Arguments:</b> Name + Object (face(s), shell(s), solid(s)) +
Offset value
\n <b>Advanced option:</b>
\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
\image html transformation11.png

View File

@ -51,7 +51,7 @@ sub-shapes will not be performed. In this case the Partition algorithm
will work faster, but the result might differ from the default behavior.
<b>Advanced option:</b>
\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
\note Partition is a complex operation, so its result of it depends
on the quality of the initial shapes. Sometimes, if partition fails,
@ -88,7 +88,7 @@ previous versions of SALOME.
<b>Arguments:</b> Name + 1 shape to be intersected + 1 cutting plane.
<b>Advanced option:</b>
\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
<b>TUI Command:</b>

View File

@ -16,7 +16,7 @@ and <em>doUnionFaces</em> is a boolean parameter, that regulates,
whether the faces, sharing a common surface, should be united.
\n <b>Arguments:</b> Name + one shape + a flag.
\n <b>Advanced option:</b>
\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
\image html remove_extra_edges.png

View File

@ -2,13 +2,13 @@
\page restore_presentation_parameters_page Advanced Transformation Options
<br><center><b>Set presentation parameters and subshapes from arguments</b></center>
<br><center><b>Set presentation parameters and sub-shapes from arguments</b></center>
\n This option allows the operation result to inherit color
and subshapes from its arguments.
and sub-shapes from its arguments.
\n To activate this functionality, check in "Set
presentation parameters and subshapes from arguments" checkbox in the
presentation parameters and sub-shapes from arguments" checkbox in the
corresponding dialog.
\n For example, there exist two objects: Box_1 with two published
@ -23,7 +23,7 @@ We create a Cut of Box_1 with Cylinder_1.
\image html restore-ss-cut.png
The resulting shape inherits the subshapes and the colour of Box_1.
The resulting shape inherits the sub-shapes and the colour of Box_1.
\image html restore-ss-viewer-cut.png "The resulting shape"
@ -35,30 +35,30 @@ We create a Common of Box_1 and Cylinder_1.
\image html restore-ss-dialog.png
\n The resulting object is created with several subshapes that correspond to the
operation arguments and their published subshapes. The resulting shape
has a default color, but its subshapes inherit colors corresponding
to arguments and their subshapes.
\n The resulting object is created with several sub-shapes that correspond to the
operation arguments and their published sub-shapes. The resulting shape
has a default color, but its sub-shapes inherit colors corresponding
to arguments and their sub-shapes.
\image html restore-ss-viewer-after.png "The resulting shape"
Please, note that when the resulting shape corresponds to one
argument, the inherited subshapes depend directly on the resulting shape.
argument, the inherited sub-shapes depend directly on the resulting shape.
\image html restore-ss-OB-cut.png
When the resulting shape is composed from multiple arguments, the
inherited subshapes depend on the arguments.
inherited sub-shapes depend on the arguments.
\image html restore-ss-OB.png
\n You can also call this functionality from your python scripts.
See our <b>TUI Scripts</b> for \ref tui_restore_prs_params "example".
<br><center><b>Add prefix to names of restored subshapes</b></center>
<br><center><b>Add prefix to names of restored sub-shapes</b></center>
This option allows adding the prefix "from_" to the names of
restored sub-shapes, and the prefix "from_subshapes_of_" to the names of partially restored subshapes.
restored sub-shapes, and the prefix "from_subshapes_of_" to the names of partially restored sub-shapes.
By default this option is On.
\anchor preview_anchor <br><center><b>Preview</b></center>

View File

@ -13,7 +13,7 @@ be rotated, an \b Axis of rotation and an \b Angle of rotation.
\n <b>Arguments:</b> Name + one or several objects + 1 vector for direction of rotation + 1
angle.
\n <b>Advanced option:</b>
\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
\image html transformation4.png
@ -30,7 +30,7 @@ from the first point to the second and to the third.
\n <b>TUI Command:</b> <em>geompy.MakeRotationThreePoints(Shape, CentralPoint, Point1, Point2)</em>
\n <b>Arguments:</b> 1 shape + 3 points.
\n <b>Advanced option:</b>
\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
\image html transformation4a.png

View File

@ -10,7 +10,7 @@ shape. For this, you need to define the \b Shape to be scaled, the
<b>Central Point</b> of scale and the Scale Factor(s).
\n The \b Result will be a \b GEOM_Object.
\n <b>Advanced option:</b>
\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
\image html transformation10.png
\n <b>TUI Command:</b> <em>geompy.MakeScaleTransform(Shape, CenterOfScale, Factor)</em>

View File

@ -17,7 +17,7 @@ The \b Result will be any \b GEOM_Object (EDGE or WIRE).
<b>TUI Command:</b> <em>geompy.MakeSection(s1, s2)</em>
<b>Arguments:</b> Name + 2 shapes.
<b>Advanced option:</b>
\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
\image html neo-section.png

View File

@ -14,15 +14,15 @@ Shared Shapes.</b> The following dialog box will appear.
<ul>
<li> <b>Name</b> is the base name of the resulting shapes; </li>
<li> <b>Shapes</b> are the shapes to fing shared sub shapes of; </li>
<li> <b>Sub Shapes Type</b> is the type of required sub shapes; </li>
<li> <b>Shapes</b> are the shapes to fing shared sub-shapes of; </li>
<li> <b>Sub-shapes Type</b> is the type of required sub-shapes; </li>
</ul>
\n <b>Advanced options</b> \ref preview_anchor "Preview"
\n <b>TUI Command:</b> <em> geompy.GetSharedShapesMulti(Shapes,
Type),</em> where \em Shapes is a list of shapes to fing shared sub
shapes of and \em Type is the type of required sub shapes.
Type),</em> where \em Shapes is a list of shapes to fing shared sub-
shapes of and \em Type is the type of required sub-shapes.
Our <b>TUI Scripts</b> provide you with useful examples of the use of
\ref swig_GetSharedShapes "Get Shared Shapes" functionality.

View File

@ -11,7 +11,7 @@ shell or face. This operation is available in <b>OCC Viewer</b> only.
\n <b>TUI Command:</b> <em>geompy.SuppressHoles(Shape,
ListOfWireID),</em> where \em Shape is a shell or face, where holes
with free boundaries must be removed, \em ListOfWireID is a list of wire sub shapes ID's. If it is
with free boundaries must be removed, \em ListOfWireID is a list of wire sub-shapes ID's. If it is
empty, then all holes are removed.
\image html repair5.png

View File

@ -26,7 +26,7 @@ special case of \b Explode operation. </li>
<li>\subpage restore_presentation_parameters_page "Restore presentation parameters".
This cross-operation functionality allows the resulting shape to
inherit colors and subshapes from its parent shapes.</li>
inherit colors and sub-shapes from its parent shapes.</li>
</ul>

View File

@ -18,7 +18,7 @@ DZ),</em> where Shape is a shape to be translated, DX, DY, DZ are
components of translation vector.
\n <b>Arguments:</b> Name + one or several objects + 3 values (coordinates).
\n <b>Advanced option:</b>
\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
\image html transformation1.png
@ -27,7 +27,7 @@ of the vector.
\n <b>TUI Command:</b> <em>geompy.MakeTranslationTwoPoints(Object, Point1, Point2)</em>
\n <b>Arguments:</b> Name + one or several objects + 2 vertices
\n <b>Advanced option:</b>
\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
\image html transformation2.png
@ -39,7 +39,7 @@ and the dialog preview will display the vector along which the object will be tr
\n <b>TUI Command </b> for translation by vector and custom distance: <em>geompy.MakeTranslationVectorDistance(Object, Vector, Distance)</em>
\n <b>Arguments:</b> Name + one or several objects + 1 vector.
\n <b>Advanced option:</b>
\ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments".
\image html transformation3.png

View File

@ -80,7 +80,7 @@ gg.setDisplayMode(id_archimede,1)
\endcode
\anchor tui_restore_prs_params
<br><h2>Restore presentation parameters and subshapes</h2>
<br><h2>Restore presentation parameters and sub-shapes</h2>
\code
import geompy
@ -113,8 +113,8 @@ geompy.addToStudy(partition1, "Partition_1")
geompy.addToStudy(partition2, "Partition_2")
geompy.addToStudy(partition3, "Partition_3")
# Restore presentation parameters and subshapes
# different methods can be used to find the subshapes in the result:
# Restore presentation parameters and sub-shapes
# different methods can be used to find the sub-shapes in the result:
# GetInPlace, GetSame, GetInPlaceByHistory, GetShapesOnShape.
# By default, GetInPlace method is used (GEOM.FSM_GetInPlace)
geompy.RestoreSubShapes(partition1)
@ -125,10 +125,10 @@ geompy.RestoreSubShapes(partition2, [], GEOM.FSM_GetInPlace)
# but restore only the passed.
geompy.RestoreSubShapes(partition3, [tra], GEOM.FSM_GetInPlaceByHistory)
# To find subshapes in a transformed shape only one method could be
# To find sub-shapes in a transformed shape only one method could be
# used: pass GEOM.FSM_Transformed for that.
# True passed for the last argument, means that the transformed shape
# will inherit colour and subshapes from its first argument (see above
# will inherit colour and sub-shapes from its first argument (see above
# MakeTranslation).
geompy.RestoreSubShapes(tra, [], GEOM.FSM_Transformed, True)

View File

@ -265,7 +265,7 @@ is returned, and encountered errors are printed in the python console.
\n Checks the topology of the selected shape to detect self-intersections.
Returns True if there are no self-intersections. Reports pairs of
intersected sub shapes, if there are any.
intersected sub-shapes, if there are any.
\note This tool is useful for detection of shapes, not suitable for
arguments of Boolean operations and Partition algorithm.

View File

@ -2,15 +2,15 @@
\page work_with_groups_page Working with groups
Creation and editing groups of subshapes of a geometrical object makes
handling subshapes much easier. This functionality is available in OCC
Creation and editing groups of sub-shapes of a geometrical object makes
handling sub-shapes much easier. This functionality is available in OCC
viewer only.
<br><h2>Create a group</h2>
\image html image56.png
To create a group of subshapes of a geometrical object in the main
To create a group of sub-shapes of a geometrical object in the main
menu select <b>New entity > Group > Create</b>
\n The following menu will appear:
@ -32,7 +32,7 @@ Shape.</li>
<li><b>Geometrical parts of the Second Shape</b> restricts the range of accessible
elements to the sub-shapes of the Main Shape that geometrically
coincide with the <b>Second Shape</b>.</li>
<li><b>Only Sub-Shapes of the Second Shape</b> restricts the range of
<li><b>Only Sub-shapes of the Second Shape</b> restricts the range of
accessible elements to the sub-shapes of the Main Shape that
are sub-shapes of the <b>Second Shape</b>. This is useful because
sometimes purely geometrical coincidence is not enough and it
@ -41,9 +41,9 @@ to the main and the second shape.</li>
</ul>
<li>You can selectively display the selected elements using the following buttons:</li>
<ul>
<li><b>Show only selected</b> - displays only the subshapes selected in the list box.</li>
<li><b>Hide selected</b> - hides the subshapes selected in the list box.</li>
<li><b>Show all sub-shapes</b> - displays only the subshapes of the Main Shape.</li>
<li><b>Show only selected</b> - displays only the sub-shapes selected in the list box.</li>
<li><b>Hide selected</b> - hides the sub-shapes selected in the list box.</li>
<li><b>Show all sub-shapes</b> - displays only the sub-shapes of the Main Shape.</li>
</ul>
<li> You can select the elements of your group in two ways:
<ul>
@ -70,7 +70,7 @@ creation of other groups), or skip it by clicking \b Close button.
\n <b>TUI Command:</b> <em>geompy.CreateGroup(MainShape,
ShapeType),</em> where MainShape is a shape for which the group is
created, ShapeType is a type of shapes in the created group.
\n <b>Arguments:</b> 1 Shape + Type of subshape.
\n <b>Arguments:</b> 1 Shape + Type of sub-shape.
<b>Example:</b>
@ -90,16 +90,16 @@ Group > Edit</b>. This menu is designed in the same way as the
\n <b>TUI Command:</b>
<ul>
<li><em>geompy.AddObject(Group, SubShapeID),</em> where Group is a
group to which a sub shape has to be added, SubShapeID is an ID of the
sub shape to be added to the group.</li>
group to which a sub-shape has to be added, SubShapeID is an ID of the
sub-shape to be added to the group.</li>
<li><em>geompy.RemoveObject(Group, SubShapeID),</em> where Group is a
group from which a sub shape has to be removed, SubShapeID is an ID of
the sub shape to be removed from the group.</li>
group from which a sub-shape has to be removed, SubShapeID is an ID of
the sub-shape to be removed from the group.</li>
<li><em>geompy.GetObjectIDs(Group),</em> where Group is a group for which its object's are returned.
\n Returns: List of IDs.</li>
</ul>
\n <b>Arguments:</b> 1 Shape + its subshapes.
\n <b>Arguments:</b> 1 Shape + its sub-shapes.
\n <b>Dialog Box:</b>