// Created on: 1992-09-28
// Created by: Remi GILET
// Copyright (c) 1992-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 _GC_MakePlane_HeaderFile
#define _GC_MakePlane_HeaderFile
#include
#include
#include
#include
#include
class StdFail_NotDone;
class gp_Ax2;
class gp_Pln;
class gp_Pnt;
class gp_Dir;
class gp_Ax1;
//! This class implements the following algorithms used
//! to create a Plane from gp.
//! * Create a Plane parallel to another and passing
//! through a point.
//! * Create a Plane passing through 3 points.
//! * Create a Plane by its normal
//! A MakePlane object provides a framework for:
//! - defining the construction of the plane,
//! - implementing the construction algorithm, and
//! - consulting the results. In particular, the Value
//! function returns the constructed plane.
class GC_MakePlane : public GC_Root
{
public:
DEFINE_STANDARD_ALLOC
//! Creates a plane located in 3D space with an axis placement
//! two axis. The "ZDirection" of "A2" is the direction normal
//! to the plane. The "Location" point of "A2" is the origin of
//! the plane. The "XDirection" and "YDirection" of "A2" define
//! the directions of the U isoparametric and V isoparametric
//! curves.
Standard_EXPORT GC_MakePlane(const gp_Ax2& A2);
//! Creates a plane from a non persistent plane from package gp.
Standard_EXPORT GC_MakePlane(const gp_Pln& Pl);
//! P is the "Location" point or origin of the plane.
//! V is the direction normal to the plane.
Standard_EXPORT GC_MakePlane(const gp_Pnt& P, const gp_Dir& V);
//! Creates a plane from its cartesian equation :
//! Ax + By + Cz + D = 0.0
//! Status is "BadEquation" if Sqrt (A*A + B*B + C*C)
//! <= Resolution from gp
Standard_EXPORT GC_MakePlane(const Standard_Real A, const Standard_Real B, const Standard_Real C, const Standard_Real D);
//! Make a Plane from Geom parallel to another
//! Pln and passing through a Pnt .
Standard_EXPORT GC_MakePlane(const gp_Pln& Pln, const gp_Pnt& Point);
//! Make a Plane from Geom parallel to another
//! Pln at the distance which can be greater
//! or lower than zero.
//! In the first case the result is at the distance
//! to the plane in the direction of the
//! normal to .
//! Otherwize it is in the oposite direction.
Standard_EXPORT GC_MakePlane(const gp_Pln& Pln, const Standard_Real Dist);
//! Make a Plane from Geom passing through 3
//! Pnt ,,.
//! It returns false if are confused.
Standard_EXPORT GC_MakePlane(const gp_Pnt& P1, const gp_Pnt& P2, const gp_Pnt& P3);
//! Make a Plane passing through the location of and
//! normal to the Direction of .
Standard_EXPORT GC_MakePlane(const gp_Ax1& Axis);
//! Returns the constructed plane.
//! Exceptions StdFail_NotDone if no plane is constructed.
Standard_EXPORT const Handle(Geom_Plane)& Value() const;
operator const Handle(Geom_Plane)& () const { return Value(); }
private:
Handle(Geom_Plane) ThePlane;
};
#endif // _GC_MakePlane_HeaderFile