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 () 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 the value of the first parameter of this line. This is Standard_Real::RealFirst().

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

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_Boolean	IsCN (const Standard_Integer N) const override
	returns True. Raised if N < 0.

void	D0 (const Standard_Real U, gp_Pnt &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_Pnt &P, gp_Vec &V1) const override
	Returns the point P of parameter u and the first derivative V1.

void	D2 (const Standard_Real U, gp_Pnt &P, gp_Vec &V1, gp_Vec &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_Pnt &P, gp_Vec &V1, gp_Vec &V2, gp_Vec &V3) const override
	V2 and V3 are vectors with null magnitude for a line.

gp_Vec	DN (const Standard_Real U, const Standard_Integer N) const override
	The returned vector gives the value of the derivative for the order of derivation N. Raised if N < 1.

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

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

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

Handle< Geom_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 Geom_Curve
Handle< Geom_Curve >	Reversed () const
	Returns a copy of <me> reversed.

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

gp_Pnt	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. it is implemented with D0.

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

Handle< Geom_Geometry >	Mirrored (const gp_Pnt &P) const

Handle< Geom_Geometry >	Mirrored (const gp_Ax1 &A1) const

Handle< Geom_Geometry >	Mirrored (const gp_Ax2 &A2) const

Handle< Geom_Geometry >	Rotated (const gp_Ax1 &A1, const Standard_Real Ang) const

Handle< Geom_Geometry >	Scaled (const gp_Pnt &P, const Standard_Real S) const

Handle< Geom_Geometry >	Transformed (const gp_Trsf &T) const

Handle< Geom_Geometry >	Translated (const gp_Vec &V) const

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 ()
	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. 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

overridevirtual

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

Implements Geom_Curve.

◆ Copy()

Handle< Geom_Geometry > Geom_Line::Copy ( ) const

overridevirtual

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

Implements Geom_Geometry.

◆ D0()

void Geom_Line::D0	(	const Standard_Real	U,
		gp_Pnt &	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 Geom_Curve.

◆ D1()

void Geom_Line::D1	(	const Standard_Real	U,
		gp_Pnt &	P,
		gp_Vec &	V1 ) const

overridevirtual

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

Implements Geom_Curve.

◆ D2()

void Geom_Line::D2	(	const Standard_Real	U,
		gp_Pnt &	P,
		gp_Vec &	V1,
		gp_Vec &	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 Geom_Curve.

◆ D3()

void Geom_Line::D3	(	const Standard_Real	U,
		gp_Pnt &	P,
		gp_Vec &	V1,
		gp_Vec &	V2,
		gp_Vec &	V3 ) const

overridevirtual

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

Implements Geom_Curve.

◆ DN()

gp_Vec Geom_Line::DN	(	const Standard_Real	U,
		const Standard_Integer	N ) const

overridevirtual

The returned vector gives the value of the derivative for the order of derivation N. Raised if N < 1.

Implements Geom_Curve.

◆ DumpJson()

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

overridevirtual

Dumps the content of me into the stream.

Reimplemented from Geom_Curve.

◆ FirstParameter()

Standard_Real Geom_Line::FirstParameter ( ) const

overridevirtual

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

Implements Geom_Curve.

◆ IsClosed()

Standard_Boolean Geom_Line::IsClosed ( ) const

overridevirtual

returns False

Implements Geom_Curve.

◆ IsCN()

Standard_Boolean Geom_Line::IsCN ( const Standard_Integer N ) const

overridevirtual

returns True. Raised if N < 0.

Implements Geom_Curve.

◆ IsPeriodic()

Standard_Boolean Geom_Line::IsPeriodic ( ) const

overridevirtual

returns False

Implements Geom_Curve.

◆ LastParameter()

Standard_Real Geom_Line::LastParameter ( ) const

overridevirtual

Returns the value of the last parameter of this line. This is Standard_Real::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()

virtual Standard_Real Geom_Line::ParametricTransformation ( const gp_Trsf & T ) const

overridevirtual

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 ( )

overridevirtual

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()

Standard_Real Geom_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 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 )

overridevirtual

Applies the transformation T to this line.

Implements Geom_Geometry.

◆ TransformedParameter()

virtual Standard_Real Geom_Line::TransformedParameter	(	const Standard_Real	U,
		const gp_Trsf &	T ) const

overridevirtual

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()

◆ D0()

◆ D1()

◆ D2()

◆ D3()

◆ DN()

◆ DumpJson()

◆ FirstParameter()

◆ IsClosed()

◆ IsCN()

◆ IsPeriodic()

◆ LastParameter()

◆ Lin()

◆ ParametricTransformation()

◆ Position()

◆ Reverse()

◆ ReversedParameter()

◆ SetDirection()

◆ SetLin()

◆ SetLocation()

◆ SetPosition()

◆ Transform()

◆ TransformedParameter()