From: vsr Date: Wed, 17 Apr 2013 16:05:53 +0000 (+0000) Subject: Update documentation for 7.2.0 X-Git-Tag: V7_2_0~2 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=d8e687a757ad12234d279b3d21da242e9d0015d9;p=modules%2Fgeom.git Update documentation for 7.2.0 --- diff --git a/doc/salome/gui/GEOM/images/extrusion1.png b/doc/salome/gui/GEOM/images/extrusion1.png index 467d81276..99d5100a2 100755 Binary files a/doc/salome/gui/GEOM/images/extrusion1.png and b/doc/salome/gui/GEOM/images/extrusion1.png differ diff --git a/doc/salome/gui/GEOM/images/extrusion2.png b/doc/salome/gui/GEOM/images/extrusion2.png index 755e133c3..6a6b6e2c2 100755 Binary files a/doc/salome/gui/GEOM/images/extrusion2.png and b/doc/salome/gui/GEOM/images/extrusion2.png differ diff --git a/doc/salome/gui/GEOM/images/extrusion3.png b/doc/salome/gui/GEOM/images/extrusion3.png index a462de17d..efa6f2ecb 100644 Binary files a/doc/salome/gui/GEOM/images/extrusion3.png and b/doc/salome/gui/GEOM/images/extrusion3.png differ diff --git a/doc/salome/gui/GEOM/images/hide_predef_material.PNG b/doc/salome/gui/GEOM/images/hide_predef_material.PNG deleted file mode 100755 index a9516fd00..000000000 Binary files a/doc/salome/gui/GEOM/images/hide_predef_material.PNG and /dev/null differ diff --git a/doc/salome/gui/GEOM/images/hide_predef_material.png b/doc/salome/gui/GEOM/images/hide_predef_material.png new file mode 100755 index 000000000..22bec811b Binary files /dev/null and b/doc/salome/gui/GEOM/images/hide_predef_material.png differ diff --git a/doc/salome/gui/GEOM/images/pipetshape1.png b/doc/salome/gui/GEOM/images/pipetshape1.png new file mode 100644 index 000000000..ef3773e67 Binary files /dev/null and b/doc/salome/gui/GEOM/images/pipetshape1.png differ diff --git a/doc/salome/gui/GEOM/images/pipetshape2.png b/doc/salome/gui/GEOM/images/pipetshape2.png new file mode 100644 index 000000000..f11a00938 Binary files /dev/null and b/doc/salome/gui/GEOM/images/pipetshape2.png differ diff --git a/doc/salome/gui/GEOM/images/pipetshape3.png b/doc/salome/gui/GEOM/images/pipetshape3.png new file mode 100644 index 000000000..d4a88a236 Binary files /dev/null and b/doc/salome/gui/GEOM/images/pipetshape3.png differ diff --git a/doc/salome/gui/GEOM/images/pipetshape4.png b/doc/salome/gui/GEOM/images/pipetshape4.png new file mode 100644 index 000000000..91bdc0573 Binary files /dev/null and b/doc/salome/gui/GEOM/images/pipetshape4.png differ diff --git a/doc/salome/gui/GEOM/images/pipetshape5.png b/doc/salome/gui/GEOM/images/pipetshape5.png new file mode 100644 index 000000000..2b24a0bbc Binary files /dev/null and b/doc/salome/gui/GEOM/images/pipetshape5.png differ diff --git a/doc/salome/gui/GEOM/images/show_predef_material.PNG b/doc/salome/gui/GEOM/images/show_predef_material.PNG deleted file mode 100755 index 922abce5a..000000000 Binary files a/doc/salome/gui/GEOM/images/show_predef_material.PNG and /dev/null differ diff --git a/doc/salome/gui/GEOM/images/show_predef_material.png b/doc/salome/gui/GEOM/images/show_predef_material.png new file mode 100644 index 000000000..a229c00b5 Binary files /dev/null and b/doc/salome/gui/GEOM/images/show_predef_material.png differ diff --git a/doc/salome/gui/GEOM/input/creating_extrusion.doc b/doc/salome/gui/GEOM/input/creating_extrusion.doc index 81384e7ba..25e431455 100644 --- a/doc/salome/gui/GEOM/input/creating_extrusion.doc +++ b/doc/salome/gui/GEOM/input/creating_extrusion.doc @@ -2,82 +2,61 @@ \page create_extrusion_page Extrusion -\n To generate an \b Extrusion on an object in the Main Menu -select New Entity - > Generation - > Extrusion +\b Extrusion is propagation of the selected base shape in a certain direction and by a certain distance. +\n The \b Result of the operation will be a GEOM_Object (edge, face, shell +solid or compsolid). Examples: \image html prisms_basessn.png -Base Shape +
Base Shape
\image html prismssn.png -Prisms +
Resulting Prisms
-\n There are 3 algorithms for creation of an \b Extrusion (Prism). -\n The \b Result of the operation will be a GEOM_Object (edge, face, shell -solid or compsolid). - -\n Firstly, you can define the Base Shape (a basis of the -extrusion), the \b Vector (a direction of the extrusion) and the \b -Height of extrusion. Optionally you can define the Scale Factor to -build extrusion with scaled opposite base. Scaling is possible only -with 1D and 2D bases. -
It is possible to select in GUI several Base Shapes to make -several extrusions (using Shift button). -\n The \b Result of the operation will be a GEOM_Object (edge, face, -shell, solid or compsolid). -\n Both Directions checkbox allows extruding the source -object both forward and backward. With this option scaling is not possible. -\n TUI Command: geompy.MakePrismVecH(Base, Vector, Height, theScaleFactor = -1.0) -\n Arguments: Name + one or several shapes (vertex, edge, planar wire, face or -shell) serving as base objects + 1 vector (for direction of the -extrusion) + 1 value (dimension) + 1 optional value (scale factor for -the opposite base). -\nAdvanced options \ref preview_anchor "Preview" +\n To generate an \b Extrusion on an object in the Main Menu +select New Entity - > Generation - > Extrusion \image html extrusion1.png -\n Secondly, you can define the \b Extrusion by the Base Shape(s) -and the \b Start and End Point of the \b Vector (in this way -you don't need to create it in advance). Optionally you can define the -Scale Factor to build extrusion with scaled opposite -base. Scaling is possible only with 1D and 2D bases. -\n Both Directions checkbox allows extruding the source -object both forward and backward. With this option scaling is not possible. -\n TUI Command: geompy.MakePrism(Base, Point1, Point2, theScaleFactor = -1.0) -\n Arguments: Name + one or several shapes (vertex, edge, planar wire, face or -shell) serving as base objects + 2 vertices + 1 optional value (scale factor for -the opposite base). +The following parameters and options can be defined in this dialog -\image html extrusion2.png - -\n Finally, you can define the \b Extrusion by the Base Shape(s) -and the DX, DY, DZ Vector. Optionally you can define the -Scale Factor to build extrusion with scaled opposite -base. Scaling is possible only with 1D and 2D bases.\n -Both Directions checkbox allows extruding the -source objects both forward and backward. With this option scaling is not possible. -\n TUI Command: geompy.MakePrismDXDYDZ(Base, dx, dy, dz, theScaleFactor = -1.0) -\n Arguments: Name + one or several shapes (vertex, edge, planar wire, face or -shell) serving as base objects + 3 axis directions + 1 optional value (scale factor for -the opposite base). + Our TUI Scripts provide you with useful examples of creation of \ref tui_creation_prism "Complex Geometric Objects". diff --git a/doc/salome/gui/GEOM/input/creating_pipetshape.doc b/doc/salome/gui/GEOM/input/creating_pipetshape.doc index 44124f52e..3ca9baac7 100644 --- a/doc/salome/gui/GEOM/input/creating_pipetshape.doc +++ b/doc/salome/gui/GEOM/input/creating_pipetshape.doc @@ -4,75 +4,83 @@ To create a \b PipeTShape in the Main Menu select New Entity -> Primitives -> PipeTShape -Specify the parameters of the PipeTShape object in the opened dialog -box and press "Apply" or "Apply & Close" button. -The result of the operation will be a GEOM_Object. +The dialog for definition of PipeTShape parameters and options is split into three tabs. \n Main parameters: -\image html pipetshape_dlg.png +\image html pipetshape1.png -\n Position parameters: + -\image html pipetshape_pos_dlg.png +\image html pipetshape2.png -\n Advanced options \ref preview_anchor "Preview" +\n Thickness reduction -TUI Command: geompy.MakePipeTShape(R1, W1, L1, R2, W2, L2, HexMesh=True, P1=None, P2=None, P3=None) +\image html pipetshape3.png -Arguments: -- \b R1 - Radius of the main T-shape pipe. -- \b W1 - Thickness of the main T-shape pipe. -- \b L1 - Length of the main T-shape pipe. -- \b R2 - Radius of the incident T-shape pipe. -- \b W2 - Thickness of the incident T-shape pipe. -- \b L2 - Length of the incident T-shape pipe. -- \b HexMesh - If True, the shape is splitted into blocks (suitable for hexaedral mesh). +This tab allows applying, if necessary, thickness reductions at the open ends of the T-shape pipe (two ends of the main pipe and one end of the incident pipe). For each end it is possible to define: -Position arguments: -- \b P1 - First junction point of the main pipe (GEOM Vertex). -- \b P2 - Second junction point of the main pipe (GEOM Vertex). -- \b P3 - Junction point of the incident pipe (GEOM Vertex). - -Example: - -\image html pipetshape.png + -

A Pipe T-Shape can be created with a chamfer at the junction of the main and the incident pipes:

+\image html pipetshape4.png -TUI Command: geompy.MakePipeTShapeChamfer(R1, W1, L1, R2, W2, L2, H, W, HexMesh=True, P1=None, P2=None, P3=None) +\n Position -The arguments are the same as of the normal Pipe T-Shape plus: -- \b H - Height of the chamfer along the incident pipe. -- \b W - Width of the chamfer along the main pipe. +By default the PipeTShape is created at the center of coordinates and oriented by XY (main pipe) and XZ (incident pipe) axes, but it is possible to define a custom \b Position. -Example: +\image html pipetshape5.png -\image html pipetshapechamfer.png + -TUI Command: geompy.MakePipeTShapeFillet(R1, W1, L1, R2, W2, L2, RF, HexMesh=True, P1=None, P2=None, P3=None) +Advanced options: \ref preview_anchor "Preview" - displays the resulting shape in the viewer before \b Apply command. -The arguments are the same as of the normal Pipe T-Shape plus: -- \b RF - Radius of the fillet. +Specify the parameters of the PipeTShape object in the opened dialog box and press "Apply" or "Apply & Close" button. +The result of the operation will be a GEOM_Object. -Example: +\n TUI Commands: -\image html pipetshapefillet.png +There are three different TUI commands for PipeTShape creation: -

All three types of T-Shape (basic, with chamfer and with fillet) can -have thickness reductions at its open ends (two ends of the main pipe -and one end of the incident pipe):

+ -\image html pipetshape_thr_dlg.png -TUI Commands: -\ngeompy.MakePipeTShape(R1, W1, L1, R2, W2, L2, HexMesh=True, P1=None, P2=None, P3=None, theRL=0, theWL=0, theLtransL=0, theLthinL=0, theRR=0, theWR=0, theLtransR=0, theLthinR=0, theRI=0, theWI=0, theLtransI=0, theLthinI=0) -\ngeompy.MakePipeTShapeChamfer(R1, W1, L1, R2, W2, L2, H, W, HexMesh=True, P1=None, P2=None, P3=None, theRL=0, theWL=0, theLtransL=0, theLthinL=0, theRR=0, theWR=0, theLtransR=0, theLthinR=0, theRI=0, theWI=0, theLtransI=0, theLthinI=0) -\ngeompy.MakePipeTShapeFillet(R1, W1, L1, R2, W2, L2, RF, HexMesh=True, P1=None, P2=None, P3=None, theRL=0, theWL=0, theLtransL=0, theLthinL=0, theRR=0, theWR=0, theLtransR=0, theLthinR=0, theRI=0, theWI=0, theLtransI=0, theLthinI=0) - -The additional arguments are: +The following arguments can be used with these commands: +- \b R1 - Radius of the main pipe. +- \b W1 - Thickness of the main pipe. +- \b L1 - Length of the main pipe. +- \b R2 - Radius of the incident pipe. +- \b W2 - Thickness of the incident pipe. +- \b L2 - Length of the incident pipe. +- \b HexMesh - If True, the shape is split into blocks (suitable for hexahedral mesh). +- \b P1 - First junction point of the main pipe (GEOM Vertex). +- \b P2 - Second junction point of the main pipe (GEOM Vertex). +- \b P3 - Junction point of the incident pipe (GEOM Vertex). +- \b H - Height of the chamfer along the incident pipe (used only with geompy.MakePipeTShapeChamfer command). +- \b W - Width of the chamfer along the main pipe (used only with geompy.MakePipeTShapeChamfer command). +- \b RF - Radius of the fillet (used only with geompy.MakePipeTShapeFillet command). - \b theRL - Internal radius of left thickness reduction. - \b theWL - Width of left thickness reduction. - \b theLtransL - Length of left transition part. @@ -86,9 +94,6 @@ and one end of the incident pipe): - \b theLtransI - Length of incident transition part. - \b theLthinI - Length of incident thin part. -Example: - -\image html pipetshapethr.png Our TUI Scripts provide you with useful examples of creation of \ref tui_creation_pipetshape "Advanced objects". diff --git a/doc/salome/gui/GEOM/input/material.doc b/doc/salome/gui/GEOM/input/material.doc index 09791f2f7..59a022351 100644 --- a/doc/salome/gui/GEOM/input/material.doc +++ b/doc/salome/gui/GEOM/input/material.doc @@ -2,58 +2,53 @@ \page material_page Material properties -\tableofcontents + -\section material_general_description General description +\anchor material_general_description_anchor

