doc/salome/gui/GEOM/input/chamfer_operation.doc

   1 /*!
   2
   3 \page chamfer_operation_page Chamfer
   4
   5 \n To produce a \b Chamfer in the <b>Main Menu</b> select
   6 <b>Operations - > Transformation - > Chamfer</b>
   7
   8 \n This operation allows you to make chamfer of the edges of a Shape.
   9 \n The \b Result will be a \b GEOM_Object.
  10
  11 \n To create chamfer on all edges of the given shape, you need to
  12 define the <b>Main Object</b> to create a chamfer on and the \b
  13 Dimension (radius) of the chamfer.
  14 \n <b>TUI Command:</b> <em>geompy.MakeChamferAll(Shape, D)</em>
  15 \n <b>Arguments:</b> Name + 1 SHAPE + 1 value (Chamfer dimension).
  16
  17 \image html chamfer1.png
  18
  19 \image html chamfer_all.png "Chamfer on the whole object"
  20
  21 \n In the algorithms below there exist two ways to define the \b
  22 Dimension of the Chamfer
  23 \n Firstly the \b Dimension can be defined via \b D1 and \b D2, which
  24 represent the offset on the first and the second face forming the
  25 edge.
  26 \n Secondly the \b Dimension can be defined via \b D, which represents
  27 the offset on the first face, and the \b Angle, which is the angle
  28 between the first face and the chamfer plane.
  29
  30
  31 \n To create chamfer on the specified edges of the given shape,  you
  32 need to define the <b>Main Object</b> to create a fillet on, select
  33 the two faces to which belongs the necessary common edge in the viewer
  34 and define the \b Dimension of the Chamfer.
  35 \n <b>TUI Command:</b> <em>geompy.MakeChamferEdge(Shape, D1, D2,
  36 Face1, Face2),</em> where \em Shape is a shape to create a chamfer on,
  37 \em D1 is a chamfer size along \em Face1, \em D2 is a chamfer size
  38 along \em Face2, \em Face1 and \em Face2 are indices of faces in
  39 Shape.
  40
  41 \n <b>Alternative TUI Command:</b> <em>geompy.MakeChamferEdge(Shape, D, Angle,
  42 Face1, Face2),</em> where \em D1 is a chamfer size along \em Face1 and
  43 \em Angle is the angle between Face1 and the chamfer plane.
  44
  45 \image html chamfer2.png
  46
  47 \image html chamfer_edge.png "Chamfer on the specified edges"
  48
  49 \n To create chamfer on the specified faces of the given shape,  you need
  50 to define the <b>Main Object</b> to create a fillet on, select the
  51 necessary faces the OCC Viewer and define the \b Dimension of the
  52 Chamfer.
  53 \n <b>TUI Command:</b> <em>geompy.MakeChamferFaces(Shape, D1, D2,
  54 ListOfFaceID),</em> where \em Shape is a shape to create chamfer on,
  55 \em D1 and D2 are chamfer sizes along faces from  \em
  56 ListOfFaceID. For each Edge Face1 and Face2 are defined basing
  57 on their indices.
  58
  59 \n <b>Alternative TUI Command:</b> <em>geompy.MakeChamferFaces(Shape, D, Angle,
  60 ListOfFaceID),</em> where \em D1 is a chamfer size along \em Face1 and
  61 \em Angle is the angle between Face1 and the chamfer plane.
  62
  63 \image html chamfer3.png
  64
  65 \image html chamfer_faces.png "Chamfer on the specified faces"
  66
  67 \n To create chamfer on an arbitrary set of edges of the given shape
  68 to define the <b>Main Object</b> to create a fillet on, select the
  69 necessary edges the OCC Viewer and define the \b Dimension of the
  70 Chamfer.
  71 \n <b>TUI Command:</b> <em>geompy.MakeChamferEdges(Shape, D1, D2,
  72 ListOfEdgeID),</em> where \em Shape is a shape to create chamfer on,
  73 \em D1 and D2 are chamfer sizes along faces defined by the algorithm
  74 basing on \em ListOfEdgeID, which is a list of indices of edges in
  75 \em Shape. For each Edge the algorithm selects Face1 and Face2 basing
  76 on their indices.
  77
  78 \n <b>Alternative TUI Command:</b> <em>geompy.MakeChamferEdges(Shape, D, Angle,
  79 ListOfEdgeID),</em> where \em D1 is a chamfer size along \em Face1 and
  80 \em Angle is the angle between Face1 and the chamfer plane.
  81
  82 \image html chamfer4.png
  83
  84 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  85 \ref tui_chamfer "Transformation Operations".
  86
  87 */