From: rnc Date: Tue, 17 Apr 2012 13:11:29 +0000 (+0000) Subject: - reorganization of measurements tools documentation in order to be consistent with... X-Git-Tag: TRIPOLI_323~38 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=b1e5af49711438067d5a66b7ebf8eba828330463;p=modules%2Fgeom.git - reorganization of measurements tools documentation in order to be consistent with teh doc of other functionalities - some other small modifications to be more consistent --- diff --git a/doc/salome/gui/GEOM/input/angle.doc b/doc/salome/gui/GEOM/input/angle.doc new file mode 100644 index 000000000..d2c2f456f --- /dev/null +++ b/doc/salome/gui/GEOM/input/angle.doc @@ -0,0 +1,18 @@ +/*! + +\page angle_page Angle + +Returns the angle between two lines or linear edges in degrees. + +\note If both arguments are vectors, the angle is computed in + accordance with their orientations, otherwise the minimum angle + is computed. + +\n TUI Command: geompy.GetAngle(shape1, shape2), where +Shape1 and Shape2 are shapes between which the angle is computed. +Another TUI command is geompy.GetAngleRadians(shape1,shape2), +which returns the value of angle in radians. + +\image html angle.png + +*/ \ No newline at end of file diff --git a/doc/salome/gui/GEOM/input/basic_prop.doc b/doc/salome/gui/GEOM/input/basic_prop.doc new file mode 100644 index 000000000..1245a8e85 --- /dev/null +++ b/doc/salome/gui/GEOM/input/basic_prop.doc @@ -0,0 +1,15 @@ +/*! + +\page basic_prop_page Basic Properties + +Returns the properties (Length, Surface & Volume) for the selected +geometrical object. + +Result: Display Length, Surface & Volume in the form of +Python Tuple. +\nTUI Command: geompy.BasicProperties(Shape), where +\em Shape is a shape whose properties are inquired. + +\image html neo-basicprop.png + +*/ \ No newline at end of file diff --git a/doc/salome/gui/GEOM/input/boudaries.doc b/doc/salome/gui/GEOM/input/boudaries.doc new file mode 100644 index 000000000..6c7bdd631 --- /dev/null +++ b/doc/salome/gui/GEOM/input/boudaries.doc @@ -0,0 +1,16 @@ +/*! + +\page boundaries_page Check Free Boundaries + +Detects and highlights wires and edges that are not shared between +two faces and are considered a shape's boundary. + +TUI Command: (NoError, ClosedWires, OpenWires) = +geompy.GetFreeBoundary(Shape), where \em Shape is a shape to be +checked, \em NoError is false if an error occurred while checking free +boundaries, \em ClosedWires is a list of closed free boundary wires, +\em OpenWires is a list of open free boundary wires. + +\image html repair9.png + +*/ \ No newline at end of file diff --git a/doc/salome/gui/GEOM/input/bounding_box.doc b/doc/salome/gui/GEOM/input/bounding_box.doc new file mode 100644 index 000000000..0cbfad142 --- /dev/null +++ b/doc/salome/gui/GEOM/input/bounding_box.doc @@ -0,0 +1,23 @@ +/*! + +\page bounding_box_page Bounding Box + +Returns the dimensions of the bounding box for the selected +geometrical object. + +\note In order to take into account any possible distortion of a shape +that affects the resulting bounding box, the algorithm enlarges +the bounding box to the value of the maximum deflection value of +faces (by iterating through all faces of a shape). +This functionallity is implemented in such a way in order to have +satisfactory performance. + +Result: Displays the dimensions of the bounding box of a +geometrical object in the form of Python Tuple (Xmin, Xmax, Ymin, +Ymax, Zmin, Zmax). +\n TUI Command: geompy.BoundingBox(Shape), where \em Shape +is a shape for which a bounding box is computed. + +\image html measures5.png + +*/ \ No newline at end of file diff --git a/doc/salome/gui/GEOM/input/center_mass.doc b/doc/salome/gui/GEOM/input/center_mass.doc new file mode 100644 index 000000000..380b067ae --- /dev/null +++ b/doc/salome/gui/GEOM/input/center_mass.doc @@ -0,0 +1,14 @@ +/*! + +\page center_mass_page Center of Mass + +Calculates and returns the coordinates of the gravity center for +the selected geometrical object. + +Result: GEOM_Object (vertex). +\n TUI Command: geompy.MakeCDG(Shape), where \em Shape is +the shape for which a center of gravity is computed. + +\image html measures3.png + +*/ \ No newline at end of file diff --git a/doc/salome/gui/GEOM/input/check_compound.doc b/doc/salome/gui/GEOM/input/check_compound.doc new file mode 100644 index 000000000..2557af09d --- /dev/null +++ b/doc/salome/gui/GEOM/input/check_compound.doc @@ -0,0 +1,31 @@ +/*! + +\page check_compound_page Check Compound of Blocks + +Checks whether a shape is a compound of glued blocks. To be +considered as a compound of blocks, the given shape must satisfy the +following conditions: + + +\n Informs of the following possible errors: + + +\n Result: Boolean; highlight in the viewer. +\n TUI Command: +geompy.CheckCompoundOfBlocks(Compound). Checks if the shape +is a valid compound of blocks. If it is true, then the validity flag +is returned, and encountered errors are printed in the python console. + +\image html measures10.png + +*/ \ No newline at end of file diff --git a/doc/salome/gui/GEOM/input/check_shape.doc b/doc/salome/gui/GEOM/input/check_shape.doc new file mode 100644 index 000000000..46669f023 --- /dev/null +++ b/doc/salome/gui/GEOM/input/check_shape.doc @@ -0,0 +1,16 @@ +/*! + +\page check_page Check Shape + +\n Checks the topology of the selected geometrical object and returns +True if it is valid. Check also geometry checkbox allows to test the +geometry as well. + +\n Result: Boolean. +\n TUI Command: geompy.CheckShape(theShape, theIsCheckGeom = 0), +where \em theShape is the shape checked for validity. + +\image html measures9.png + + +*/ \ No newline at end of file diff --git a/doc/salome/gui/GEOM/input/free_faces.doc b/doc/salome/gui/GEOM/input/free_faces.doc new file mode 100644 index 000000000..1985495b4 --- /dev/null +++ b/doc/salome/gui/GEOM/input/free_faces.doc @@ -0,0 +1,17 @@ +/*! + +\page faces_page Check Free Faces + +Highlights all free faces of a given shape. A free +face is a face which is not shared between two objects of the shape. + +\note This functionality works only in VTK viewer. + +\b Result: a list of IDs of all free faces, containing in the shape. + +TUI Command: GetFreeFacesIDs(Shape), where \em Shape is +a shape to be checked. + +\image html repair10.png + +*/ \ No newline at end of file diff --git a/doc/salome/gui/GEOM/input/geometrical_object_properties.doc b/doc/salome/gui/GEOM/input/geometrical_object_properties.doc index e323c6932..f284337fc 100644 --- a/doc/salome/gui/GEOM/input/geometrical_object_properties.doc +++ b/doc/salome/gui/GEOM/input/geometrical_object_properties.doc @@ -1,8 +1,6 @@ /*! -\page geometrical_obj_prop_page Geometrical Object Properties - -

Geometrical Object Types

+\page geometrical_obj_prop_page Geometrical Object Types GetType function: diff --git a/doc/salome/gui/GEOM/input/index.doc b/doc/salome/gui/GEOM/input/index.doc index 54083afa6..c09e4a8c6 100644 --- a/doc/salome/gui/GEOM/input/index.doc +++ b/doc/salome/gui/GEOM/input/index.doc @@ -13,13 +13,12 @@ using a wide range of functions;
  • \subpage transform_geom_obj_page "transformation of geometrical objects" using various algorithms;
  • \subpage repairing_operations_page "optimization of geometrical objects";
    • -
  • viewing \subpage geometrical_obj_prop_page "geometrical object properties".
    • -
  • and other information about geometrical objects using +
  • Get information about geometrical objects using \subpage using_measurement_tools_page "measurement tools".
    • +
  • \subpage pictures_page "Design shapes from pictures" +
  • and viewing \subpage geometrical_obj_prop_page "geometrical object properties".
  • easily setting parameters via the variables predefined in \subpage using_notebook_geom_page "Salome notebook".
    • -
  • \subpage import_picture_page, such as engeneering drawings or nautical charts as a support for shape design. -
  • \subpage shape_recognition_page previously imported in the OCC viewer . diff --git a/doc/salome/gui/GEOM/input/inertia.doc b/doc/salome/gui/GEOM/input/inertia.doc new file mode 100644 index 000000000..2141c8b10 --- /dev/null +++ b/doc/salome/gui/GEOM/input/inertia.doc @@ -0,0 +1,19 @@ +/*! + +\page inertia_page Inertia + +Returns the axial moments of inertia for the selected geometrical object. + +\n Result: Displays the matrix of the own moments of inertia and +the relative moments of inertia in the form of Python Tuple +
    (I11, I12, I13,
    +
    I21, I22, I23,
    +
    I31, I32, I33,
    +
    Ix, Iy, Iz).
    +\n TUI Command: geompy.Inertia(Shape), where \em Shape is +a shape for which the own matrix of inertia and the relative moments of inertia are +returned. + +\image html measures4.png + +*/ \ No newline at end of file diff --git a/doc/salome/gui/GEOM/input/min_distance.doc b/doc/salome/gui/GEOM/input/min_distance.doc new file mode 100644 index 000000000..afcf7e926 --- /dev/null +++ b/doc/salome/gui/GEOM/input/min_distance.doc @@ -0,0 +1,14 @@ +/*! + +\page min_distance_page Min. Distance + +Returns the minimum distance between two geometrical objects and +the coordinates of the vector of distance and shows the vector in the viewer. + +TUI Command: geompy.MinDistance(Shape1, Shape2), +where \em Shape1 and \em Shape2 are shapes between which the minimal +distance is computed. + +\image html distance.png + +*/ \ No newline at end of file diff --git a/doc/salome/gui/GEOM/input/normal.doc b/doc/salome/gui/GEOM/input/normal.doc new file mode 100644 index 000000000..8127b38f0 --- /dev/null +++ b/doc/salome/gui/GEOM/input/normal.doc @@ -0,0 +1,10 @@ +/*! + +\page normal_page Normal to a Face + +\n Calculates the normal vector to the selected \b Face. The \b Point +is a point of the \b Face, where the Normal should be calculated. + +\image html normaletoface.png + +*/ diff --git a/doc/salome/gui/GEOM/input/pictures.doc b/doc/salome/gui/GEOM/input/pictures.doc new file mode 100644 index 000000000..8101de7fd --- /dev/null +++ b/doc/salome/gui/GEOM/input/pictures.doc @@ -0,0 +1,10 @@ +/*! + +\page pictures_page Designing shapes from pictures + +Some tools in GEOM that allow you to create shapes, basing the design on imported pictures (engineering drawings, nautical charts ...) : + +
  • \subpage import_picture_page, such as engeneering drawings or nautical charts as a support for shape design. +
  • \subpage shape_recognition_page previously imported in the OCC viewer . + +*/ \ No newline at end of file diff --git a/doc/salome/gui/GEOM/input/point_coordinates.doc b/doc/salome/gui/GEOM/input/point_coordinates.doc new file mode 100644 index 000000000..b1dddfcde --- /dev/null +++ b/doc/salome/gui/GEOM/input/point_coordinates.doc @@ -0,0 +1,13 @@ +/*! + +\page point_coordinates_page Point Coordinates + +Returns the coordinates of a point. + +Result: Point coordinates (X, Y, Z) in 3D space in the form of Python Tuple. +\nTUI Command: geompy.PointCoordinates(Point), +where \em Point is a point whose coordinates are inquired. + +\image html measures1.png + +*/ \ No newline at end of file diff --git a/doc/salome/gui/GEOM/input/repairing_operations.doc b/doc/salome/gui/GEOM/input/repairing_operations.doc index 3e10dcd07..96ff03ae0 100644 --- a/doc/salome/gui/GEOM/input/repairing_operations.doc +++ b/doc/salome/gui/GEOM/input/repairing_operations.doc @@ -1,6 +1,6 @@ /*! -\page repairing_operations_page Repairing Operations +\page repairing_operations_page Repairing geometrical objects Repairing operations improve the shapes, processing them with complex algorithms: diff --git a/doc/salome/gui/GEOM/input/self-intersections.doc b/doc/salome/gui/GEOM/input/self-intersections.doc new file mode 100644 index 000000000..e5d2dea53 --- /dev/null +++ b/doc/salome/gui/GEOM/input/self-intersections.doc @@ -0,0 +1,20 @@ +/*! + +\page check_self_intersections_page Detect Self-intersections + +\n Checks the topology of the selected shape to detect self-intersections. + Returns True if there are no self-intersections. Reports pairs of + intersected sub-shapes, if there are any. + +\note This tool is useful for detection of shapes, not suitable for +arguments of Boolean operations and Partition algorithm. +For more information about Partition and Boolean Operations Algorithms +and their limitations refer to this document. + +\n Result: Boolean. +\n TUI Command: geompy.CheckSelfIntersections(theShape), +where \em theShape is the shape checked for validity. + +\image html measures11.png + +*/ \ No newline at end of file diff --git a/doc/salome/gui/GEOM/input/tolerance.doc b/doc/salome/gui/GEOM/input/tolerance.doc new file mode 100644 index 000000000..37b37ab72 --- /dev/null +++ b/doc/salome/gui/GEOM/input/tolerance.doc @@ -0,0 +1,15 @@ +/*! + +\page tolerance_page Tolerance + +\n Returns the maximum and the minimum tolerance for the selected +geometrical object. + +\n Result: Displays the tolerance values (FaceMinTol, +FaceMaxTol, EgdeMinTol, EgdeMaxTol, VertexMinTol, VertexMaxTol). +\n TUI Command: geompy.Tolerance(Shape), where \em Shape +is a shape for which minimal and maximal tolerances are returned. + +\image html new-tolerance.png + +*/ \ No newline at end of file diff --git a/doc/salome/gui/GEOM/input/using_measurement_tools.doc b/doc/salome/gui/GEOM/input/using_measurement_tools.doc index 9f30de2a4..6b873ee1c 100644 --- a/doc/salome/gui/GEOM/input/using_measurement_tools.doc +++ b/doc/salome/gui/GEOM/input/using_measurement_tools.doc @@ -1,282 +1,31 @@ /*! -\page using_measurement_tools_page Using measurement tools +\page using_measurement_tools_page Measuring objects properties \n Measurement tools in GEOM are necessary for getting different data -concerning created or imported geometrical objects. They are: +concerning created or imported geometrical objects : -\n Our TUI Scripts show how to use -\ref tui_measurement_tools_page "Measurement Tools" with TUI -commands. +\n Or to check their integrity: -\n To use measurement tools: -\par -In the Main menu select \b Measures submenu. - -\anchor point_coord_anchor -

    Point coordinates

    - -\n Returns the coordinates of a point. - -\n Result: Point coordinates (X, Y, Z) in 3D space in the form of Python Tuple. -\n TUI Command: geompy.PointCoordinates(Point), -where \em Point is a point whose coordinates are inquired. - -\image html measures1.png - -\anchor basic_prop_anchor -

    Basic properties

    - -\n Returns the properties (Length, Surface & Volume) for the selected -geometrical object. - -\n Result: Display Length, Surface & Volume in the form of -Python Tuple. -\n TUI Command: geompy.BasicProperties(Shape), where -\em Shape is a shape whose properties are inquired. - -\image html neo-basicprop.png - -\anchor center_mass_anchor -

    Center of mass

    - -\n Calculates and returns the coordinates of the gravity center for -the selected geometrical object. - -\n Result: GEOM_Object (vertex). -\n TUI Command: geompy.MakeCDG(Shape), where \em Shape is -the shape for which a center of gravity is computed. - -\image html measures3.png - -\anchor vertex_by_index -

    Get Vertex by Index

    - -\n It is possible to get the first or the last vertex from an edge or a wire, depending on -its direction (orientation), or to find the vertex by the index inside the wire. -The numeration of vertexes starts from 0. This function has only a TUI implementation) - -\n Result: GEOM_Object (vertex). -\n TUI Command: geompy.GetVertexByIndex(Shape, Index), - geompy.GetFirstVertex(Shape), - geompy.GetLastVertex(Shape), where \em Shape must be Wire or Edge. - -\anchor inertia_anchor -

    Inertia

    - -Returns the axial moments of inertia for the selected geometrical object. - -\n Result: Displays the matrix of the own moments of inertia and -the relative moments of inertia in the form of Python Tuple -
    (I11, I12, I13,
    -
    I21, I22, I23,
    -
    I31, I32, I33,
    -
    Ix, Iy, Iz).
    -\n TUI Command: geompy.Inertia(Shape), where \em Shape is -a shape for which the own matrix of inertia and the relative moments of inertia are -returned. - -\image html measures4.png - -\anchor normale_anchor -

    Normal to a Face

    - -\n Calculates the normal vector to the selected \b Face. The \b Point -is a point of the \b Face, where the Normal should be calculated. - -\image html normaletoface.png - -\anchor boundaries_anchor -

    Check Free Boundaries

    - -\n Detects and highlights wires and edges that are not shared between -two faces and are considered a shape's boundary. - -\n TUI Command: (NoError, ClosedWires, OpenWires) = -geompy.GetFreeBoundary(Shape), where \em Shape is a shape to be -checked, \em NoError is false if an error occurred while checking free -boundaries, \em ClosedWires is a list of closed free boundary wires, -\em OpenWires is a list of open free boundary wires. - -\image html repair9.png - -\anchor faces_anchor -

    Check Free Faces

    - -\n Highlights all free faces of a given shape. A free -face is a face which is not shared between two objects of the shape. - -\n \b NOTE: This functionality works only in VTK viewer. - -\n \b Result: a list of IDs of all free faces, containing in the shape. -\n TUI Command: GetFreeFacesIDs(Shape), where \em Shape is -a shape to be checked. - -\image html repair10.png - -\anchor bounding_box_anchor -

    Bounding box

    - -Returns the dimensions of the bounding box for the selected -geometrical object. - -\b NOTE: In order to take into account any possible distortion of a shape -that affects the resulting bounding box, the algorithm enlarges -the bounding box to the value of the maximum deflection value of -faces (by iterating through all faces of a shape). -This functionallity is implemented in such a way in order to have -satisfactory performance. - -Result: Displays the dimensions of the bounding box of a -geometrical object in the form of Python Tuple (Xmin, Xmax, Ymin, -Ymax, Zmin, Zmax). -\n TUI Command: geompy.BoundingBox(Shape), where \em Shape -is a shape for which a bounding box is computed. - -\image html measures5.png - -\anchor min_distance_anchor -

    Min. distance

    - -\n Returns the minimum distance between two geometrical objects and -the coordinates of the vector of distance and shows the vector in the viewer. - -\n TUI Command: geompy.MinDistance(Shape1, Shape2), -where \em Shape1 and \em Shape2 are shapes between which the minimal -distance is computed. - -\image html distance.png - -\anchor angle_anchor -

    Angle

    - -\n Returns the angle between two lines or linear edges in degrees. - -\note If both arguments are vectors, the angle is computed in - accordance with their orientations, otherwise the minimum angle - is computed. - -\n TUI Command: geompy.GetAngle(shape1, shape2), where -Shape1 and Shape2 are shapes between which the angle is computed. -Another TUI command is geompy.GetAngleRadians(shape1,shape2), -which returns the value of angle in radians. - -\image html angle.png - -\anchor tolerance_anchor -

    Tolerance

    - -\n Returns the maximum and the minimum tolerance for the selected -geometrical object. - -\n Result: Displays the tolerance values (FaceMinTol, -FaceMaxTol, EgdeMinTol, EgdeMaxTol, VertexMinTol, VertexMaxTol). -\n TUI Command: geompy.Tolerance(Shape), where \em Shape -is a shape for which minimal and maximal tolerances are returned. - -\image html new-tolerance.png - -\anchor whatis_anchor -

    WhatIs

    - -\n General information about the selected geometrical object is the -list of types and quantities of all topological entities, composing -the shape. - -\n TUI Command: geompy.WhatIs(Shape), where \em Shape is a -shape from which a description is returned. - -\image html measures8.png - -\n Kind of Shape field characterises the -whole shape. If there is no additional information available for the -shape, Basic Properties button will be disabled, otherwise it -will show a dialog with information about -dimensions, position, orientation and other parameters of the shape. - -\n TUI Command: geompy.KindOfShape(Shape), where \em Shape is a -shape from which a description is returned. - -\image html measures8a.png - -\anchor check_anchor -

    Check

    - -\n Checks the topology of the selected geometrical object and returns -True if it is valid. Check also geometry checkbox allows to test the -geometry as well. - -\n Result: Boolean. -\n TUI Command: geompy.CheckShape(theShape, theIsCheckGeom = 0), -where \em theShape is the shape checked for validity. - -\image html measures9.png - -\anchor check_compound_anchor -

    Check compound of blocks

    - -\n Checks whether a shape is a compound of glued blocks. To be -considered as a compound of blocks, the given shape must satisfy the -following conditions: - - -\n Informs of the following possible errors: -\n Result: Boolean; highlight in the viewer. -\n TUI Command: -geompy.CheckCompoundOfBlocks(Compound). Checks if the shape -is a valid compound of blocks. If it is true, then the validity flag -is returned, and encountered errors are printed in the python console. - -\image html measures10.png - -\anchor check_self_intersections_anchor -

    Detect Self-intersections

    - -\n Checks the topology of the selected shape to detect self-intersections. - Returns True if there are no self-intersections. Reports pairs of - intersected sub-shapes, if there are any. - -\note This tool is useful for detection of shapes, not suitable for -arguments of Boolean operations and Partition algorithm. -For more information about Partition and Boolean Operations Algorithms -and their limitations refer to this document. - -\n Result: Boolean. -\n TUI Command: geompy.CheckSelfIntersections(theShape), -where \em theShape is the shape checked for validity. - -\image html measures11.png - -*/ - +*/ \ No newline at end of file diff --git a/doc/salome/gui/GEOM/input/using_measurement_tools_old.doc b/doc/salome/gui/GEOM/input/using_measurement_tools_old.doc new file mode 100644 index 000000000..e95e6dda7 --- /dev/null +++ b/doc/salome/gui/GEOM/input/using_measurement_tools_old.doc @@ -0,0 +1,282 @@ + + +\page using_measurement_tools_page_old Using measurement tools + +\n Measurement tools in GEOM are necessary for getting different data +concerning created or imported geometrical objects. They are: + + + +\n Our TUI Scripts show how to use +\ref tui_measurement_tools_page "Measurement Tools" with TUI +commands. + +\n To use measurement tools: +\par +In the Main menu select \b Measures submenu. + +\anchor point_coord_anchor +

    Point coordinates

    + +\n Returns the coordinates of a point. + +\n Result: Point coordinates (X, Y, Z) in 3D space in the form of Python Tuple. +\n TUI Command: geompy.PointCoordinates(Point), +where \em Point is a point whose coordinates are inquired. + +\image html measures1.png + +\anchor basic_prop_anchor +

    Basic properties

    + +\n Returns the properties (Length, Surface & Volume) for the selected +geometrical object. + +\n Result: Display Length, Surface & Volume in the form of +Python Tuple. +\n TUI Command: geompy.BasicProperties(Shape), where +\em Shape is a shape whose properties are inquired. + +\image html neo-basicprop.png + +\anchor center_mass_anchor +

    Center of mass

    + +\n Calculates and returns the coordinates of the gravity center for +the selected geometrical object. + +\n Result: GEOM_Object (vertex). +\n TUI Command: geompy.MakeCDG(Shape), where \em Shape is +the shape for which a center of gravity is computed. + +\image html measures3.png + +\anchor vertex_by_index +

    Get Vertex by Index

    + +\n It is possible to get the first or the last vertex from an edge or a wire, depending on +its direction (orientation), or to find the vertex by the index inside the wire. +The numeration of vertexes starts from 0. This function has only a TUI implementation) + +\n Result: GEOM_Object (vertex). +\n TUI Command: geompy.GetVertexByIndex(Shape, Index), + geompy.GetFirstVertex(Shape), + geompy.GetLastVertex(Shape), where \em Shape must be Wire or Edge. + +\anchor inertia_anchor +

    Inertia

    + +Returns the axial moments of inertia for the selected geometrical object. + +\n Result: Displays the matrix of the own moments of inertia and +the relative moments of inertia in the form of Python Tuple +
    (I11, I12, I13,
    +
    I21, I22, I23,
    +
    I31, I32, I33,
    +
    Ix, Iy, Iz).
    +\n TUI Command: geompy.Inertia(Shape), where \em Shape is +a shape for which the own matrix of inertia and the relative moments of inertia are +returned. + +\image html measures4.png + +\anchor normale_anchor +

    Normal to a Face

    + +\n Calculates the normal vector to the selected \b Face. The \b Point +is a point of the \b Face, where the Normal should be calculated. + +\image html normaletoface.png + +\anchor boundaries_anchor +

    Check Free Boundaries

    + +\n Detects and highlights wires and edges that are not shared between +two faces and are considered a shape's boundary. + +\n TUI Command: (NoError, ClosedWires, OpenWires) = +geompy.GetFreeBoundary(Shape), where \em Shape is a shape to be +checked, \em NoError is false if an error occurred while checking free +boundaries, \em ClosedWires is a list of closed free boundary wires, +\em OpenWires is a list of open free boundary wires. + +\image html repair9.png + +\anchor faces_anchor +

    Check Free Faces

    + +\n Highlights all free faces of a given shape. A free +face is a face which is not shared between two objects of the shape. + +\n \b NOTE: This functionality works only in VTK viewer. + +\n \b Result: a list of IDs of all free faces, containing in the shape. +\n TUI Command: GetFreeFacesIDs(Shape), where \em Shape is +a shape to be checked. + +\image html repair10.png + +\anchor bounding_box_anchor +

    Bounding box

    + +Returns the dimensions of the bounding box for the selected +geometrical object. + +\b NOTE: In order to take into account any possible distortion of a shape +that affects the resulting bounding box, the algorithm enlarges +the bounding box to the value of the maximum deflection value of +faces (by iterating through all faces of a shape). +This functionallity is implemented in such a way in order to have +satisfactory performance. + +Result: Displays the dimensions of the bounding box of a +geometrical object in the form of Python Tuple (Xmin, Xmax, Ymin, +Ymax, Zmin, Zmax). +\n TUI Command: geompy.BoundingBox(Shape), where \em Shape +is a shape for which a bounding box is computed. + +\image html measures5.png + +\anchor min_distance_anchor +

    Min. distance

    + +\n Returns the minimum distance between two geometrical objects and +the coordinates of the vector of distance and shows the vector in the viewer. + +\n TUI Command: geompy.MinDistance(Shape1, Shape2), +where \em Shape1 and \em Shape2 are shapes between which the minimal +distance is computed. + +\image html distance.png + +\anchor angle_anchor +

    Angle

    + +\n Returns the angle between two lines or linear edges in degrees. + +\note If both arguments are vectors, the angle is computed in + accordance with their orientations, otherwise the minimum angle + is computed. + +\n TUI Command: geompy.GetAngle(shape1, shape2), where +Shape1 and Shape2 are shapes between which the angle is computed. +Another TUI command is geompy.GetAngleRadians(shape1,shape2), +which returns the value of angle in radians. + +\image html angle.png + +\anchor tolerance_anchor +

    Tolerance

    + +\n Returns the maximum and the minimum tolerance for the selected +geometrical object. + +\n Result: Displays the tolerance values (FaceMinTol, +FaceMaxTol, EgdeMinTol, EgdeMaxTol, VertexMinTol, VertexMaxTol). +\n TUI Command: geompy.Tolerance(Shape), where \em Shape +is a shape for which minimal and maximal tolerances are returned. + +\image html new-tolerance.png + +\anchor whatis_anchor +

    WhatIs

    + +\n General information about the selected geometrical object is the +list of types and quantities of all topological entities, composing +the shape. + +\n TUI Command: geompy.WhatIs(Shape), where \em Shape is a +shape from which a description is returned. + +\image html measures8.png + +\n Kind of Shape field characterises the +whole shape. If there is no additional information available for the +shape, Basic Properties button will be disabled, otherwise it +will show a dialog with information about +dimensions, position, orientation and other parameters of the shape. + +\n TUI Command: geompy.KindOfShape(Shape), where \em Shape is a +shape from which a description is returned. + +\image html measures8a.png + +\anchor check_anchor +

    Check

    + +\n Checks the topology of the selected geometrical object and returns +True if it is valid. Check also geometry checkbox allows to test the +geometry as well. + +\n Result: Boolean. +\n TUI Command: geompy.CheckShape(theShape, theIsCheckGeom = 0), +where \em theShape is the shape checked for validity. + +\image html measures9.png + +\anchor check_compound_anchor +

    Check compound of blocks

    + +\n Checks whether a shape is a compound of glued blocks. To be +considered as a compound of blocks, the given shape must satisfy the +following conditions: + + +\n Informs of the following possible errors: + + +\n Result: Boolean; highlight in the viewer. +\n TUI Command: +geompy.CheckCompoundOfBlocks(Compound). Checks if the shape +is a valid compound of blocks. If it is true, then the validity flag +is returned, and encountered errors are printed in the python console. + +\image html measures10.png + +\anchor check_self_intersections_anchor +

    Detect Self-intersections

    + +\n Checks the topology of the selected shape to detect self-intersections. + Returns True if there are no self-intersections. Reports pairs of + intersected sub-shapes, if there are any. + +\note This tool is useful for detection of shapes, not suitable for +arguments of Boolean operations and Partition algorithm. +For more information about Partition and Boolean Operations Algorithms +and their limitations refer to this document. + +\n Result: Boolean. +\n TUI Command: geompy.CheckSelfIntersections(theShape), +where \em theShape is the shape checked for validity. + +\image html measures11.png + +*/ + diff --git a/doc/salome/gui/GEOM/input/whatis.doc b/doc/salome/gui/GEOM/input/whatis.doc new file mode 100644 index 000000000..6bf3028f0 --- /dev/null +++ b/doc/salome/gui/GEOM/input/whatis.doc @@ -0,0 +1,25 @@ +/*! + +\page whatis_page What Is ? + +General information about the selected geometrical object is the +list of types and quantities of all topological entities, composing +the shape. + +\n TUI Command: geompy.WhatIs(Shape), where \em Shape is a +shape from which a description is returned. + +\image html measures8.png + +\n Kind of Shape field characterises the +whole shape. If there is no additional information available for the +shape, Basic Properties button will be disabled, otherwise it +will show a dialog with information about +dimensions, position, orientation and other parameters of the shape. + +\n TUI Command: geompy.KindOfShape(Shape), where \em Shape is a +shape from which a description is returned. + +\image html measures8a.png + +*/ \ No newline at end of file