General description

\note The functionality related to the material properties is -\b experimental, so it might work not as expected. The behaviour might +\b experimental, so it might work not as expected. The behavior might be changed in the future versions of SALOME Geometry module. -\n You can change the material properties of the selected shape(s) in +You can change the material properties of the selected shape(s) in the dedicated dialog box. This dialog box can be invoked from the -context popup menu. - -\n Appearance of popup menu can be customizable via -"Show predefined materials in popup menu" option from preferences. +context popup menu. The layout of context menu can be customized via +"Show predefined materials in popup menu" preferences option. If this option is switched off, only "Material properties" item will -be shown in popup menu. If this option is on (by default), "Material -properties" item in popup menu will open submenu listing predefined -materials and additionally "Custom..." item. - -\n "Show predefined materials in popup menu" option is switched off: -\image html hide_predef_material.PNG -\n "Show predefined materials in popup menu" option is switched on -\image html show_predef_material.PNG +be shown in the popup menu. If this option is on (by default), "Material +properties" item in the popup menu will open a submenu with list of predefined +materials: -\n"Custom..." or "Material properties" item will open dialog box: +\image html hide_predef_material.png +
"Show predefined materials in popup menu" option is switched off
-\image html material.png +\n\image html show_predef_material.png +
"Show predefined materials in popup menu" option is switched on
-In this dialog box you can: -- modify the properties of the material model currenly assigned to the -shape presentation; -- assign one of predefined global materials to the shape; -- create a custom material model and apply it to the shape. +The \b Custom item from this list allows defining \ref material_anchor "Material properties", +including the creation of a custom material. -\n You also can work with custom materials in the "Materials library" dialog box. -This dialog box can be invoked from the "Tools" main menu using -"Materials library" item: +It is also possible to define custom materials in the +\ref material_lib_anchor "Materials library" dialog +available from the main menu via Tools > Materials library . -\image html materials_library.png - -\note This functionality is available in both OCC and VTK 3D -viewers. However, note that due to the differencies between underlying API -of OCC and VTK libraries the behaviour of the functionality related to +\note This functionality works in both OCC and VTK 3D +viewers. However, due to the differences between underlying API +of OCC and VTK libraries, the behavior of the functionality related to the materials is different: -- presentation of the shape in OCC and VTK viewers is not fully identical; -- some material attributes can affect presentation in a different way. +- shape presentation in OCC and VTK viewers is not fully identical; +- some material attributes can affect the presentation in a different way. -\section material_opengl_model OpenGL ligthing model +\anchor material_opengl_model_anchor

OpenGL ligthing model

The material is specifed by several attributes of the lighting model. More details can be found in the documentation related to the -OpenGL programming, for example here: http://www.glprogramming.com/red/chapter05.html. +OpenGL programming, for example, here: http://www.glprogramming.com/red/chapter05.html. In the OpenGL lighting model, the light in a scene comes from several light sources; the light sources have an effect only when there are @@ -69,7 +64,7 @@ four independent components: emissive, ambient, diffuse, and specular. All four components are computed independently and then added together. -Ambient illumination is the light that has been scattered so much by the +- The \b Ambient illumination is the light that has been scattered so much by the environment that its direction is impossible to determine - it seems to come from all directions. Backlighting in a room has a large ambient component, since most of the light that reaches your eye has @@ -79,20 +74,26 @@ and since you're outdoors, very little of the light reaches your eye after bouncing off other objects. When ambient light strikes a surface, it is scattered equally in all directions. -The diffuse component is the light that comes from one direction, so +- The \b Diffuse component is the light that comes from one direction, so it is brighter if it comes squarely down on a surface than if it barely glances off the surface. Once it hits a surface, however, it's scattered equally in all directions, so it appears equally bright, no matter where the eye is located. Any light coming from a particular position or direction probably has a diffuse component. -Finally, the specular light comes from a particular direction, and it +- The \b Specular light comes from a particular direction, and it tends to bounce off the surface in a preferred direction. A well-collimated laser beam bouncing off a high-quality mirror produces specular reflection by almost 100 percent. Shiny metal or plastic has a high specular component, and chalk or carpet has almost none. You can think of specularity as shininess. +- The \b Emissive color simulates light originating from an object. +In the OpenGL lighting model, the emissive color of a surface adds +intensity to the object, but is unaffected by any light sources. Also, +the emissive color does not introduce any additional light into the +overall scene. + Although a light source delivers a single distribution of frequencies, the ambient, diffuse, and specular components might be different. For example, if you have a white light in a room with red walls, the @@ -100,25 +101,15 @@ scattered light tends to be red, although the light directly striking objects is white. OpenGL allows you to set the red, green, and blue values for each component of light independently. -\section material_lib Materials library dialog box -The dialog box consists of two parts: -- The list box at the left shows all available material models, both -predefined by the application and custom one specified by the user. -- The widgets in the right part of the dialog box allows modifyng of -different properties of the material model. +\anchor material_lib_anchor

