FoundationClasses
TKMath
gp

---

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
.

#include <gp_Lin2d.hxx>

Public Member Functions
void *	operator new (size_t, void *anAddress)
void *	operator new (size_t size)
void	operator delete (void *anAddress)
	gp_Lin2d ()
	Creates an indefinite Line. .
	gp_Lin2d (const gp_Ax2d &A)
	Creates a line located with A. .
	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.
Standard_EXPORT	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. .
void	Reverse ()
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	SetDirection (const gp_Dir2d &V)
	Changes the direction of the line. .
void	SetLocation (const gp_Pnt2d &P)
	Changes the origin of the line. .
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. .
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. .
const gp_Dir2d &	Direction () const
	Returns the direction of the line. .
const gp_Pnt2d &	Location () const
	Returns the location point (origin) of the line. .
const gp_Ax2d &	Position () const
	Returns the axis placement one axis whith the same location and direction as <me>. .
Standard_Real	Angle (const gp_Lin2d &Other) const
	Computes the angle between two lines in radians. .
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. .
Standard_Real	Distance (const gp_Pnt2d &P) const
	Computes the distance between <me> and the point . .
Standard_Real	Distance (const gp_Lin2d &Other) const
	Computes the distance between two lines. .
Standard_Real	SquareDistance (const gp_Pnt2d &P) const
	Computes the square distance between <me> and the point . .
Standard_Real	SquareDistance (const gp_Lin2d &Other) const
	Computes the square distance between two lines. .
gp_Lin2d	Normal (const gp_Pnt2d &P) const
	Computes the line normal to the direction of <me>, passing through the point . .
Standard_EXPORT void	Mirror (const gp_Pnt2d &P)
Standard_EXPORT 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 .
Standard_EXPORT void	Mirror (const gp_Ax2d &A)
Standard_EXPORT 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. .
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. .
Standard_EXPORT 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. .
void	Transform (const gp_Trsf2d &T)
gp_Lin2d	Transformed (const gp_Trsf2d &T) const
	Transforms a line with the transformation T from class Trsf2d. .
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. .
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. .
const gp_Ax2d &	_CSFDB_Getgp_Lin2dpos () const
Private Attributes
gp_Ax2d	pos
Friends
Standard_EXPORT friend Handle_Standard_Type &	gp_Lin2d_Type_ ()

---

Constructor & Destructor Documentation

gp_Lin2d::gp_Lin2d (   )  [inline]

gp_Lin2d::gp_Lin2d (  const gp_Ax2d &  A  )  [inline]

gp_Lin2d::gp_Lin2d (  const gp_Pnt2d &  P, const gp_Dir2d &  V )  [inline]

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

---

Member Function Documentation

const gp_Ax2d& gp_Lin2d::_CSFDB_Getgp_Lin2dpos (   )  const [inline]

Standard_Real gp_Lin2d::Angle (  const gp_Lin2d &  Other  )  const [inline]

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

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

const gp_Dir2d & gp_Lin2d::Direction (   )  const [inline]

Standard_Real gp_Lin2d::Distance (  const gp_Lin2d &  Other  )  const [inline]

Standard_Real gp_Lin2d::Distance (  const gp_Pnt2d &  P  )  const [inline]

const gp_Pnt2d & gp_Lin2d::Location (   )  const [inline]

Standard_EXPORT void gp_Lin2d::Mirror (  const gp_Ax2d &  A  )

Standard_EXPORT void gp_Lin2d::Mirror (  const gp_Pnt2d &  P  )

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

Standard_EXPORT gp_Lin2d gp_Lin2d::Mirrored (  const gp_Pnt2d &  P  )  const

gp_Lin2d gp_Lin2d::Normal (  const gp_Pnt2d &  P  )  const [inline]

void gp_Lin2d::operator delete (  void *  anAddress  )  [inline]

void* gp_Lin2d::operator new (  size_t  size  )  [inline]

void* gp_Lin2d::operator new (  size_t  , void *  anAddress )  [inline]

const gp_Ax2d & gp_Lin2d::Position (   )  const [inline]

void gp_Lin2d::Reverse (   )  [inline]

gp_Lin2d gp_Lin2d::Reversed (   )  const [inline]

void gp_Lin2d::Rotate (  const gp_Pnt2d &  P, const Standard_Real  Ang )  [inline]

gp_Lin2d gp_Lin2d::Rotated (  const gp_Pnt2d &  P, const Standard_Real  Ang )  const [inline]

void gp_Lin2d::Scale (  const gp_Pnt2d &  P, const Standard_Real  S )  [inline]

gp_Lin2d gp_Lin2d::Scaled (  const gp_Pnt2d &  P, const Standard_Real  S )  const [inline]

void gp_Lin2d::SetDirection (  const gp_Dir2d &  V  )  [inline]

void gp_Lin2d::SetLocation (  const gp_Pnt2d &  P  )  [inline]

void gp_Lin2d::SetPosition (  const gp_Ax2d &  A  )  [inline]

Standard_Real gp_Lin2d::SquareDistance (  const gp_Lin2d &  Other  )  const [inline]

Standard_Real gp_Lin2d::SquareDistance (  const gp_Pnt2d &  P  )  const [inline]

void gp_Lin2d::Transform (  const gp_Trsf2d &  T  )  [inline]

gp_Lin2d gp_Lin2d::Transformed (  const gp_Trsf2d &  T  )  const [inline]

void gp_Lin2d::Translate (  const gp_Pnt2d &  P1, const gp_Pnt2d &  P2 )  [inline]

void gp_Lin2d::Translate (  const gp_Vec2d &  V  )  [inline]

gp_Lin2d gp_Lin2d::Translated (  const gp_Pnt2d &  P1, const gp_Pnt2d &  P2 )  const [inline]

gp_Lin2d gp_Lin2d::Translated (  const gp_Vec2d &  V  )  const [inline]

---

Friends And Related Function Documentation

Standard_EXPORT friend Handle_Standard_Type& gp_Lin2d_Type_ (   )  [friend]

---

Field Documentation

gp_Ax2d gp_Lin2d::pos [private]

---

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

• gp_Lin2d.hxx
• gp_Lin2d.lxx

---