mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-08-09 13:22:24 +03:00
973c2be1e1
The copying permission statements at the beginning of source files updated to refer to LGPL. Copyright dates extended till 2014 in advance.
81 lines
3.2 KiB
Plaintext
81 lines
3.2 KiB
Plaintext
-- Created on: 1995-11-02
|
|
-- Created by: Jing Cheng MEI
|
|
-- Copyright (c) 1995-1999 Matra Datavision
|
|
-- Copyright (c) 1999-2014 OPEN CASCADE SAS
|
|
--
|
|
-- This file is part of Open CASCADE Technology software library.
|
|
--
|
|
-- This library is free software; you can redistribute it and / or modify it
|
|
-- under the terms of the GNU Lesser General Public version 2.1 as published
|
|
-- by the Free Software Foundation, with special exception defined in the file
|
|
-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
|
|
-- distribution for complete text of the license and disclaimer of any warranty.
|
|
--
|
|
-- Alternatively, this file may be used under the terms of Open CASCADE
|
|
-- commercial license or contractual agreement.
|
|
|
|
class FindPlane from BRepBuilderAPI
|
|
|
|
---Purpose: Describes functions to find the plane in which the edges
|
|
-- of a given shape are located.
|
|
-- A FindPlane object provides a framework for:
|
|
-- - extracting the edges of a given shape,
|
|
-- - implementing the construction algorithm, and
|
|
-- - consulting the result.
|
|
|
|
uses
|
|
|
|
Shape from TopoDS,
|
|
Plane from Geom
|
|
|
|
raises
|
|
|
|
NoSuchObject from Standard
|
|
|
|
is
|
|
|
|
Create
|
|
returns FindPlane from BRepBuilderAPI;
|
|
---Purpose: Initializes an empty algorithm. The function Init is then used to define the shape.
|
|
|
|
Create (S : Shape from TopoDS;
|
|
Tol : Real from Standard = -1)
|
|
returns FindPlane from BRepBuilderAPI;
|
|
---Purpose: Constructs the plane containing the edges of the shape S.
|
|
-- A plane is built only if all the edges are within a distance
|
|
-- of less than or equal to tolerance from a planar surface.
|
|
-- This tolerance value is equal to the larger of the following two values:
|
|
-- - Tol, where the default value is negative, or
|
|
-- - the largest of the tolerance values assigned to the individual edges of S.
|
|
-- Use the function Found to verify that a plane is built.
|
|
-- The resulting plane is then retrieved using the function Plane.
|
|
|
|
Init (me : in out;
|
|
S : Shape from TopoDS;
|
|
Tol : Real from Standard = -1);
|
|
---Purpose: Constructs the plane containing the edges of the shape S.
|
|
-- A plane is built only if all the edges are within a distance
|
|
-- of less than or equal to tolerance from a planar surface.
|
|
-- This tolerance value is equal to the larger of the following two values:
|
|
-- - Tol, where the default value is negative, or
|
|
-- - the largest of the tolerance values assigned to the individual edges of S.
|
|
-- Use the function Found to verify that a plane is built.
|
|
-- The resulting plane is then retrieved using the function Plane.
|
|
|
|
Found(me)
|
|
returns Boolean from Standard;
|
|
---Purpose: Returns true if a plane containing the edges of the
|
|
-- shape is found and built. Use the function Plane to consult the result.
|
|
Plane(me)
|
|
returns mutable Plane from Geom;
|
|
---Purpose: Returns the plane containing the edges of the shape.
|
|
-- Warning
|
|
-- Use the function Found to verify that the plane is built. If
|
|
-- a plane is not found, Plane returns a null handle.
|
|
|
|
fields
|
|
|
|
myPlane : Plane from Geom;
|
|
|
|
end FindPlane;
|