Update documentation for 7.2.0

This commit is contained in:
vsr 2013-04-17 15:23:36 +00:00
parent a94dbd7745
commit 9351fe0dfa
3 changed files with 14 additions and 14 deletions

View File

@ -2,21 +2,21 @@
\page bounding_box_page Bounding Box \page bounding_box_page Bounding Box
Shows the dimensions of the bounding box for the selected Displays the bounding box dimensions for the selected
geometrical object. Creates corresponding shape (box) on "Apply". geometrical object and creates the corresponding box shape on "Apply".
\image html measures5.png \image html measures5.png
\note To take into account any possible shape distortion \note To take into account any possible shape distortion
that affects the resulting bounding box, the algorithm enlarges that affects the resulting bounding box, the algorithm enlarges
the bounding box to the maximum deflection value of the bounding box to the maximum deflection value of
faces (by iterating through all faces of a shape). faces (by iterating through all faces of a shape).
This functionallity is implemented in such a way to have This functionallity is implemented in such a way to have
a satisfactory performance. a satisfactory performance.
\n <b>TUI Commands:</b> <em>[Xmin,Xmax, Ymin,Ymax, Zmin,Zmax] = geompy.BoundingBox(Shape)</em>, \n <b>TUI Commands:</b> <em>[Xmin,Xmax, Ymin,Ymax, Zmin,Zmax] = geompy.BoundingBox(Shape)</em>,
<em>BBox = geompy.MakeBoundingBox(Shape)</em>, where \em Shape <em>BBox = geompy.MakeBoundingBox(Shape)</em>, where \em Shape
is the shape for which a bounding box is computed. is the shape for which the bounding box is computed.
See also a \ref tui_bounding_box_page "TUI example". See also a \ref tui_bounding_box_page "TUI example".

View File

@ -70,9 +70,9 @@ closed edge.</li>
<li> If <b>Reorder vertices taking into account distances</b> is <li> If <b>Reorder vertices taking into account distances</b> is
checked, the interpolation algorithm does not follow the order of checked, the interpolation algorithm does not follow the order of
vertices but searches for the closest vertex.</li> vertices but searches for the closest vertex.</li>
<li><b>Tangents</b> are two vectors, defining direction of curve at <li><b>Tangents</b> are two vectors, defining the direction at the ends of the
its ends. Both or none vectors must be set. This option available only curve. It is necessary to set both vectors or none. This option is available only
if two above check boxes are not checked. if both above check boxes are not checked.
</li> </li>
</ul> </ul>

View File

@ -2,15 +2,15 @@
\page geompy_migration_page Modifying Geometry Python scripts from SALOME 6 and before \page geompy_migration_page Modifying Geometry Python scripts from SALOME 6 and before
\n With SALOME 7.2, the Python interface for Geometry has been slightly modified to offer new functionality: \n In SALOME 7.2, the Python interface for Geometry has been slightly modified to offer new functionality:
<ul> <ul>
<li>\subpage tui_execution_distribution_page</li> <li>\subpage tui_execution_distribution_page</li>
<li>\subpage tui_auto_completion_documentation_page</li> <li>\subpage tui_auto_completion_documentation_page</li>
</ul> </ul>
\n Scripts generated for SALOME 6 and older versions must be adapted to work in SALOME 7.2 with all functionality. \n Scripts generated for SALOME 6 and older versions must be adapted to work in SALOME 7.2 with full functionality.
\n A compatibility mode allows old scripts to work in almost all cases, but with a warning. \n The compatibility mode allows old scripts to work in almost all cases, but with a warning.
<b>Salome initialisation must always be done as shown below</b> <b>Salome initialisation must always be done as shown below</b>
\n (<em>salome_init()</em> can be invoked safely several times): \n (<em>salome_init()</em> can be invoked safely several times):
@ -20,12 +20,12 @@ salome.salome_init()
\endcode \endcode
<b>Geometry initialisation is modified.</b> <b>Geometry initialisation is modified.</b>
\n old mode: \n the old mode:
\code \code
import geompy import geompy
geompy.init_geom(theStudy) geompy.init_geom(theStudy)
\endcode \endcode
new mode: \n the new mode:
\code \code
import GEOM import GEOM
from salome.geom import geomBuilder from salome.geom import geomBuilder
@ -36,8 +36,8 @@ geompy = geomBuilder.New(salome.myStudy)
<b> Of course, <em>from geompy import *</em> is no more possible.</b> <b> Of course, <em>from geompy import *</em> is no more possible.</b>
\n You have to explicitely write <em>geompy.some_method()</em>. \n You have to explicitely write <em>geompy.some_method()</em>.
\n <b>Some variables are no longer in namespace <em>geompy.GEOM</em> but in namespace <em>GEOM</em>.</b> \n <b>Some variables have been transferred from the namespace <em>geompy.GEOM</em> to the namespace <em>GEOM</em>.</b>
\n All the occurences of <em>geompy.GEOM.</em> can be replaced by <em>GEOM.</em>. \n All occurrences of <em>geompy.GEOM.</em> can be replaced by <em>GEOM.</em>.
\n For instance: \n For instance:
\code \code
param_polyline = geompy.MakeCurveParametric("t", "sin(t)", "cos(t)", 0., 100., 100, geompy.GEOM.Polyline, theNewMethod=True) param_polyline = geompy.MakeCurveParametric("t", "sin(t)", "cos(t)", 0., 100., 100, geompy.GEOM.Polyline, theNewMethod=True)