# gp_Lin2d Class Reference

Describes a line in 2D space. A line is positioned in the plane with an axis (a gp_Ax2d object) which gives the line its origin and unit vector. A line and an axis are similar objects, thus, we can convert one into the other. A line provides direct access to the majority of the edit and query functions available on its positioning axis. In addition, however, a line has specific functions for computing distances and positions. See Also GccAna and Geom2dGcc packages which provide functions for constructing lines defined by geometric constraints gce_MakeLin2d which provides functions for more complex line constructions Geom2d_Line which provides additional functions for constructing lines and works, in particular, with the parametric equations of lines. More...

`#include <gp_Lin2d.hxx>`

## Public Member Functions

gp_Lin2d ()
Creates a Line corresponding to X axis of the reference coordinate system. More...

gp_Lin2d (const gp_Ax2d &A)
Creates a line located with A. More...

gp_Lin2d (const gp_Pnt2d &P, const gp_Dir2d &V)

gp_Lin2d (const Standard_Real A, const Standard_Real B, const Standard_Real C)
Creates the line from the equation A*X + B*Y + C = 0.0 Raises ConstructionError if Sqrt(A*A + B*B) <= Resolution from gp. Raised if Sqrt(A*A + B*B) <= Resolution from gp. More...

void Reverse ()

gp_Lin2d Reversed () const
Reverses the positioning axis of this line. Note: More...

void SetDirection (const gp_Dir2d &V)
Changes the direction of the line. More...

void SetLocation (const gp_Pnt2d &P)
Changes the origin of the line. More...

void SetPosition (const gp_Ax2d &A)
Complete redefinition of the line. The "Location" point of is the origin of the line. The "Direction" of is the direction of the line. More...

void Coefficients (Standard_Real &A, Standard_Real &B, Standard_Real &C) const
Returns the normalized coefficients of the line : A * X + B * Y + C = 0. More...

const gp_Dir2dDirection () const
Returns the direction of the line. More...

const gp_Pnt2dLocation () const
Returns the location point (origin) of the line. More...

const gp_Ax2dPosition () const
Returns the axis placement one axis whith the same location and direction as <me>. More...

Standard_Real Angle (const gp_Lin2d &Other) const
Computes the angle between two lines in radians. More...

Standard_Boolean Contains (const gp_Pnt2d &P, const Standard_Real LinearTolerance) const
Returns true if this line contains the point P, that is, if the distance between point P and this line is less than or equal to LinearTolerance. More...

Standard_Real Distance (const gp_Pnt2d &P) const
Computes the distance between <me> and the point. More...

Standard_Real Distance (const gp_Lin2d &Other) const
Computes the distance between two lines. More...

Standard_Real SquareDistance (const gp_Pnt2d &P) const
Computes the square distance between <me> and the point. More...

Standard_Real SquareDistance (const gp_Lin2d &Other) const
Computes the square distance between two lines. More...

gp_Lin2d Normal (const gp_Pnt2d &P) const
Computes the line normal to the direction of <me>, passing through the point. More...

void Mirror (const gp_Pnt2d &P)

gp_Lin2d Mirrored (const gp_Pnt2d &P) const
Performs the symmetrical transformation of a line with respect to the point. More...

void Mirror (const gp_Ax2d &A)

gp_Lin2d Mirrored (const gp_Ax2d &A) const
Performs the symmetrical transformation of a line with respect to an axis placement which is the axis of the symmetry. More...

void Rotate (const gp_Pnt2d &P, const Standard_Real Ang)

gp_Lin2d Rotated (const gp_Pnt2d &P, const Standard_Real Ang) const
Rotates a line. P is the center of the rotation. Ang is the angular value of the rotation in radians. More...

void Scale (const gp_Pnt2d &P, const Standard_Real S)

gp_Lin2d Scaled (const gp_Pnt2d &P, const Standard_Real S) const
Scales a line. S is the scaling value. Only the origin of the line is modified. More...

void Transform (const gp_Trsf2d &T)

gp_Lin2d Transformed (const gp_Trsf2d &T) const
Transforms a line with the transformation T from class Trsf2d. More...

void Translate (const gp_Vec2d &V)

gp_Lin2d Translated (const gp_Vec2d &V) const
Translates a line in the direction of the vector V. The magnitude of the translation is the vector's magnitude. More...

void Translate (const gp_Pnt2d &P1, const gp_Pnt2d &P2)

gp_Lin2d Translated (const gp_Pnt2d &P1, const gp_Pnt2d &P2) const
Translates a line from the point P1 to the point P2. More...

## Detailed Description

Describes a line in 2D space. A line is positioned in the plane with an axis (a gp_Ax2d object) which gives the line its origin and unit vector. A line and an axis are similar objects, thus, we can convert one into the other. A line provides direct access to the majority of the edit and query functions available on its positioning axis. In addition, however, a line has specific functions for computing distances and positions. See Also GccAna and Geom2dGcc packages which provide functions for constructing lines defined by geometric constraints gce_MakeLin2d which provides functions for more complex line constructions Geom2d_Line which provides additional functions for constructing lines and works, in particular, with the parametric equations of lines.

