From: skv Date: Tue, 28 Oct 2014 15:04:25 +0000 (+0300) Subject: Documentation creation X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=cea795bdaaeaa16c8a651b1a0da3865c5f58e9a4;p=modules%2Fgeom.git Documentation creation --- diff --git a/doc/salome/examples/CMakeLists.txt b/doc/salome/examples/CMakeLists.txt index 67721de68..76c3883e1 100644 --- a/doc/salome/examples/CMakeLists.txt +++ b/doc/salome/examples/CMakeLists.txt @@ -37,6 +37,7 @@ SET(GOOD_TESTS basic_geom_objs_ex07.py basic_geom_objs_ex08.py basic_geom_objs_ex09.py + basic_geom_objs_ex10.py basic_operations_ex01.py basic_operations_ex02.py basic_operations_ex03.py diff --git a/doc/salome/examples/basic_geom_objs_ex10.py b/doc/salome/examples/basic_geom_objs_ex10.py new file mode 100644 index 000000000..f9f7f0165 --- /dev/null +++ b/doc/salome/examples/basic_geom_objs_ex10.py @@ -0,0 +1,37 @@ +# Creation of a Surface From Face + +import salome +salome.salome_init() +import GEOM +from salome.geom import geomBuilder +geompy = geomBuilder.New(salome.myStudy) +import math +import SALOMEDS + +# Create Vertices, Edges, Wire, Face and Disk +Vertex_1 = geompy.MakeVertex(0, 0, 0) +Vertex_2 = geompy.MakeVertex(100, 0, 0) +Vertex_3 = geompy.MakeVertex(50, 100, 0) +Edge_1 = geompy.MakeEdge(Vertex_1, Vertex_2) +Edge_2 = geompy.MakeEdge(Vertex_2, Vertex_3) +Edge_3 = geompy.MakeEdge(Vertex_3, Vertex_1) +Wire_1 = geompy.MakeWire([Edge_1, Edge_2, Edge_3]) +Face_1 = geompy.MakeFace(Wire_1, True) +Disk_1 = geompy.MakeDiskR(100, 1) + +# Create Surfaces From Faces. +SurfaceFromFace_1 = geompy.MakeSurfaceFromFace(Face_1) +SurfaceFromFace_2 = geompy.MakeSurfaceFromFace(Disk_1) + +#Add created object to study +geompy.addToStudy( Vertex_1, "Vertex_1" ) +geompy.addToStudy( Vertex_2, "Vertex_2" ) +geompy.addToStudy( Vertex_3, "Vertex_3" ) +geompy.addToStudy( Edge_1, "Edge_1" ) +geompy.addToStudy( Edge_2, "Edge_2" ) +geompy.addToStudy( Edge_3, "Edge_3" ) +geompy.addToStudy( Wire_1, "Wire_1" ) +geompy.addToStudy( Face_1, "Face_1" ) +geompy.addToStudy( Disk_1, "Disk_1" ) +geompy.addToStudy( SurfaceFromFace_1, "SurfaceFromFace_1" ) +geompy.addToStudy( SurfaceFromFace_2, "SurfaceFromFace_2" ) diff --git a/doc/salome/gui/GEOM/images/surface_from_face1.png b/doc/salome/gui/GEOM/images/surface_from_face1.png new file mode 100644 index 000000000..ba039fd91 Binary files /dev/null and b/doc/salome/gui/GEOM/images/surface_from_face1.png differ diff --git a/doc/salome/gui/GEOM/images/surface_from_face_example.png b/doc/salome/gui/GEOM/images/surface_from_face_example.png new file mode 100644 index 000000000..db22d6fe2 Binary files /dev/null and b/doc/salome/gui/GEOM/images/surface_from_face_example.png differ diff --git a/doc/salome/gui/GEOM/input/creating_basic_go.doc b/doc/salome/gui/GEOM/input/creating_basic_go.doc index 6693b469d..19758a3d6 100644 --- a/doc/salome/gui/GEOM/input/creating_basic_go.doc +++ b/doc/salome/gui/GEOM/input/creating_basic_go.doc @@ -15,6 +15,7 @@ geometrical objects as:
  • \subpage create_isoline_page
  • \subpage create_sketcher_page
  • \subpage create_3dsketcher_page
    • +
  • \subpage create_surface_from_face_page
  • \subpage create_vector_page
  • \subpage create_plane_page
  • \subpage create_lcs_page
    • diff --git a/doc/salome/gui/GEOM/input/creating_surface_from_face.doc b/doc/salome/gui/GEOM/input/creating_surface_from_face.doc new file mode 100644 index 000000000..6034ed5e3 --- /dev/null +++ b/doc/salome/gui/GEOM/input/creating_surface_from_face.doc @@ -0,0 +1,27 @@ +/*! + +\page create_surface_from_face_page Surface From Face + +To create a Surface From Face in the Main Menu select New Entity - > Basic - > Surface From Face + +\n This function takes some face as input parameter and creates new +GEOM_Object, i.e. topological shape by extracting underlying surface +of the source face and limiting it by the Umin, Umax, Vmin, Vmax +parameters of the source face (in the parametrical space). +\n +\ref restore_presentation_parameters_page "Advanced options". + +\n TUI Command: geompy.MakeSurfaceFromFace(theFace), +where \em theFace the input face. +\n Arguments: Name + Object (Face). + +\image html surface_from_face1.png "Surface From Face" + +\n Example: + +\image html surface_from_face_example.png "Original Face (white) and Created Surface" + +Our TUI Scripts provide you with useful examples of the use of +\ref tui_creation_surface "Surface From Face" creation. + +*/ diff --git a/doc/salome/gui/GEOM/input/tui_basic_geom_objs.doc b/doc/salome/gui/GEOM/input/tui_basic_geom_objs.doc index 89be6f64b..2083bcc46 100644 --- a/doc/salome/gui/GEOM/input/tui_basic_geom_objs.doc +++ b/doc/salome/gui/GEOM/input/tui_basic_geom_objs.doc @@ -38,4 +38,8 @@

    Creation of a Local Coordinate System

    \tui_script{basic_geom_objs_ex09.py} +\anchor tui_creation_surface +

    Creation of a Surface From Face

    +\tui_script{basic_geom_objs_ex10.py} + */ diff --git a/src/GEOM_SWIG/geomBuilder.py b/src/GEOM_SWIG/geomBuilder.py index 5a4f7eeff..f1968ee10 100644 --- a/src/GEOM_SWIG/geomBuilder.py +++ b/src/GEOM_SWIG/geomBuilder.py @@ -5765,7 +5765,7 @@ class geomBuilder(object, GEOM._objref_GEOM_Gen): # publication is switched on, default value is used for result name. # @return New GEOM.GEOM_Object, containing the created face. # - # @ref tui_surf_from_face "Example" + # @ref tui_creation_surface "Example" @ManageTransactions("ShapesOp") def MakeSurfaceFromFace(self, theFace, theName=None): """