Open CASCADE Technology  7.7.0.dev
Public Member Functions

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 &theA)
 Creates a line located with theA. More...
 
 gp_Lin2d (const gp_Pnt2d &theP, const gp_Dir2d &theV)
 <theP> is the location point (origin) of the line and <theV> is the direction of the line. More...
 
 gp_Lin2d (const Standard_Real theA, const Standard_Real theB, const Standard_Real theC)
 Creates the line from the equation theA*X + theB*Y + theC = 0.0 Raises ConstructionError if Sqrt(theA*theA + theB*theB) <= Resolution from gp. Raised if Sqrt(theA*theA + theB*theB) <= Resolution from gp. More...
 
void Reverse ()
 
gp_Lin2d Reversed () const
 Reverses the positioning axis of this line. Note: More...
 
void SetDirection (const gp_Dir2d &theV)
 Changes the direction of the line. More...
 
void SetLocation (const gp_Pnt2d &theP)
 Changes the origin of the line. More...
 
void SetPosition (const gp_Ax2d &theA)
 Complete redefinition of the line. The "Location" point of <theA> is the origin of the line. The "Direction" of <theA> is the direction of the line. More...
 
void Coefficients (Standard_Real &theA, Standard_Real &theB, Standard_Real &theC) const
 Returns the normalized coefficients of the line : theA * X + theB * Y + theC = 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 with the same location and direction as <me>. More...
 
Standard_Real Angle (const gp_Lin2d &theOther) const
 Computes the angle between two lines in radians. More...
 
Standard_Boolean Contains (const gp_Pnt2d &theP, const Standard_Real theLinearTolerance) const
 Returns true if this line contains the point theP, that is, if the distance between point theP and this line is less than or equal to theLinearTolerance. More...
 
Standard_Real Distance (const gp_Pnt2d &theP) const
 Computes the distance between <me> and the point <theP>. More...
 
Standard_Real Distance (const gp_Lin2d &theOther) const
 Computes the distance between two lines. More...
 
Standard_Real SquareDistance (const gp_Pnt2d &theP) const
 Computes the square distance between <me> and the point <theP>. More...
 
Standard_Real SquareDistance (const gp_Lin2d &theOther) const
 Computes the square distance between two lines. More...
 
gp_Lin2d Normal (const gp_Pnt2d &theP) const
 Computes the line normal to the direction of <me>, passing through the point <theP>. More...
 
void Mirror (const gp_Pnt2d &theP)
 
gp_Lin2d Mirrored (const gp_Pnt2d &theP) const
 Performs the symmetrical transformation of a line with respect to the point <theP> which is the center of the symmetry. More...
 
void Mirror (const gp_Ax2d &theA)
 
gp_Lin2d Mirrored (const gp_Ax2d &theA) 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 &theP, const Standard_Real theAng)
 
gp_Lin2d Rotated (const gp_Pnt2d &theP, const Standard_Real theAng) const
 Rotates a line. theP is the center of the rotation. theAng is the angular value of the rotation in radians. More...
 
void Scale (const gp_Pnt2d &theP, const Standard_Real theS)
 
gp_Lin2d Scaled (const gp_Pnt2d &theP, const Standard_Real theS) const
 Scales a line. theS is the scaling value. Only the origin of the line is modified. More...
 
void Transform (const gp_Trsf2d &theT)
 
gp_Lin2d Transformed (const gp_Trsf2d &theT) const
 Transforms a line with the transformation theT from class Trsf2d. More...
 
void Translate (const gp_Vec2d &theV)
 
gp_Lin2d Translated (const gp_Vec2d &theV) const
 Translates a line in the direction of the vector theV. The magnitude of the translation is the vector's magnitude. More...
 
void Translate (const gp_Pnt2d &theP1, const gp_Pnt2d &theP2)
 
gp_Lin2d Translated (const gp_Pnt2d &theP1, const gp_Pnt2d &theP2) const
 Translates a line from the point theP1 to the point theP2. 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() [1/4]

gp_Lin2d::gp_Lin2d ( )
inline

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

◆ gp_Lin2d() [2/4]

gp_Lin2d::gp_Lin2d ( const gp_Ax2d theA)
inline

Creates a line located with theA.

◆ gp_Lin2d() [3/4]

gp_Lin2d::gp_Lin2d ( const gp_Pnt2d theP,
const gp_Dir2d theV 
)
inline

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

◆ gp_Lin2d() [4/4]

gp_Lin2d::gp_Lin2d ( const Standard_Real  theA,
const Standard_Real  theB,
const Standard_Real  theC 
)

Creates the line from the equation theA*X + theB*Y + theC = 0.0 Raises ConstructionError if Sqrt(theA*theA + theB*theB) <= Resolution from gp. Raised if Sqrt(theA*theA + theB*theB) <= Resolution from gp.

Member Function Documentation

◆ Angle()

Standard_Real gp_Lin2d::Angle ( const gp_Lin2d theOther) const
inline

Computes the angle between two lines in radians.

◆ Coefficients()

void gp_Lin2d::Coefficients ( Standard_Real theA,
Standard_Real theB,
Standard_Real theC 
) const
inline

Returns the normalized coefficients of the line : theA * X + theB * Y + theC = 0.

◆ Contains()

Standard_Boolean gp_Lin2d::Contains ( const gp_Pnt2d theP,
const Standard_Real  theLinearTolerance 
) const
inline

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

◆ Direction()

const gp_Dir2d& gp_Lin2d::Direction ( ) const
inline

Returns the direction of the line.

◆ Distance() [1/2]

Standard_Real gp_Lin2d::Distance ( const gp_Lin2d theOther) const
inline

Computes the distance between two lines.

◆ Distance() [2/2]

Standard_Real gp_Lin2d::Distance ( const gp_Pnt2d theP) const
inline

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

◆ Location()

const gp_Pnt2d& gp_Lin2d::Location ( ) const
inline

Returns the location point (origin) of the line.

◆ Mirror() [1/2]

void gp_Lin2d::Mirror ( const gp_Ax2d theA)

◆ Mirror() [2/2]

void gp_Lin2d::Mirror ( const gp_Pnt2d theP)

◆ Mirrored() [1/2]

gp_Lin2d gp_Lin2d::Mirrored ( const gp_Ax2d theA) const

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

◆ Mirrored() [2/2]

gp_Lin2d gp_Lin2d::Mirrored ( const gp_Pnt2d theP) const

Performs the symmetrical transformation of a line with respect to the point <theP> which is the center of the symmetry.

◆ Normal()

gp_Lin2d gp_Lin2d::Normal ( const gp_Pnt2d theP) const
inline

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

◆ Position()

const gp_Ax2d& gp_Lin2d::Position ( ) const
inline

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

◆ Reverse()

void gp_Lin2d::Reverse ( )
inline

◆ Reversed()

gp_Lin2d gp_Lin2d::Reversed ( ) const
inline

Reverses the positioning axis of this line. Note:

  • Reverse assigns the result to this line, while
  • Reversed creates a new one.

◆ Rotate()

void gp_Lin2d::Rotate ( const gp_Pnt2d theP,
const Standard_Real  theAng 
)
inline

◆ Rotated()

gp_Lin2d gp_Lin2d::Rotated ( const gp_Pnt2d theP,
const Standard_Real  theAng 
) const
inline

Rotates a line. theP is the center of the rotation. theAng is the angular value of the rotation in radians.

◆ Scale()

void gp_Lin2d::Scale ( const gp_Pnt2d theP,
const Standard_Real  theS 
)
inline

◆ Scaled()

gp_Lin2d gp_Lin2d::Scaled ( const gp_Pnt2d theP,
const Standard_Real  theS 
) const
inline

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

◆ SetDirection()

void gp_Lin2d::SetDirection ( const gp_Dir2d theV)
inline

Changes the direction of the line.

◆ SetLocation()

void gp_Lin2d::SetLocation ( const gp_Pnt2d theP)
inline

Changes the origin of the line.

◆ SetPosition()

void gp_Lin2d::SetPosition ( const gp_Ax2d theA)
inline

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

◆ SquareDistance() [1/2]

Standard_Real gp_Lin2d::SquareDistance ( const gp_Lin2d theOther) const
inline

Computes the square distance between two lines.

◆ SquareDistance() [2/2]

Standard_Real gp_Lin2d::SquareDistance ( const gp_Pnt2d theP) const
inline

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

◆ Transform()

void gp_Lin2d::Transform ( const gp_Trsf2d theT)
inline

◆ Transformed()

gp_Lin2d gp_Lin2d::Transformed ( const gp_Trsf2d theT) const
inline

Transforms a line with the transformation theT from class Trsf2d.

◆ Translate() [1/2]

void gp_Lin2d::Translate ( const gp_Pnt2d theP1,
const gp_Pnt2d theP2 
)
inline

◆ Translate() [2/2]

void gp_Lin2d::Translate ( const gp_Vec2d theV)
inline

◆ Translated() [1/2]

gp_Lin2d gp_Lin2d::Translated ( const gp_Pnt2d theP1,
const gp_Pnt2d theP2 
) const
inline

Translates a line from the point theP1 to the point theP2.

◆ Translated() [2/2]

gp_Lin2d gp_Lin2d::Translated ( const gp_Vec2d theV) const
inline

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


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