## Constructor & Destructor Documentation

 gp_Lin2d::gp_Lin2d ( )

Creates a Line corresponding to X axis of the reference coordinate system.

 gp_Lin2d::gp_Lin2d ( const gp_Ax2d & A )

Creates a line located with A.

 gp_Lin2d::gp_Lin2d ( const gp_Pnt2d & P, const gp_Dir2d & V )

is the location point (origin) of the line and <V> is the direction of the line.

 gp_Lin2d::gp_Lin2d ( const Standard_Real A, const Standard_Real B, const Standard_Real C )

Creates the line from the equation A*X + B*Y + C = 0.0 Raises ConstructionError if Sqrt(A*A + B*B) <= Resolution from gp. Raised if Sqrt(A*A + B*B) <= Resolution from gp.

## Member Function Documentation

 Standard_Real gp_Lin2d::Angle ( const gp_Lin2d & Other ) const

Computes the angle between two lines in radians.

 void gp_Lin2d::Coefficients ( Standard_Real & A, Standard_Real & B, Standard_Real & C ) const

Returns the normalized coefficients of the line : A * X + B * Y + C = 0.

 Standard_Boolean gp_Lin2d::Contains ( const gp_Pnt2d & P, const Standard_Real LinearTolerance ) const

Returns true if this line contains the point P, that is, if the distance between point P and this line is less than or equal to LinearTolerance.

 const gp_Dir2d& gp_Lin2d::Direction ( ) const

Returns the direction of the line.

 Standard_Real gp_Lin2d::Distance ( const gp_Pnt2d & P ) const

Computes the distance between <me> and the point.

.

 Standard_Real gp_Lin2d::Distance ( const gp_Lin2d & Other ) const

Computes the distance between two lines.

 const gp_Pnt2d& gp_Lin2d::Location ( ) const

Returns the location point (origin) of the line.

 void gp_Lin2d::Mirror ( const gp_Pnt2d & P )
 void gp_Lin2d::Mirror ( const gp_Ax2d & A )
 gp_Lin2d gp_Lin2d::Mirrored ( const gp_Pnt2d & P ) const

Performs the symmetrical transformation of a line with respect to the point.

which is the center of the symmetry

 gp_Lin2d gp_Lin2d::Mirrored ( const gp_Ax2d & A ) const

Performs the symmetrical transformation of a line with respect to an axis placement which is the axis of the symmetry.

 gp_Lin2d gp_Lin2d::Normal ( const gp_Pnt2d & P ) const

Computes the line normal to the direction of <me>, passing through the point.

.

 const gp_Ax2d& gp_Lin2d::Position ( ) const

Returns the axis placement one axis whith the same location and direction as <me>.

 void gp_Lin2d::Reverse ( )
 gp_Lin2d gp_Lin2d::Reversed ( ) const

Reverses the positioning axis of this line. Note:

• Reverse assigns the result to this line, while
• Reversed creates a new one.
 void gp_Lin2d::Rotate ( const gp_Pnt2d & P, const Standard_Real Ang )
 gp_Lin2d gp_Lin2d::Rotated ( const gp_Pnt2d & P, const Standard_Real Ang ) const

Rotates a line. P is the center of the rotation. Ang is the angular value of the rotation in radians.

 void gp_Lin2d::Scale ( const gp_Pnt2d & P, const Standard_Real S )
 gp_Lin2d gp_Lin2d::Scaled ( const gp_Pnt2d & P, const Standard_Real S ) const

Scales a line. S is the scaling value. Only the origin of the line is modified.

 void gp_Lin2d::SetDirection ( const gp_Dir2d & V )

Changes the direction of the line.

 void gp_Lin2d::SetLocation ( const gp_Pnt2d & P )

Changes the origin of the line.

 void gp_Lin2d::SetPosition ( const gp_Ax2d & A )

Complete redefinition of the line. The "Location" point of is the origin of the line. The "Direction" of is the direction of the line.

 Standard_Real gp_Lin2d::SquareDistance ( const gp_Pnt2d & P ) const

Computes the square distance between <me> and the point.

.

 Standard_Real gp_Lin2d::SquareDistance ( const gp_Lin2d & Other ) const

Computes the square distance between two lines.

 void gp_Lin2d::Transform ( const gp_Trsf2d & T )
 gp_Lin2d gp_Lin2d::Transformed ( const gp_Trsf2d & T ) const

Transforms a line with the transformation T from class Trsf2d.

 void gp_Lin2d::Translate ( const gp_Vec2d & V )
 void gp_Lin2d::Translate ( const gp_Pnt2d & P1, const gp_Pnt2d & P2 )
 gp_Lin2d gp_Lin2d::Translated ( const gp_Vec2d & V ) const

Translates a line in the direction of the vector V. The magnitude of the translation is the vector's magnitude.

 gp_Lin2d gp_Lin2d::Translated ( const gp_Pnt2d & P1, const gp_Pnt2d & P2 ) const

Translates a line from the point P1 to the point P2.

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