Open CASCADE Technology 7.8.2.dev
GC_MakeLine Class Reference

This class implements the following algorithms used to create a Line from Geom. More...

#include <GC_MakeLine.hxx>

Inheritance diagram for GC_MakeLine:

Public Member Functions

 GC_MakeLine (const gp_Ax1 &A1)
 Creates a line located in 3D space with the axis placement A1. The Location of A1 is the origin of the line.
 
 GC_MakeLine (const gp_Lin &L)
 Creates a line from a non persistent line from package gp.
 
 GC_MakeLine (const gp_Pnt &P, const gp_Dir &V)
 P is the origin and V is the direction of the line.
 
 GC_MakeLine (const gp_Lin &Lin, const gp_Pnt &Point)
 Make a Line from Geom <TheLin> parallel to another Lin <Lin> and passing through a Pnt <Point>.
 
 GC_MakeLine (const gp_Pnt &P1, const gp_Pnt &P2)
 Make a Line from Geom <TheLin> passing through 2 Pnt <P1>,<P2>. It returns false if <p1> and <P2> are confused. Warning If the points P1 and P2 are coincident (that is, when IsDone returns false), the Status function returns gce_ConfusedPoints.
 
const Handle< Geom_Line > & Value () const
 Returns the constructed line. Exceptions StdFail_NotDone if no line is constructed.
 
 operator const Handle< Geom_Line > & () const
 
- Public Member Functions inherited from GC_Root
Standard_Boolean IsDone () const
 Returns true if the construction is successful.
 
gce_ErrorType Status () const
 Returns the status of the construction:
 

Additional Inherited Members

- Protected Attributes inherited from GC_Root
gce_ErrorType TheError
 

Detailed Description

This class implements the following algorithms used to create a Line from Geom.

  • Create a Line parallel to another and passing through a point.
  • Create a Line passing through 2 points. A MakeLine object provides a framework for:
  • defining the construction of the line,
  • implementing the construction algorithm, and
  • consulting the results. In particular, the Value function returns the constructed line.

Constructor & Destructor Documentation

◆ GC_MakeLine() [1/5]

GC_MakeLine::GC_MakeLine ( const gp_Ax1 & A1)

Creates a line located in 3D space with the axis placement A1. The Location of A1 is the origin of the line.

◆ GC_MakeLine() [2/5]

GC_MakeLine::GC_MakeLine ( const gp_Lin & L)

Creates a line from a non persistent line from package gp.

◆ GC_MakeLine() [3/5]

GC_MakeLine::GC_MakeLine ( const gp_Pnt & P,
const gp_Dir & V )

P is the origin and V is the direction of the line.

◆ GC_MakeLine() [4/5]

GC_MakeLine::GC_MakeLine ( const gp_Lin & Lin,
const gp_Pnt & Point )

Make a Line from Geom <TheLin> parallel to another Lin <Lin> and passing through a Pnt <Point>.

◆ GC_MakeLine() [5/5]

GC_MakeLine::GC_MakeLine ( const gp_Pnt & P1,
const gp_Pnt & P2 )

Make a Line from Geom <TheLin> passing through 2 Pnt <P1>,<P2>. It returns false if <p1> and <P2> are confused. Warning If the points P1 and P2 are coincident (that is, when IsDone returns false), the Status function returns gce_ConfusedPoints.

Member Function Documentation

◆ operator const Handle< Geom_Line > &()

GC_MakeLine::operator const Handle< Geom_Line > & ( ) const
inline

◆ Value()

const Handle< Geom_Line > & GC_MakeLine::Value ( ) const

Returns the constructed line. Exceptions StdFail_NotDone if no line is constructed.


The documentation for this class was generated from the following file: