doc/salome/gui/GEOM/input/tui_primitives.doc

   1 /*!
   2
   3 \page tui_primitives_page Primitives
   4
   5 \anchor tui_creation_box
   6 <br><h2>Creation of a Box</h2>
   7
   8 \code
   9 import geompy
  10 import salome
  11 gg = salome.ImportComponentGUI("GEOM")
  12
  13 # create vertices
  14 p0 = geompy.MakeVertex(15, 25, 35)
  15 p70 = geompy.MakeVertex(70, 70, 70)
  16
  17 # create boxes
  18 box1 = geompy.MakeBoxDXDYDZ(10, 20, 30)
  19 box2 = geompy.MakeBox(10,20,30, 15,25,35)
  20 box3 = geompy.MakeBoxTwoPnt(p0, p70)
  21
  22 # add objects in the study
  23 id_box1 = geompy.addToStudy(box1,"Box1")
  24 id_box2 = geompy.addToStudy(box2,"Box2")
  25 id_box3 = geompy.addToStudy(box3,"Box3")
  26
  27 # display the boxes
  28 gg.createAndDisplayGO(id_box1)
  29 gg.setDisplayMode(id_box1,1)
  30 gg.createAndDisplayGO(id_box2)
  31 gg.setDisplayMode(id_box2,1)
  32 gg.createAndDisplayGO(id_box3)
  33 gg.setDisplayMode(id_box3,1)
  34 \endcode
  35
  36 \anchor tui_creation_cylinder
  37 <br><h2>Creation of a Cylinder</h2>
  38
  39 \code
  40 import geompy
  41 import salome
  42
  43 gg = salome.ImportComponentGUI("GEOM")
  44
  45 # create a vertex and a vector
  46 p1 = geompy.MakeVertex(25, 35, 45)
  47 p2 = geompy.MakeVertex(70, 70, 70)
  48 v = geompy.MakeVector(p1, p2)
  49
  50 # create cylinders
  51 height = 40
  52
  53 radius1 = 15
  54 cylinder1 = geompy.MakeCylinder(p1, v, radius1, height)
  55
  56 radius2 = 30
  57 cylinder2 = geompy.MakeCylinderRH(radius2, height)
  58
  59 # add objects in the study
  60 id_cylinder1 = geompy.addToStudy(cylinder1,"Cylinder1")
  61 id_cylinder2 = geompy.addToStudy(cylinder2,"Cylinder2")
  62
  63 # display the cylinders
  64 gg.createAndDisplayGO(id_cylinder1)
  65 gg.setDisplayMode(id_cylinder1,1)
  66 gg.createAndDisplayGO(id_cylinder2)
  67 gg.setDisplayMode(id_cylinder2,1)
  68 \endcode
  69
  70 \anchor tui_creation_sphere
  71 <br><h2>Creation of a Sphere</h2>
  72
  73 \code
  74 import geompy
  75 import salome
  76 gg = salome.ImportComponentGUI("GEOM")
  77
  78 # create a vertex
  79 p = geompy.MakeVertex(55, 45, 25)
  80
  81 # create spheres
  82 radius1 = 20
  83 sphere1 = geompy.MakeSpherePntR(p, radius1)
  84 radius2 = 15
  85 sphere2 = geompy.MakeSphere(0, 0, 45, radius2)
  86 radius3 = 30
  87 sphere3 = geompy.MakeSphereR(radius3)
  88
  89 # add objects in the study
  90 id_sphere1 = geompy.addToStudy(sphere1,"Sphere1")
  91 id_sphere2 = geompy.addToStudy(sphere2,"Sphere2")
  92 id_sphere3 = geompy.addToStudy(sphere3,"Sphere3")
  93
  94 # display spheres
  95 gg.createAndDisplayGO(id_sphere1)
  96 gg.setDisplayMode(id_sphere1,1)
  97 gg.createAndDisplayGO(id_sphere2)
  98 gg.setDisplayMode(id_sphere2,1)
  99 gg.createAndDisplayGO(id_sphere3)
 100 gg.setDisplayMode(id_sphere3,1)
 101 \endcode
 102
 103 \anchor tui_creation_torus
 104 <br><h2>Creation of a Torus</h2>
 105
 106 \code
 107 import geompy
 108 import salome
 109 gg = salome.ImportComponentGUI("GEOM")
 110
 111 # create a vertex and a vector
 112 p1 = geompy.MakeVertex(35, 40, 45)
 113 p2 = geompy.MakeVertex(35, 45, 70)
 114 v = geompy.MakeVector(p1, p2)
 115
 116 # create toruses
 117 torus1 = geompy.MakeTorus(p1, v, 20, 10)
 118 torus2 = geompy.MakeTorusRR(30, 15)
 119
 120 # add objects in the study
 121 id_torus1 = geompy.addToStudy(torus1,"Torus1")
 122 id_torus2 = geompy.addToStudy(torus2,"Torus2")
 123
 124 # display toruses
 125 gg.createAndDisplayGO(id_torus1)
 126 gg.setDisplayMode(id_torus1,1)
 127 gg.createAndDisplayGO(id_torus2)
 128 gg.setDisplayMode(id_torus2,1)
 129 \endcode
 130
 131 \anchor tui_creation_cone
 132 <br><h2>Creation of a Cone</h2>
 133
 134 \code
 135 import geompy
 136 import salome
 137 gg = salome.ImportComponentGUI("GEOM")
 138
 139 # create a vertex and a vector
 140 p1 = geompy.MakeVertex(35, 35, 0)
 141 p2 = geompy.MakeVertex(35, 35, 70)
 142 v = geompy.MakeVector(p1, p2)
 143
 144 # create cones
 145 cone1 = geompy.MakeCone(p1, v, 17, 1, 20)
 146 cone2 = geompy.MakeConeR1R2H(30, 10, 30)
 147
 148 # add objects in the study
 149 id_cone1 = geompy.addToStudy(cone1,"Cone1")
 150 id_cone2 = geompy.addToStudy(cone2,"Cone2")
 151
 152 # display cones
 153 gg.createAndDisplayGO(id_cone1)
 154 gg.setDisplayMode(id_cone1,1)
 155 gg.createAndDisplayGO(id_cone2)
 156 gg.setDisplayMode(id_cone2,1)
 157 \endcode
 158
 159 \anchor tui_creation_disk
 160 <br><h2>Creation of a Disk</h2>
 161
 162 \code
 163 import geompy
 164 import salome
 165 gg = salome.ImportComponentGUI("GEOM")
 166
 167 # create vertices
 168 p0 = geompy.MakeVertex(0., 0., 0.)
 169 px = geompy.MakeVertex(100., 0.  , 0.  )
 170 py = geompy.MakeVertex(0.  , 100., 0.  )
 171 pz = geompy.MakeVertex(0.  , 0.  , 100.)
 172
 173 # create a vector on two points
 174 vxy  = geompy.MakeVector(px, py)
 175
 176 # create a disk in OXY plane
 177 disk1 = geompy.MakeDiskR(100, 1)
 178
 179 # create a disk from a point, a vector and a radius
 180 disk2 = geompy.MakeDiskPntVecR(pz, vxy, 30)
 181
 182 #create a circle from three points
 183 disk3 = geompy.MakeDiskThreePnt(p0, px, py)
 184
 185 # add objects in the study
 186 id_vxy    = geompy.addToStudy(vxy,  "Vector")
 187 id_disk1  = geompy.addToStudy(disk1,"Disk1")
 188 id_disk2  = geompy.addToStudy(disk2,"Disk2")
 189 id_disk3  = geompy.addToStudy(disk3,"Disk3")
 190
 191 # display disks
 192 gg.createAndDisplayGO(id_vxy)
 193 gg.createAndDisplayGO(id_disk1)
 194 gg.createAndDisplayGO(id_diks2)
 195 gg.createAndDisplayGO(id_diks3)
 196 \endcode
 197
 198 \anchor tui_creation_squareface
 199 <br><h2>Creation of a Face</h2>
 200
 201 \code
 202 import geompy
 203 import salome
 204 gg = salome.ImportComponentGUI("GEOM")
 205
 206 # create vertices
 207 px = geompy.MakeVertex(100., 0.  , 0.  )
 208 py = geompy.MakeVertex(0.  , 100., 0.  )
 209
 210 # create a vector on two points
 211 vxy  = geompy.MakeVector(px, py)
 212
 213 # create a face in OXY plane
 214 face1 = geompy.MakeFaceHW(100, 100, 1)
 215
 216 # create a disk from a point, a vector and a radius
 217 face2 = geompy.MakeFaceObjHW(vxy, 50, 150)
 218
 219 #create a circle from three points
 220 face3 = geompy.MakeFaceObjHW(face2, 150, 50)
 221
 222 # add objects in the study
 223 id_vxy    = geompy.addToStudy(vxy,  "Vector")
 224 id_face1  = geompy.addToStudy(face1,"Face1")
 225 id_face2  = geompy.addToStudy(face2,"Face2")
 226 id_face3  = geompy.addToStudy(face3,"Face3")
 227
 228 # display disks
 229 gg.createAndDisplayGO(id_vxy)
 230 gg.createAndDisplayGO(id_face1)
 231 gg.createAndDisplayGO(id_face2)
 232 gg.createAndDisplayGO(id_face3)
 233 \endcode
 234
 235 */