Describes an infinite line. A line is defined and positioned in space with an axis (gp_Ax1 object) which gives it an origin and a unit vector. The Geom_Line line is parameterized: P (U) = O + U*Dir, where: More...

#include <Geom_Line.hxx>

Inheritance diagram for Geom_Line:

[legend]

Public Member Functions
	Geom_Line (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.

	Geom_Line (const gp_Lin &L)
	Creates a line from a non transient line from package gp.

	Geom_Line (const gp_Pnt &P, const gp_Dir &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	SetLin (const gp_Lin &L)
	Set <me> so that <me> has the same geometric properties as L.

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

void	SetLocation (const gp_Pnt &P)
	changes the "Location" point (origin) of the line.

void	SetPosition (const gp_Ax1 &A1)
	changes the "Location" and a the "Direction" of <me>.

gp_Lin	Lin () const
	Returns non transient line from gp with the same geometric properties as <me>

const gp_Ax1 &	Position () const
	Returns the positioning axis of this line; this is also its local coordinate system.

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

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

double	FirstParameter () const final
	Returns the value of the first parameter of this line. This is double::RealFirst().

double	LastParameter () const final
	Returns the value of the last parameter of this line. This is double::RealLast().

bool	IsClosed () const final
	returns False

bool	IsPeriodic () const final
	returns False

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

bool	IsCN (const int N) const final
	returns True. Raised if N < 0.

gp_Pnt	EvalD0 (const double U) const final
	Returns 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.

Geom_Curve::ResD1	EvalD1 (const double U) const final
	Returns the point of parameter U and the first derivative.

Geom_Curve::ResD2	EvalD2 (const double U) const final
	Returns the point of parameter U, the first and second derivatives. The second derivative is a vector with null magnitude for a line.

Geom_Curve::ResD3	EvalD3 (const double U) const final
	Returns the point of parameter U, the first, second and third derivatives. The second and third derivatives are vectors with null magnitude for a line.

gp_Vec	EvalDN (const double U, const int N) const final
	Returns the vector corresponding to the derivative for the order of derivation N. Raised if N < 1.

void	Transform (const gp_Trsf &T) final
	Applies the transformation T to this line.

double	TransformedParameter (const double U, const gp_Trsf &T) const final
	Returns the parameter on the transformed curve for the transform of the point of parameter U on <me>.

double	ParametricTransformation (const gp_Trsf &T) const final
	Returns a coefficient to compute the parameter on the transformed curve for the transform of the point on <me>.

occ::handle< Geom_Geometry >	Copy () const final
	Creates a new object which is a copy of this line.

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

Public Member Functions inherited from Geom_Curve
occ::handle< Geom_Curve >	Reversed () const
	Returns a copy of <me> reversed.

virtual double	Period () const
	Returns the period of this curve. Exceptions Standard_NoSuchObject if this curve is not periodic.

void	D0 (const double U, gp_Pnt &P) const
	Returns in P the point of parameter U.

void	D1 (const double U, gp_Pnt &P, gp_Vec &V1) const
	Returns the point P of parameter U and the first derivative V1.

void	D2 (const double U, gp_Pnt &P, gp_Vec &V1, gp_Vec &V2) const
	Returns the point P of parameter U, the first and second derivatives V1 and V2.

void	D3 (const double U, gp_Pnt &P, gp_Vec &V1, gp_Vec &V2, gp_Vec &V3) const
	Returns the point P of parameter U, the first, the second and the third derivative.

gp_Vec	DN (const double U, const int N) const
	The returned vector gives the value of the derivative for the order of derivation N.

gp_Pnt	Value (const double U) const
	Computes the point of parameter U on <me>.

Public Member Functions inherited from Geom_Geometry
void	Mirror (const gp_Pnt &P)
	Performs the symmetrical transformation of a Geometry with respect to the point P which is the center of the symmetry.

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

void	Mirror (const gp_Ax2 &A2)
	Performs the symmetrical transformation of a Geometry with respect to a plane. The axis placement A2 locates the plane of the symmetry : (Location, XDirection, YDirection).

void	Rotate (const gp_Ax1 &A1, const double Ang)
	Rotates a Geometry. A1 is the axis of the rotation. Ang is the angular value of the rotation in radians.

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

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

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

occ::handle< Geom_Geometry >	Mirrored (const gp_Pnt &P) const

occ::handle< Geom_Geometry >	Mirrored (const gp_Ax1 &A1) const

occ::handle< Geom_Geometry >	Mirrored (const gp_Ax2 &A2) const

occ::handle< Geom_Geometry >	Rotated (const gp_Ax1 &A1, const double Ang) const

occ::handle< Geom_Geometry >	Scaled (const gp_Pnt &P, const double S) const

occ::handle< Geom_Geometry >	Transformed (const gp_Trsf &T) const

occ::handle< Geom_Geometry >	Translated (const gp_Vec &V) const

occ::handle< Geom_Geometry >	Translated (const gp_Pnt &P1, const gp_Pnt &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 ()=default
	Destructor must be virtual.

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

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

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

bool	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.

bool	IsKind (const char *const 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.

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

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

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. A line is defined and positioned in space with an axis (gp_Ax1 object) which gives it an origin and a unit vector. The Geom_Line line is parameterized: 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.

Constructor & Destructor Documentation

◆ Geom_Line() [1/3]

Geom_Line::Geom_Line ( 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.

◆ Geom_Line() [2/3]

Geom_Line::Geom_Line ( const gp_Lin & L )

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

◆ Geom_Line() [3/3]

Geom_Line::Geom_Line	(	const gp_Pnt &	P,
		const gp_Dir &	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 Geom_Line::Continuity ( ) const

finalvirtual

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

Implements Geom_Curve.

◆ Copy()

occ::handle< Geom_Geometry > Geom_Line::Copy ( ) const

finalvirtual

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

Implements Geom_Geometry.

◆ DumpJson()

void Geom_Line::DumpJson	(	Standard_OStream &	theOStream,
		int	theDepth = -1 ) const

finalvirtual

Dumps the content of me into the stream.

Reimplemented from Geom_Curve.

◆ EvalD0()

gp_Pnt Geom_Line::EvalD0 ( const double U ) const

finalvirtual

Returns 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 Geom_Curve.

◆ EvalD1()

Geom_Curve::ResD1 Geom_Line::EvalD1 ( const double U ) const

finalvirtual

Returns the point of parameter U and the first derivative.

Implements Geom_Curve.

◆ EvalD2()

Geom_Curve::ResD2 Geom_Line::EvalD2 ( const double U ) const

finalvirtual

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

Implements Geom_Curve.

◆ EvalD3()

Geom_Curve::ResD3 Geom_Line::EvalD3 ( const double U ) const

finalvirtual

Returns the point of parameter U, the first, second and third derivatives. The second and third derivatives are vectors with null magnitude for a line.

Implements Geom_Curve.

◆ EvalDN()

gp_Vec Geom_Line::EvalDN	(	const double	U,
		const int	N ) const

finalvirtual

Returns the vector corresponding to the derivative for the order of derivation N. Raised if N < 1.

Implements Geom_Curve.

◆ FirstParameter()

double Geom_Line::FirstParameter ( ) const

finalvirtual

Returns the value of the first parameter of this line. This is double::RealFirst().

Implements Geom_Curve.

◆ IsClosed()

bool Geom_Line::IsClosed ( ) const

finalvirtual

returns False

Implements Geom_Curve.

◆ IsCN()

bool Geom_Line::IsCN ( const int N ) const

finalvirtual

returns True. Raised if N < 0.

Implements Geom_Curve.

◆ IsPeriodic()

bool Geom_Line::IsPeriodic ( ) const

finalvirtual

returns False

Implements Geom_Curve.

◆ LastParameter()

double Geom_Line::LastParameter ( ) const

finalvirtual

Returns the value of the last parameter of this line. This is double::RealLast().

Implements Geom_Curve.

◆ Lin()

gp_Lin Geom_Line::Lin ( ) const

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

◆ ParametricTransformation()

double Geom_Line::ParametricTransformation ( const gp_Trsf & T ) const

finalvirtual

Returns a coefficient to compute the parameter on the transformed curve for the transform of the point on <me>.

Transformed(T)->Value(U * ParametricTransformation(T))

is the same point as

Value(U).Transformed(T)

This methods returns T.ScaleFactor()

Reimplemented from Geom_Curve.

◆ Position()

const gp_Ax1 & Geom_Line::Position ( ) const

Returns the positioning axis of this line; this is also its local coordinate system.

◆ Reverse()

void Geom_Line::Reverse ( )

finalvirtual

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

Implements Geom_Curve.

◆ ReversedParameter()

double Geom_Line::ReversedParameter ( const double U ) const

finalvirtual

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 Geom_Curve.

◆ SetDirection()

void Geom_Line::SetDirection ( const gp_Dir & V )

changes the direction of the line.

◆ SetLin()

void Geom_Line::SetLin ( const gp_Lin & L )

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

◆ SetLocation()

void Geom_Line::SetLocation ( const gp_Pnt & P )

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

◆ SetPosition()

void Geom_Line::SetPosition ( const gp_Ax1 & A1 )

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

◆ Transform()

void Geom_Line::Transform ( const gp_Trsf & T )

finalvirtual

Applies the transformation T to this line.

Implements Geom_Geometry.

◆ TransformedParameter()

double Geom_Line::TransformedParameter	(	const double	U,
		const gp_Trsf &	T ) const

finalvirtual

Returns the parameter on the transformed curve for the transform of the point of parameter U on <me>.

me->Transformed(T)->Value(me->TransformedParameter(U,T))

is the same point as

me->Value(U).Transformed(T)

This methods returns * T.ScaleFactor()

Reimplemented from Geom_Curve.

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

Geom_Line.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Geom_Line() [1/3]

◆ Geom_Line() [2/3]

◆ Geom_Line() [3/3]

Member Function Documentation

◆ Continuity()

◆ Copy()

◆ DumpJson()

◆ EvalD0()

◆ EvalD1()

◆ EvalD2()

◆ EvalD3()

◆ EvalDN()

◆ FirstParameter()

◆ IsClosed()

◆ IsCN()

◆ IsPeriodic()

◆ LastParameter()

◆ Lin()

◆ ParametricTransformation()

◆ Position()

◆ Reverse()

◆ ReversedParameter()

◆ SetDirection()

◆ SetLin()

◆ SetLocation()

◆ SetPosition()

◆ Transform()

◆ TransformedParameter()