Materials library

-The following properties of the material model can be specified: -- \b Ambient color and coefficient (floating point value between 0 and 1) -- \b Diffuse color and coefficient (floating point value between 0 and 1) -- \b Specular color and coefficient (floating point value between 0 and 1) -- \b Emissive color and coefficient (floating point value between 0 -and 1). Note: this attribute is applicable only for the OCC viewer; -it simulates light originating from an object. -- \b Shininess -- \b Type of material model: \em physical or \em artificial. +\image html materials_library.png + +The dialog consists of two parts: -All available predefined material models are shown in the list box of -the Materials dialog dialog: + + +\anchor material_anchor

Material properties

+ +\image html material.png -The dialog box looks like "Materials library" dialog box but has -some additions in the form of selection objects mechanizm and "Color" -property. +In addition to the functionality of Materials library, this +dialog provides objects selection mechanizm and \b Color property. -If the material model is specified as a \em physical one (like \em Gold, -for instance), this means that the color of the shape (more precisely -its \em ambient color) can not be modified. If you assign a physical -material model to the shape, the "Color" menu item will not be -available in the popup menu. +If the material model is specified as a \em physical (\em Gold, +for example), the shape color (more precisely its \em ambient color) +cannot be modified. If you assign a physical material model to the +shape, the "Color" menu item will not be available in the popup menu. If the model is non-physical (\em artificial), the color can be changed to any appopriate one, only other attributes will be constant. In the dialog box you will be able to modify the color of the shape via the -"Color" button. "Ambient color" button becomes disabled to signalize +"Color" button. "Ambient color" button will be disabled to signalize that this attribute of the model is ignored. Also, it will be possible to modify the color of the shape via the \ref color_page "corresponding popup menu command". @@ -158,10 +161,10 @@ to modify the color of the shape via the Examples: \image html material_OCC.png -Different materials in OCC viewer +
Various materials in OCC viewer
-\image html material_VTK.png -Different materials in VTK viewer +\n\image html material_VTK.png +
Various materials in VTK viewer
The default material model is specified via the preferences of Geometry module. diff --git a/doc/salome/gui/GEOM/input/min_distance.doc b/doc/salome/gui/GEOM/input/min_distance.doc index 9653e2210..b30a00e97 100644 --- a/doc/salome/gui/GEOM/input/min_distance.doc +++ b/doc/salome/gui/GEOM/input/min_distance.doc @@ -1,25 +1,25 @@ /*! -\page min_distance_page Min. Distance +\page min_distance_page Minimum Distance Returns the minimum distance between two geometrical objects and the coordinates of the vector of distance and shows the distance in the viewer. -\note The minimal distance searching task can have one or more -solutions, and also it can have an infinite set of solutions. All -found solutions are listed in dedicated combobox. When the user -selects any one of found solutions, presentation is displayed in the -OCC viewer and fields "Length", "DX", "DY" and "DZ" are filled with -corresponding values. If there are no solutions found, text "No -solution found" will be shown instead of solutions list; this could -mean what the task has an infinite number of solutions. +\note The query for minimum distance can find one or more +solutions, or even an infinite set of solutions. All +found solutions are listed in a dedicated combo-box. When one of the found solutions is selected, the presentation is displayed in the +OCC viewer and fields "Length", "DX", "DY" and "DZ" are filled with the +corresponding values. If no solutions have been found, the message "No +solution found" is shown. -\n \note Currently used OCCT functionality finds finite number of -solutions even in cases, where an infinite set of solutions exists. +\note The currently used OCCT algorithm finds a finite number of +solutions even if an infinite set of solutions exists. -\n On \b Apply or Apply and Close it creates a set of closest -points of the shapes, corresponding to all found solutions. +\image html distance.png + +\n On \b Apply or Apply and Close a set of closest +points, corresponding to all found solutions is created. TUI Commands: \naDist = geompy.MinDistance(Shape1, Shape2), @@ -30,6 +30,4 @@ distance is computed. See also a \ref tui_min_distance_page "TUI example". -\image html distance.png - */ diff --git a/doc/salome/gui/GEOM/input/mirror_operation.doc b/doc/salome/gui/GEOM/input/mirror_operation.doc index 629012f61..ec5034041 100644 --- a/doc/salome/gui/GEOM/input/mirror_operation.doc +++ b/doc/salome/gui/GEOM/input/mirror_operation.doc @@ -14,8 +14,7 @@ otherwise it will be removed. \n Firstly an \b Object can be mirrored through a \b Point of symmetry \n TUI Command: geompy.MakeMirrorByPoint(Object, Point) \n Arguments: Name + one or several objects + 1 vertex. -\n Advanced option: - \ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments". +\n \ref restore_presentation_parameters_page "Advanced options". \image html transformation7.png @@ -27,8 +26,8 @@ otherwise it will be removed. symmetry \n TUI Command: geompy.MakeMirrorByAxis(Object, Axis) \n Arguments: Name + one or several objects + 1 vector. -\n Advanced option: - \ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments". +\n \ref restore_presentation_parameters_page "Advanced options". + \image html transformation8.png @@ -39,8 +38,7 @@ symmetry \n Finally an \b Object can be mirrored through a \b Plane of symmetry \n TUI Command: geompy.MakeMirrorByPlane(Shape, Plane) \n Arguments: Name + one or several objects + 1 plane -\n Advanced option: - \ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments". +\n \ref restore_presentation_parameters_page "Advanced options". \image html transformation9.png diff --git a/doc/salome/gui/GEOM/input/modify_location_operation.doc b/doc/salome/gui/GEOM/input/modify_location_operation.doc index 3f94b0f0b..68c7e746b 100644 --- a/doc/salome/gui/GEOM/input/modify_location_operation.doc +++ b/doc/salome/gui/GEOM/input/modify_location_operation.doc @@ -7,13 +7,12 @@ \n This operation modifies the \b Location of \b Objects. -\n The first algorithm places the object(s) so that its center coincides -with the origin of the Local Coordinate System. +\n The first algorithm places the \b Object(s) so that its center coincides +with the origin of the Local Coordinate System. \n Create a copy checkbox allows to keep the initial objects, otherwise they will be removed. \n Arguments: Name + one or several objects + End Coordinate System. -\n Advanced option: -\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments". +\n \ref restore_presentation_parameters_page "Advanced options". \image html transformation5.png @@ -23,18 +22,17 @@ System in the center of it is to the left . \image html image30.png -\n The second algorithm modifies the location of an object using Start -and End LSC, although the final position of the object will not +\n The second algorithm modifies the location of the \b Object(s) using \b Start +and \b End \b LCS, although the final position of the object will not coincide with the center of either of the two systems. In this method the object is shifted from its initial position by the value of the -remainder after subtraction of the coordinates of the Start LSC from -the coordinates of the End LSC. +remainder after subtraction of the coordinates of the Start LCS from +the coordinates of the End LCS. \n Create a copy checkbox allows to keep the initial object, otherwise it will be removed. \n Arguments: Name + one or several objects + Start Coordinate System + End Coordinate System. -\n Advanced option: -\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments". +\n \ref restore_presentation_parameters_page "Advanced options". \image html transformation6.png @@ -54,8 +52,8 @@ translated cube at the position (-100;0;0) \image html image4.png -The third algorithm modifies the location of an object using the Path object (Wire or Edge) -and the Distance parameter (ranging from 0 to 1) defining how far the object will move along the path. +The third algorithm modifies the location of the \b Object(s) using the Path object (Wire or Edge) +and the \b Distance parameter (ranging from 0 to 1) defining how far the object will move along the path. \n Create a copy checkbox allows to keep the initial object, otherwise it will be removed. \n Select Unpublished edges checkbox allows to select sub-shape edges on @@ -63,8 +61,7 @@ the other objects. \n Reverse Direction checkbox allows to REVERSE the direction of the object movement along its path. Arguments: Name + one or several objects + Translation path. -\n Advanced option: -\ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments". +\n \ref restore_presentation_parameters_page "Advanced options". \image html transformation13.png diff --git a/doc/salome/gui/GEOM/input/multi_rotation_operation.doc b/doc/salome/gui/GEOM/input/multi_rotation_operation.doc index 0238f6334..33411d6c5 100644 --- a/doc/salome/gui/GEOM/input/multi_rotation_operation.doc +++ b/doc/salome/gui/GEOM/input/multi_rotation_operation.doc @@ -5,18 +5,24 @@ \n To produce a Multi Rotation in the Main Menu select Operations - > Transformation - > Multi Rotation -\n This operation creates a compound of several shapes rotated in one -or two dimensions basing on the initial shape. -\n The \b Result will be one \b GEOM_Object (compound). - -\n To produce a Simple Multi Rotation (in one dimension) you -need to define a \b Shape to be rotated, an \b Axis of rotation (DZ by -default), Angle of rotation (optionally) and a Number of Times -the shape must be rotated. If Angular step is not defined -(checkbox is not checked), it will be 2 * \a PI / \a NbTimes. Number -of shape's copies in the resulting compound will be equal to -\a NbTimes (if \a NbTimes = 1, the result will contain only the -initial non-transformed shape). +\n This operation creates a compound of several rotated shapes basing on the initial shape. + + +In case of Simple Multi Rotation the object is multiplied by rotation. + +\image html neo-mrot1.png + +The following parameters and options can be defined in this dialog: +- Result Name; +- Main Object to be rotated; +- \b Vector defines the axis of rotation (DZ by default); +- Angular step is the angle by which the object is rotated. By default +(if the checkbox is not checked), it is 2 * \a PI / \a NbTimes; +- Nb. Times is the number of rotated shape copies in the resulting compound. If \a NbTimes = 1, the result contains only the +initial shape; +- \ref restore_presentation_parameters_page "Advanced options". + +\n The \b Result will be a \b GEOM_Object (compound). \n TUI Commands: \n geompy.MultiRotate1DNbTimes(Shape, Axis, NbTimes) @@ -28,24 +34,26 @@ operation, which is currently accessible only via TUI commands: geompy.MakeMultiRotation1DByStep(Shape, Dir, Point, AngleStep, NbTimes), which works in the same way, but the Axis is defined by direction and point. -\image html neo-mrot1.png - \image html multi_rotation1d1.png "The initial object" \image html multi_rotation1d2.png "The result of a simple multi-rotation" -\n Double Multi Rotation (in two dimensions) rotates the given -\b Object around the given \b Axis (DZ by default) on the given -\b Angle (optional) a given Number of Times and -multi-translates each rotation result. -If Angular step is not defined (checkbox is not checked), it -will be 2 * \a PI / \a NbTimes. -Translation direction passes through the center of gravity of the -initial shape and its projection on the rotation axis. Number of -shape's copies in the resulting compound will be equal to \a NbTimes1 x \a NbTimes2 -(if both \a NbTimes1 and \a NbTimes2 are equal to 1, the result will contain -only the initial non-transformed shape). -\b Reverse checkbox allows to set the direction of rotation. +In case of Double Multi Rotation the object is multiplied by rotation and additionally translated several times in each direction. + +\image html neo-mrot2.png + +The following parameters and options can be defined in this dialog: +- Result Name; +- Main Object to be rotated; +- \b Vector defines the axis of rotation (DZ by default); +- Angular step is the angle by which the object is rotated. By default +(if the checkbox is not checked), it is 2 * \a PI / \a NbTimes; +- Nb. Times (\a NbTimes1) is the number of rotated shape copies in the resulting compound; +- \b Reverse checkbox allows changing the direction of translation; +- Radial step is the distance between the shape copies in the same direction. Translation direction passes through the center of gravity of the +initial shape and its projection on the rotation axis; +- Nb. Times (\a NbTimes2) is the number of shape copies in the same direction. If \a NbTimes2 = 1, the result is the same as for Simple Multi Rotation. If both \a NbTimes1 and \a NbTimes2 are equal to 1, the result will contain only the initial non-transformed shape; +- \ref restore_presentation_parameters_page "Advanced options". \n TUI Commands: \n geompy.MultiRotate2DNbTimes(Shape, Axis, NbTimes1, RadialStep, NbTimes2) @@ -57,7 +65,6 @@ operation, which is currently accessible only via TUI commands: geompy.MakeMultiRotation2DByStep(Shape, Dir, Point, AngleStep, NbTimes1, RadialStep, NbTimes2), which works in the same way, but the Axis is defined by direction and point. -\image html neo-mrot2.png \image html multi_rotation2d1.png "The initial object" diff --git a/doc/salome/gui/GEOM/input/multi_translation_operation.doc b/doc/salome/gui/GEOM/input/multi_translation_operation.doc index 6274ad9b4..785ca2cdb 100644 --- a/doc/salome/gui/GEOM/input/multi_translation_operation.doc +++ b/doc/salome/gui/GEOM/input/multi_translation_operation.doc @@ -9,7 +9,7 @@ select Operations - > Transformation - > Multi Translation two directions. \n The \b Result will be one \b GEOM_Object (compound). The total number of shape copies in the resulting compound will be equal to: -- in case of \ref single_multi_translation "Single multi translation": +- in case of \ref single_multi_translation "Simple multi translation": \a NbTimes (if \a NbTimes parameter is equal to 1, the result will contain only the initial non-translated shape). - in case of \ref double_multi_translation "Double multi translation": @@ -18,16 +18,23 @@ are both equal to 1, the result will contain a single non-translated initial shape). \anchor single_multi_translation -\n To produce a Simple Multi Translation (in one direction) you -need to indicate an \b Object to be translated, a \b Vector of -translation (DX by default), a \b Step of translation and a Number -of Times the Object should be duplicated. If a curve has been -selected instead of the Vector, only its first and last vertices will -be used to get the vector direction and the dialog preview will -display the vector along which the object will be translated. + +In case of Simple Multi Translation the object is translated in one direction. \image html mtrans1.png +The following parameters and options can be defined in this dialog: +- Result Name; +- Main Object to be translated; +- \b Vector of translation (DX by default). If a curve has been +selected instead of the Vector, only its first and last vertices will +be used to get the vector direction and the dialog preview will +display the vector along which the object will be translated; +- Step is the distance between the shape copies; +- Nb. Times is the number of shape copies; +- Reverse Direction checkbox allows changing the direction of translation; +- \ref restore_presentation_parameters_page "Advanced options". + \image html multi_translation_initialsn.png "The initial object" \image html multi_translation1dsn.png "The result of a simple multi-translation" @@ -38,17 +45,23 @@ Step, NbTimes) step value + 1 value (repetition). \anchor double_multi_translation -\n To produce a Double Multi Translation (in two directions) you need to -indicate an \b Object to be translated, and, for both axes, a \b -Vector of translation (DX and DY by default), a \b Step of translation -and a Number of Times the shape must be duplicated. -If a curve has been selected instead of the Vector, only its first and -last vertices will be used to get the vector direction and the dialog -preview will display the vector along which the object will be -translated. + +In case of Double Multi Translation the object is translated in two directions. \image html mtrans2.png +The following parameters and options can be defined in this dialog: +- Result Name; +- Main Object to be translated; +- Vector U/V of translation (DX and DY by default). If a curve has been +selected instead of the Vector, only its first and last vertices will +be used to get the vector direction and the dialog preview will +display the vector along which the object will be translated; +- Step U/V is the distance between the shape copies; +- Nb. Times U/V is the number of shape copies; +- Reverse U/V checkbox allows changing the direction of translation; +- \ref restore_presentation_parameters_page "Advanced options". + \image html multi_translation_initialsn.png "The initial object" \image html multi_translation2dsn.png "The result of a double multi-translation" diff --git a/doc/salome/gui/GEOM/input/offset_operation.doc b/doc/salome/gui/GEOM/input/offset_operation.doc index c6fe55082..b1baac12b 100644 --- a/doc/salome/gui/GEOM/input/offset_operation.doc +++ b/doc/salome/gui/GEOM/input/offset_operation.doc @@ -9,14 +9,8 @@ Objects) along a local normal by a given \b Offset distance (signed number, negative value meaning inner offset). \n \b Offset operation is applicable to faces, shells and solids. -\n The \b Result will be a \b GEOM_Object -\n TUI Command: geompy.MakeOffset(Shape, Offset), -where Shape is a shape(s) which has to be an offset, Offset is a value of -the offset. -\n Arguments: Name + Object (face(s), shell(s), solid(s)) + -Offset value -\n Advanced option: - \ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments". +\n \ref restore_presentation_parameters_page "Advanced options". + \image html transformation11.png @@ -24,6 +18,13 @@ Offset value \image html offsetsn.png "The box and its offset surface" +\n TUI Command: geompy.MakeOffset(Shape, Offset), +where Shape is a shape(s) which has to be an offset, Offset is a value of +the offset. +\n Arguments: Name + Object (face(s), shell(s), solid(s)) + +Offset value. +\n The \b Result will be a \b GEOM_Object. + Our TUI Scripts provide you with useful examples of the use of \ref tui_offset "Transformation Operations". diff --git a/doc/salome/gui/GEOM/input/projection_operation.doc b/doc/salome/gui/GEOM/input/projection_operation.doc index 825dfa159..6f7e8b4eb 100644 --- a/doc/salome/gui/GEOM/input/projection_operation.doc +++ b/doc/salome/gui/GEOM/input/projection_operation.doc @@ -7,8 +7,7 @@ \n This operation makes normal projection of a Source vertex, edge or wire on a given Target face. -\n Arguments: Name + 2 Objects. -\n The \b Result will be an \b Object. +\ref restore_presentation_parameters_page "Advanced options". \image html projection_dlg.png diff --git a/doc/salome/gui/GEOM/input/rotation_operation.doc b/doc/salome/gui/GEOM/input/rotation_operation.doc index 41dd4137c..08c4477b4 100644 --- a/doc/salome/gui/GEOM/input/rotation_operation.doc +++ b/doc/salome/gui/GEOM/input/rotation_operation.doc @@ -9,30 +9,31 @@ \n The first \b Rotation algorithm needs you to define an \b Object to be rotated, an \b Axis of rotation and an \b Angle of rotation. -\n TUI Command: geompy.MakeRotation(Shape, Axis, Angle) -\n Arguments: Name + one or several objects + 1 vector for direction of rotation + 1 -angle. -\n Advanced option: - \ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments". +\n \b Reverse checkbox allows to specify the direction of rotation. +\n Create a copy checkbox allows to keep the initial object, +otherwise it will be removed. +\n \ref restore_presentation_parameters_page "Advanced options". \image html transformation4.png -\b Reverse checkbox allows to specify the direction of rotation. -\n Create a copy checkbox allows to keep the initial object, -otherwise it will be removed. -\n The \b Result will be any \b GEOM_Object. +\n TUI Command: geompy.MakeRotation(Shape, Axis, Angle) +\n Arguments: Name + one or several objects + 1 vector for direction of rotation + 1 angle. \n The second algorithm allows to define the rotated \b Object by three points. Rotation axis will pass through the Central Point and will be will be orthogonal to a plane defned by three points. In this case rotation \b Angle is the angle between two vectors directed -from the first point to the second and to the third. +from the Central Point to \b Point1 and \b Point2. +\n \b Reverse checkbox allows to specify the direction of rotation. +\n Create a copy checkbox allows to keep the initial object, +otherwise it will be removed. +\n \ref restore_presentation_parameters_page "Advanced options". + +\image html transformation4a.png + \n TUI Command: geompy.MakeRotationThreePoints(Shape, CentralPoint, Point1, Point2) \n Arguments: 1 shape + 3 points. -\n Advanced option: - \ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments". -\image html transformation4a.png \n Example: diff --git a/doc/salome/gui/GEOM/input/scale_operation.doc b/doc/salome/gui/GEOM/input/scale_operation.doc index 1c437e1ba..432d6d6b1 100644 --- a/doc/salome/gui/GEOM/input/scale_operation.doc +++ b/doc/salome/gui/GEOM/input/scale_operation.doc @@ -6,27 +6,39 @@ Operations - > Transformation - > Scale Transform \n This operation creates a scaled shape basing on the initial -shape. For this, you need to define the \b Shape to be scaled, the -Central Point of scale and the Scale Factor(s). -\n The \b Result will be a \b GEOM_Object. -\n Advanced option: - \ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments". +shape. +\n Simple scale scales the entire object (i.e. its dimensions change evenly in all three orthogonal directions). It does not modify the +geometry of the shape. + \image html transformation10.png + +The following parameters and options can be defined in this dialog: +- Result Name; +- One or several Objects to be scaled; +- Central Point (optional) - relatively to which the object is scaled. If the Central Point is not defined, the scaling will be +performed relatively the origin of the global coordinate system. +- Scale Factor - the multiplier of axial dimensions. If Scale Factor is negative, the object is mirrored through the Central Point. +- \ref restore_presentation_parameters_page "Advanced options". + \n TUI Command: geompy.MakeScaleTransform(Shape, CenterOfScale, Factor) \n Arguments: Name + 1 shape(s) + 1 vertex + 1 Scale Factor. +\n Multiple scale allows scaling by different factors along axes. This is a general transformation, which can modify the geometry, for example, a +circle can be transformed into an ellipse. + \image html transformation10a.png + +The following parameters and options can be defined in this dialog: +- Result Name; +- One or several Objects to be scaled; +- Central Point (optional) - relatively to which the object is scaled. +- Scale Factor X/Y/Z - the multipliers of axial dimensions. +- \ref restore_presentation_parameters_page "Advanced options". + \n TUI Command: geompy.MakeScaleAlongAxes(Shape, CenterOfScale, FactorX, FactorY, FactorZ) \n Arguments: Name + 1 shape(s) + 1 vertex + 3 Scale Factors. -\note If the Central Point is not defined, the scaling will be -performed relatively the origin of the global coordinate system. - -\note Scaling by one factor is a simple transformation, it does not modify the -geometry of the shape, while scaling by several different factors along axes -is a general transformation, which can modify the geometry, for example, a -circle can be transformed into an ellipse. \n Example of simple scaling: diff --git a/doc/salome/gui/GEOM/input/translation_operation.doc b/doc/salome/gui/GEOM/input/translation_operation.doc index 60ca83c62..4ebe45b14 100644 --- a/doc/salome/gui/GEOM/input/translation_operation.doc +++ b/doc/salome/gui/GEOM/input/translation_operation.doc @@ -7,39 +7,37 @@ This Operation makes a translation of an \b Object. To translate a shape you need to define the base shape and the coordinates of the -vector of translation. Create a copy checkbox allows to keep the -initial object, otherwise it will be removed. +vector of translation. +\n Create a copy checkbox allows to keep the initial object, otherwise it will be removed. +\n \ref restore_presentation_parameters_page "Advanced options". \n The \b Result of all operations will be any \b GEOM_Object. -\n Firstly you can define an \b Object and the vector coordinates along the +The \b Vector of translation can be defined in three different ways selectable using the radio buttons. + +\n Firstly you can define the \b Vector by coordinates along the axes. \n TUI Command: geompy.MakeTranslation(Shape, DX, DY, DZ), where Shape is a shape to be translated, DX, DY, DZ are components of translation vector. \n Arguments: Name + one or several objects + 3 values (coordinates). -\n Advanced option: - \ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments". \image html transformation1.png -\n Secondly you can define an \b Object and the start and the end points -of the vector. +\n Secondly you can define the \b Vector by the start and the end points. \n TUI Command: geompy.MakeTranslationTwoPoints(Object, Point1, Point2) \n Arguments: Name + one or several objects + 2 vertices -\n Advanced option: - \ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments". + \image html transformation2.png -\n Finally you can define an \b Object and a vector. The object will be translated by the length of the vector. -If a curve has been selected instead of the vector, only its first and last vertices will be used to get the vector direction -and the dialog preview will display the vector along which the object will be translated. -\n TUI Command: geompy.MakeTranslationVector(Object, Vector) -\n Activate Distance checkbox and Distance field allow defining the custom distance of translation. -\n TUI Command for translation by vector and custom distance: geompy.MakeTranslationVectorDistance(Object, Vector, Distance) +\n Finally you can define the \b Vector explicitely. The \b Object will be translated by the length of the vector. +If a curve has been selected instead of the vector, only its first and last vertices will be used to get the vector direction and the dialog preview will display the vector along which the object will be translated. +\n Activate Distance checkbox and Distance field allow defining a custom distance of translation. + + +\n TUI Command: for translation by vector: geompy.MakeTranslationVector(Object, Vector) +\n TUI Command for translation by vector and a custom distance: geompy.MakeTranslationVectorDistance(Object, Vector, Distance) \n Arguments: Name + one or several objects + 1 vector. -\n Advanced option: - \ref restore_presentation_parameters_page "Set presentation parameters and sub-shapes from arguments". \image html transformation3.png diff --git a/doc/salome/gui/GEOM/input/using_notebook_geom_page.doc b/doc/salome/gui/GEOM/input/using_notebook_geom_page.doc index e22507f62..ff1ddc996 100644 --- a/doc/salome/gui/GEOM/input/using_notebook_geom_page.doc +++ b/doc/salome/gui/GEOM/input/using_notebook_geom_page.doc @@ -4,7 +4,7 @@ SALOME NoteBook allows defining variables to be used for creation and modification of objects. -A detailed description of the SALOME NoteBook can be found the the GUI documentation. +A detailed description of the SALOME NoteBook can be found in the GUI documentation. \image html using_notebook_geom.png "Definition of variables in SALOME NoteBook" diff --git a/doc/salome/gui/GEOM/input/viewing_geom_obj.doc b/doc/salome/gui/GEOM/input/viewing_geom_obj.doc index ada09fef1..acd9a5fa5 100644 --- a/doc/salome/gui/GEOM/input/viewing_geom_obj.doc +++ b/doc/salome/gui/GEOM/input/viewing_geom_obj.doc @@ -49,12 +49,12 @@ viewer. TUI Command : sg.EraseOnly(ID) \image html image18.png -
  • Hide all - allows to hide all objects from the viewer. TUI +
  • Hide all - hides all objects from the viewer. TUI Command: sg.EraseAll()
    • \image html image26.png -
  • Show Only - allows to display only the selected +
  • Show Only - displays only the selected geometrical object. TUI Command: sg.DisplayOnly(ID)
    • \image html image33.png @@ -87,11 +87,11 @@ sub-objects in the Object Browser, if the selected geometric object has child objects. When some child objects are hidden, the name of the parent object is hilghlighted with bold font. -
  • Show Only Children - erase in current viewer all objects -and then display only children of the selected object(s). +
  • Show Only Children - erases from the current viewer all objects +and then displays only the children of the selected object(s).
    • -
  • Unpublish - unpublish the selected geometric object from the Object Browser +
  • Unpublish - unpublishes the selected geometric object from the Object Browser and erase it from all viewers. To publish unpublished geometric objects select in the context menu of the Geometry root object Publish... item. The following dialog box will appear
    • diff --git a/doc/salome/gui/GEOM/input/working_with_groups.doc b/doc/salome/gui/GEOM/input/working_with_groups.doc index 6b9d85c1c..d1eac3994 100644 --- a/doc/salome/gui/GEOM/input/working_with_groups.doc +++ b/doc/salome/gui/GEOM/input/working_with_groups.doc @@ -112,8 +112,8 @@ the default mode defined in the preferences will be used. \image html editgroup.png \n The subshapes already in the group are displayed in the 3D viewer with a specific color, -defined via preferences. The IDs of the subshapes already in the group also are displayed in -a specific color in the dialog box. When user adds some subshapes, the new IDs are +defined via preferences. The IDs of the subshapes already in the group are also displayed in +a specific color in the dialog box. When the user adds some subshapes, the new IDs are displayed in the other color. \n The \b Result of the operation will be a \b GEOM_Object.