Commit | Line | Data |
---|---|---|

b311480e | 1 | -- Created on: 1995-11-02 |

2 | -- Created by: Jing Cheng MEI | |

3 | -- Copyright (c) 1995-1999 Matra Datavision | |

973c2be1 | 4 | -- Copyright (c) 1999-2014 OPEN CASCADE SAS |

b311480e | 5 | -- |

973c2be1 | 6 | -- This file is part of Open CASCADE Technology software library. |

b311480e | 7 | -- |

d5f74e42 | 8 | -- This library is free software; you can redistribute it and/or modify it under |

9 | -- the terms of the GNU Lesser General Public License version 2.1 as published | |

973c2be1 | 10 | -- by the Free Software Foundation, with special exception defined in the file |

11 | -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT | |

12 | -- distribution for complete text of the license and disclaimer of any warranty. | |

b311480e | 13 | -- |

973c2be1 | 14 | -- Alternatively, this file may be used under the terms of Open CASCADE |

15 | -- commercial license or contractual agreement. | |

7fd59977 | 16 | |

17 | class FindPlane from BRepBuilderAPI | |

18 | ||

19 | ---Purpose: Describes functions to find the plane in which the edges | |

20 | -- of a given shape are located. | |

21 | -- A FindPlane object provides a framework for: | |

22 | -- - extracting the edges of a given shape, | |

23 | -- - implementing the construction algorithm, and | |

24 | -- - consulting the result. | |

25 | ||

26 | uses | |

27 | ||

28 | Shape from TopoDS, | |

29 | Plane from Geom | |

30 | ||

31 | raises | |

32 | ||

33 | NoSuchObject from Standard | |

34 | ||

35 | is | |

36 | ||

37 | Create | |

38 | returns FindPlane from BRepBuilderAPI; | |

39 | ---Purpose: Initializes an empty algorithm. The function Init is then used to define the shape. | |

40 | ||

41 | Create (S : Shape from TopoDS; | |

42 | Tol : Real from Standard = -1) | |

43 | returns FindPlane from BRepBuilderAPI; | |

44 | ---Purpose: Constructs the plane containing the edges of the shape S. | |

45 | -- A plane is built only if all the edges are within a distance | |

46 | -- of less than or equal to tolerance from a planar surface. | |

47 | -- This tolerance value is equal to the larger of the following two values: | |

48 | -- - Tol, where the default value is negative, or | |

49 | -- - the largest of the tolerance values assigned to the individual edges of S. | |

50 | -- Use the function Found to verify that a plane is built. | |

51 | -- The resulting plane is then retrieved using the function Plane. | |

52 | ||

53 | Init (me : in out; | |

54 | S : Shape from TopoDS; | |

55 | Tol : Real from Standard = -1); | |

56 | ---Purpose: Constructs the plane containing the edges of the shape S. | |

57 | -- A plane is built only if all the edges are within a distance | |

58 | -- of less than or equal to tolerance from a planar surface. | |

59 | -- This tolerance value is equal to the larger of the following two values: | |

60 | -- - Tol, where the default value is negative, or | |

61 | -- - the largest of the tolerance values assigned to the individual edges of S. | |

62 | -- Use the function Found to verify that a plane is built. | |

63 | -- The resulting plane is then retrieved using the function Plane. | |

64 | ||

65 | Found(me) | |

66 | returns Boolean from Standard; | |

67 | ---Purpose: Returns true if a plane containing the edges of the | |

68 | -- shape is found and built. Use the function Plane to consult the result. | |

69 | Plane(me) | |

6e33d3ce | 70 | returns Plane from Geom; |

7fd59977 | 71 | ---Purpose: Returns the plane containing the edges of the shape. |

72 | -- Warning | |

73 | -- Use the function Found to verify that the plane is built. If | |

74 | -- a plane is not found, Plane returns a null handle. | |

75 | ||

76 | fields | |

77 | ||

78 | myPlane : Plane from Geom; | |

79 | ||

80 | end FindPlane; |