From 92ca3d3450376d3328e2955a1cc6a41b222251d8 Mon Sep 17 00:00:00 2001 From: rnc Date: Wed, 14 Mar 2012 15:17:05 +0000 Subject: [PATCH] Sketcher documentation update --- .../gui/GEOM/input/creating_sketcher.doc | 112 ++++++++++++------ 1 file changed, 79 insertions(+), 33 deletions(-) diff --git a/doc/salome/gui/GEOM/input/creating_sketcher.doc b/doc/salome/gui/GEOM/input/creating_sketcher.doc index 554e22f3a..fd7553df2 100644 --- a/doc/salome/gui/GEOM/input/creating_sketcher.doc +++ b/doc/salome/gui/GEOM/input/creating_sketcher.doc @@ -2,38 +2,83 @@ \page create_sketcher_page Sketcher -Sketcher allows to create curves of 2 types: line segment and arc. -By default the start point of the curve is located at the point of +The sketcher allows you to create a profile made of curves of 2 types: line segments and arcs. + +Example: + +\image html sketch_example.png + +To create a \b Sketch: + +
    +
  1. In the main menu select New Entity / Sketch or click on \image html sketch.png
    2. + +
  2. Select the plane or the planar face on which to create the sketch. By default the sketch is created on the XOY plane of the global coordinate system. +If Local Coordinate systems have been created in the study they appear in the combobox and can be selected as reference coordinate system.
    3. + +
  3. Select a start point. By default the start point of the curve is located at the point of origin of the reference coordinate system and the curve lies in the -plane XOY. The end of the curve is defined by -means of "destination", which can be a destination point (coupled with a radius -or a center for an arc) or a destination direction coupled with length -of a segment or angle and radius of an arc. +plane XOY.
    4. -\n Warning: When constructing an arc by its center and destination point, -the constraint on the center is first taken into account. Therefore -if the constraints are incompatible the destination point won't lie -on the constructed arc (a warning message will be displayed). +
  4. Create curve portions and click on \b Apply after each step.
    5. -\n Sketcher is able to create planar curves only. Therefore, it is -necessary to select coordinate system (Global or Local) before starting -a sketch. Sketcher creates curves lying in the XOY plane of the selected Coordinate System. +
  5. Select either \b Close or Sketch Closure if you want to close the profile before closing the window.
    6. +
-\n This functionality is available from the main menu via New -Entity / Sketch. +To create a \b Segment: -\n The Result of the operation will be a \b GEOM_Object. +
    +
  1. In the Element Type part of the dialog box select: -\n TUI Command: geompy.MakeSketcher(Command, WorkingPlane) -\n This algorithm creates a sketcher (wire or face), following the -textual description, passed through the Command argument. The edges of -the resulting wire or face will be arcs of circles and/or linear -segments. -\n \em Command is a string, defining the sketcher by the coordinates of -points in the current LCS. -\n WorkingPlane can be a Local CS, a plane, or a planar face. The plane is -defined by the XYZ coordinates of three non-coincident points. The -planar face is an existing GEOM_Object. +\image html line_icon.png
    2. + +
  2. You can define the segment by either it's end point or a \b direction and a length. The direction is defined relatively to the tangent at the last point of the sketch. It can be: + + - Tangent (colinear to the tangent at the last point) + - Perpendicular + - Defined by an angle + - Defined by a vector (Vx, Vy) + +
    3. + +
+ +To create an \b Arc: + +
    +
  1. In the Element Type part of the dialog box select \image html arc_icon.png
    2. + +
  2. You can define the segment by either it's end point or a \b direction a \b radius and an \b angle.
    3. + + + +
+ +For the first segment or arc of the sketch the reference direction is the X direction of the reference coordinate system. + +\n The Result of the operation will be a \b Wire. + + +\n Dialog Box: + +\image html sketcher_dlg.png \n Arguments:
    @@ -63,15 +108,16 @@ is predefined and is equal to 90 degrees); \n "Sketch Validation" button applies the wire, only red part will be built by "Sketch Validation". \n "Sketch Closure" will close the Sketch by straight line from last red part and apply it. -\n Dialog Box: -\image html neo-scetcher1.png -
    -\image html neo-scetcher2.png - -\n Example: +\n TUI Command: geompy.MakeSketcherOnPlane(Command, WorkingPlane) +\n This algorithm creates a sketcher (wire or face), following the +textual description, passed through the Command argument. The edges of +the resulting wire or face will be arcs of circles and/or linear +segments. +\n \em Command is a string, defining the sketcher by the coordinates of +points in the current LCS. +\n WorkingPlane can be a Local CS, a plane, or a planar face. -\image html image204.png "Creation of a circle with sketcher" Our TUI Scripts provide you with useful examples of the use of \ref tui_sketcher_page "Sketcher". -- 2.39.2