Describes an infinite line in the plane (2D space). A line is defined and positioned in the plane with an axis (gp_Ax2d object) which gives it an origin and a unit vector. The Geom2d_Line line is parameterized as follows: P (U) = O + U*Dir where: More...

#include <Geom2d_Line.hxx>

Inheritance diagram for Geom2d_Line:

[legend]

Public Member Functions
	Geom2d_Line (const gp_Ax2d &A)
	Creates a line located in 2D space with the axis placement A. The Location of A is the origin of the line.

	Geom2d_Line (const gp_Lin2d &L)
	Creates a line by conversion of the gp_Lin2d line L.

	Geom2d_Line (const gp_Pnt2d &P, const gp_Dir2d &V)
	Constructs a line passing through point P and parallel to vector V (P and V are, respectively, the origin and the unit vector of the positioning axis of the line).

void	SetLin2d (const gp_Lin2d &L)
	Set <me> so that <me> has the same geometric properties as L.

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

const gp_Dir2d &	Direction () const
	changes the direction of the line.

void	SetLocation (const gp_Pnt2d &P)
	Changes the "Location" point (origin) of the line.

const gp_Pnt2d &	Location () const
	Changes the "Location" point (origin) of the line.

void	SetPosition (const gp_Ax2d &A)
	Changes the "Location" and a the "Direction" of <me>.

const gp_Ax2d &	Position () const

gp_Lin2d	Lin2d () const
	Returns non persistent line from gp with the same geometric properties as <me>

void	Reverse () override
	Changes the orientation of this line. As a result, the unit vector of the positioning axis of this line is reversed.

Standard_Real	ReversedParameter (const Standard_Real U) const override
	Computes the parameter on the reversed line for the point of parameter U on this line. For a line, the returned value is -U.

Standard_Real	FirstParameter () const override
	Returns RealFirst from Standard.

Standard_Real	LastParameter () const override
	Returns RealLast from Standard.

Standard_Boolean	IsClosed () const override
	Returns False.

Standard_Boolean	IsPeriodic () const override
	Returns False.

GeomAbs_Shape	Continuity () const override
	Returns GeomAbs_CN, which is the global continuity of any line.

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

Standard_Boolean	IsCN (const Standard_Integer N) const override
	Returns True.

void	D0 (const Standard_Real U, gp_Pnt2d &P) const override
	Returns in P the point of parameter U. P (U) = O + U * Dir where O is the "Location" point of the line and Dir the direction of the line.

void	D1 (const Standard_Real U, gp_Pnt2d &P, gp_Vec2d &V1) const override
	Returns the point P of parameter u and the first derivative V1.

void	D2 (const Standard_Real U, gp_Pnt2d &P, gp_Vec2d &V1, gp_Vec2d &V2) const override
	Returns the point P of parameter U, the first and second derivatives V1 and V2. V2 is a vector with null magnitude for a line.

void	D3 (const Standard_Real U, gp_Pnt2d &P, gp_Vec2d &V1, gp_Vec2d &V2, gp_Vec2d &V3) const override
	V2 and V3 are vectors with null magnitude for a line.

gp_Vec2d	DN (const Standard_Real U, const Standard_Integer N) const override
	For the point of parameter U of this line, computes the vector corresponding to the Nth derivative. Note: if N is greater than or equal to 2, the result is a vector with null magnitude. Exceptions Standard_RangeError if N is less than 1.

void	Transform (const gp_Trsf2d &T) override
	Applies the transformation T to this line.

virtual Standard_Real	TransformedParameter (const Standard_Real U, const gp_Trsf2d &T) const override
	Computes the parameter on the line transformed by T for the point of parameter U on this line. For a line, the returned value is equal to U multiplied by the scale factor of transformation T.

virtual Standard_Real	ParametricTransformation (const gp_Trsf2d &T) const override
	Returns the coefficient required to compute the parametric transformation of this line when transformation T is applied. This coefficient is the ratio between the parameter of a point on this line and the parameter of the transformed point on the new line transformed by T. For a line, the returned value is the scale factor of the transformation T.

Handle< Geom2d_Geometry >	Copy () const override
	Creates a new object, which is a copy of this line.

virtual void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
	Dumps the content of me into the stream.

Public Member Functions inherited from Geom2d_Curve
Handle< Geom2d_Curve >	Reversed () const
	Creates a reversed duplicate Changes the orientation of this curve. The first and last parameters are not changed, but the parametric direction of the curve is reversed. If the curve is bounded:

virtual Standard_Real	Period () const
	Returns the period of this curve. raises if the curve is not periodic.

gp_Pnt2d	Value (const Standard_Real U) const
	Computes the point of parameter U on <me>. If the curve is periodic then the returned point is P(U) with U = Ustart + (U - Uend) where Ustart and Uend are the parametric bounds of the curve.

Public Member Functions inherited from Geom2d_Geometry
void	Mirror (const gp_Pnt2d &P)
	Performs the symmetrical transformation of a Geometry with respect to the point P which is the center of the symmetry and assigns the result to this geometric object.

void	Mirror (const gp_Ax2d &A)
	Performs the symmetrical transformation of a Geometry with respect to an axis placement which is the axis of the symmetry.

void	Rotate (const gp_Pnt2d &P, const Standard_Real Ang)
	Rotates a Geometry. P is the center of the rotation. Ang is the angular value of the rotation in radians.

void	Scale (const gp_Pnt2d &P, const Standard_Real S)
	Scales a Geometry. S is the scaling value.

void	Translate (const gp_Vec2d &V)
	Translates a Geometry. V is the vector of the translation.

void	Translate (const gp_Pnt2d &P1, const gp_Pnt2d &P2)
	Translates a Geometry from the point P1 to the point P2.

Handle< Geom2d_Geometry >	Mirrored (const gp_Pnt2d &P) const

Handle< Geom2d_Geometry >	Mirrored (const gp_Ax2d &A) const

Handle< Geom2d_Geometry >	Rotated (const gp_Pnt2d &P, const Standard_Real Ang) const

Handle< Geom2d_Geometry >	Scaled (const gp_Pnt2d &P, const Standard_Real S) const

Handle< Geom2d_Geometry >	Transformed (const gp_Trsf2d &T) const

Handle< Geom2d_Geometry >	Translated (const gp_Vec2d &V) const

Handle< Geom2d_Geometry >	Translated (const gp_Pnt2d &P1, const gp_Pnt2d &P2) const

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Detailed Description

Describes an infinite line in the plane (2D space). A line is defined and positioned in the plane with an axis (gp_Ax2d object) which gives it an origin and a unit vector. The Geom2d_Line line is parameterized as follows: P (U) = O + U*Dir where:

P is the point of parameter U,
O is the origin and Dir the unit vector of its positioning axis. The parameter range is ] -infinite, +infinite [. The orientation of the line is given by the unit vector of its positioning axis. See Also GCE2d_MakeLine which provides functions for more complex line constructions gp_Ax2d gp_Lin2d for an equivalent, non-parameterized data structure.

Constructor & Destructor Documentation

◆ Geom2d_Line() [1/3]

Geom2d_Line::Geom2d_Line ( const gp_Ax2d & A )

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

◆ Geom2d_Line() [2/3]

Geom2d_Line::Geom2d_Line ( const gp_Lin2d & L )

Creates a line by conversion of the gp_Lin2d line L.

◆ Geom2d_Line() [3/3]

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

Constructs a line passing through point P and parallel to vector V (P and V are, respectively, the origin and the unit vector of the positioning axis of the line).

Member Function Documentation

◆ Continuity()

GeomAbs_Shape Geom2d_Line::Continuity ( ) const

overridevirtual

Returns GeomAbs_CN, which is the global continuity of any line.

Implements Geom2d_Curve.

◆ Copy()

Handle< Geom2d_Geometry > Geom2d_Line::Copy ( ) const

overridevirtual

Creates a new object, which is a copy of this line.

Implements Geom2d_Geometry.

◆ D0()

void Geom2d_Line::D0	(	const Standard_Real	U,
		gp_Pnt2d &	P
	)		const

overridevirtual

Returns in P the point of parameter U. P (U) = O + U * Dir where O is the "Location" point of the line and Dir the direction of the line.

Implements Geom2d_Curve.

◆ D1()

void Geom2d_Line::D1	(	const Standard_Real	U,
		gp_Pnt2d &	P,
		gp_Vec2d &	V1
	)		const

overridevirtual

Returns the point P of parameter u and the first derivative V1.

Implements Geom2d_Curve.

◆ D2()

void Geom2d_Line::D2	(	const Standard_Real	U,
		gp_Pnt2d &	P,
		gp_Vec2d &	V1,
		gp_Vec2d &	V2
	)		const

overridevirtual

Returns the point P of parameter U, the first and second derivatives V1 and V2. V2 is a vector with null magnitude for a line.

Implements Geom2d_Curve.

◆ D3()

void Geom2d_Line::D3	(	const Standard_Real	U,
		gp_Pnt2d &	P,
		gp_Vec2d &	V1,
		gp_Vec2d &	V2,
		gp_Vec2d &	V3
	)		const

overridevirtual

V2 and V3 are vectors with null magnitude for a line.

Implements Geom2d_Curve.

◆ Direction()

const gp_Dir2d & Geom2d_Line::Direction ( ) const

changes the direction of the line.

◆ Distance()

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

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

◆ DN()

gp_Vec2d Geom2d_Line::DN	(	const Standard_Real	U,
		const Standard_Integer	N
	)		const

overridevirtual

For the point of parameter U of this line, computes the vector corresponding to the Nth derivative. Note: if N is greater than or equal to 2, the result is a vector with null magnitude. Exceptions Standard_RangeError if N is less than 1.

Implements Geom2d_Curve.

◆ DumpJson()

virtual void Geom2d_Line::DumpJson	(	Standard_OStream &	theOStream,
		Standard_Integer	theDepth = `-1`
	)		const

overridevirtual

Dumps the content of me into the stream.

Reimplemented from Geom2d_Curve.

◆ FirstParameter()

Standard_Real Geom2d_Line::FirstParameter ( ) const

overridevirtual

Returns RealFirst from Standard.

Implements Geom2d_Curve.

◆ IsClosed()

Standard_Boolean Geom2d_Line::IsClosed ( ) const

overridevirtual

Returns False.

Implements Geom2d_Curve.

◆ IsCN()

Standard_Boolean Geom2d_Line::IsCN ( const Standard_Integer N ) const

overridevirtual

Returns True.

Implements Geom2d_Curve.

◆ IsPeriodic()

Standard_Boolean Geom2d_Line::IsPeriodic ( ) const

overridevirtual

Returns False.

Implements Geom2d_Curve.

◆ LastParameter()

Standard_Real Geom2d_Line::LastParameter ( ) const

overridevirtual

Returns RealLast from Standard.

Implements Geom2d_Curve.

◆ Lin2d()

gp_Lin2d Geom2d_Line::Lin2d ( ) const

Returns non persistent line from gp with the same geometric properties as <me>

◆ Location()

const gp_Pnt2d & Geom2d_Line::Location ( ) const

Changes the "Location" point (origin) of the line.

◆ ParametricTransformation()

virtual Standard_Real Geom2d_Line::ParametricTransformation ( const gp_Trsf2d & T ) const

overridevirtual

Returns the coefficient required to compute the parametric transformation of this line when transformation T is applied. This coefficient is the ratio between the parameter of a point on this line and the parameter of the transformed point on the new line transformed by T. For a line, the returned value is the scale factor of the transformation T.

Reimplemented from Geom2d_Curve.

◆ Position()

const gp_Ax2d & Geom2d_Line::Position ( ) const

◆ Reverse()

void Geom2d_Line::Reverse ( )

overridevirtual

Changes the orientation of this line. As a result, the unit vector of the positioning axis of this line is reversed.

Implements Geom2d_Curve.

◆ ReversedParameter()

Standard_Real Geom2d_Line::ReversedParameter ( const Standard_Real U ) const

overridevirtual

Computes the parameter on the reversed line for the point of parameter U on this line. For a line, the returned value is -U.

Implements Geom2d_Curve.

◆ SetDirection()

void Geom2d_Line::SetDirection ( const gp_Dir2d & V )

changes the direction of the line.

◆ SetLin2d()

void Geom2d_Line::SetLin2d ( const gp_Lin2d & L )

Set <me> so that <me> has the same geometric properties as L.

◆ SetLocation()

void Geom2d_Line::SetLocation ( const gp_Pnt2d & P )

Changes the "Location" point (origin) of the line.

◆ SetPosition()

void Geom2d_Line::SetPosition ( const gp_Ax2d & A )

Changes the "Location" and a the "Direction" of <me>.

◆ Transform()

void Geom2d_Line::Transform ( const gp_Trsf2d & T )

overridevirtual

Applies the transformation T to this line.

Implements Geom2d_Geometry.

◆ TransformedParameter()

virtual Standard_Real Geom2d_Line::TransformedParameter	(	const Standard_Real	U,
		const gp_Trsf2d &	T
	)		const

overridevirtual

Computes the parameter on the line transformed by T for the point of parameter U on this line. For a line, the returned value is equal to U multiplied by the scale factor of transformation T.

Reimplemented from Geom2d_Curve.

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

Geom2d_Line.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Geom2d_Line() [1/3]

◆ Geom2d_Line() [2/3]

◆ Geom2d_Line() [3/3]

Member Function Documentation

◆ Continuity()

◆ Copy()

◆ D0()

◆ D1()

◆ D2()

◆ D3()

◆ Direction()

◆ Distance()

◆ DN()

◆ DumpJson()

◆ FirstParameter()

◆ IsClosed()

◆ IsCN()

◆ IsPeriodic()

◆ LastParameter()

◆ Lin2d()

◆ Location()

◆ ParametricTransformation()

◆ Position()

◆ Reverse()

◆ ReversedParameter()

◆ SetDirection()

◆ SetLin2d()

◆ SetLocation()

◆ SetPosition()

◆ Transform()

◆ TransformedParameter()