mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-04-06 18:26:22 +03:00
42cf5bc1ca
Automatic upgrade of OCCT code by command "occt_upgrade . -nocdl": - WOK-generated header files from inc and sources from drv are moved to src - CDL files removed - All packages are converted to nocdlpack
102 lines
3.3 KiB
C++
102 lines
3.3 KiB
C++
// 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 License 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.
|
|
|
|
#ifndef _BRepBuilderAPI_FindPlane_HeaderFile
|
|
#define _BRepBuilderAPI_FindPlane_HeaderFile
|
|
|
|
#include <Standard.hxx>
|
|
#include <Standard_DefineAlloc.hxx>
|
|
#include <Standard_Handle.hxx>
|
|
|
|
#include <Standard_Real.hxx>
|
|
#include <Standard_Boolean.hxx>
|
|
class Geom_Plane;
|
|
class Standard_NoSuchObject;
|
|
class TopoDS_Shape;
|
|
|
|
|
|
//! 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.
|
|
class BRepBuilderAPI_FindPlane
|
|
{
|
|
public:
|
|
|
|
DEFINE_STANDARD_ALLOC
|
|
|
|
|
|
//! Initializes an empty algorithm. The function Init is then used to define the shape.
|
|
Standard_EXPORT BRepBuilderAPI_FindPlane();
|
|
|
|
//! 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.
|
|
Standard_EXPORT BRepBuilderAPI_FindPlane(const TopoDS_Shape& S, const Standard_Real Tol = -1);
|
|
|
|
//! 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.
|
|
Standard_EXPORT void Init (const TopoDS_Shape& S, const Standard_Real Tol = -1);
|
|
|
|
//! Returns true if a plane containing the edges of the
|
|
//! shape is found and built. Use the function Plane to consult the result.
|
|
Standard_EXPORT Standard_Boolean Found() const;
|
|
|
|
//! 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.
|
|
Standard_EXPORT Handle(Geom_Plane) Plane() const;
|
|
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
|
|
|
Handle(Geom_Plane) myPlane;
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#endif // _BRepBuilderAPI_FindPlane_HeaderFile
|