IntPatch_ALine Class Reference

Implementation of an intersection line described by a parametrized curve. More...

#include <IntPatch_ALine.hxx>

Inheritance diagram for IntPatch_ALine:

Public Member Functions
	IntPatch_ALine (const IntAna_Curve &C, const Standard_Boolean Tang, const IntSurf_TypeTrans Trans1, const IntSurf_TypeTrans Trans2)
	Creates an analytic intersection line when the transitions are In or Out.
	IntPatch_ALine (const IntAna_Curve &C, const Standard_Boolean Tang, const IntSurf_Situation Situ1, const IntSurf_Situation Situ2)
	Creates an analytic intersection line when the transitions are Touch.
	IntPatch_ALine (const IntAna_Curve &C, const Standard_Boolean Tang)
	Creates an analytic intersection line when the transitions are Undecided.
void	AddVertex (const IntPatch_Point &Pnt)
	To add a vertex in the list.
void	Replace (const Standard_Integer Index, const IntPatch_Point &Pnt)
	Replaces the element of range Index in the list of points.
void	SetFirstPoint (const Standard_Integer IndFirst)
void	SetLastPoint (const Standard_Integer IndLast)
Standard_Real	FirstParameter (Standard_Boolean &IsIncluded) const
	Returns the first parameter on the intersection line. If IsIncluded returns True, Value and D1 methods can be call with a parameter equal to FirstParameter. Otherwise, the parameter must be greater than FirstParameter.
Standard_Real	LastParameter (Standard_Boolean &IsIncluded) const
	Returns the last parameter on the intersection line. If IsIncluded returns True, Value and D1 methods can be call with a parameter equal to LastParameter. Otherwise, the parameter must be less than LastParameter.
gp_Pnt	Value (const Standard_Real U)
	Returns the point of parameter U on the analytic intersection line.
Standard_Boolean	D1 (const Standard_Real U, gp_Pnt &P, gp_Vec &Du)
	Returns Standard_True when the derivative at parameter U is defined on the analytic intersection line. In that case, Du is the derivative. Returns Standard_False when it is not possible to evaluate the derivative. In both cases, P is the point at parameter U on the intersection.
void	FindParameter (const gp_Pnt &P, TColStd_ListOfReal &theParams) const
	Tries to find the parameters of the point P on the curve. If the method returns False, the "projection" is impossible. If the method returns True at least one parameter has been found. theParams is always sorted in ascending order.
Standard_Boolean	HasFirstPoint () const
	Returns True if the line has a known First point. This point is given by the method FirstPoint().
Standard_Boolean	HasLastPoint () const
	Returns True if the line has a known Last point. This point is given by the method LastPoint().
const IntPatch_Point &	FirstPoint () const
	Returns the IntPoint corresponding to the FirstPoint. An exception is raised when HasFirstPoint returns False.
const IntPatch_Point &	LastPoint () const
	Returns the IntPoint corresponding to the LastPoint. An exception is raised when HasLastPoint returns False.
Standard_Integer	NbVertex () const
const IntPatch_Point &	Vertex (const Standard_Integer Index) const
	Returns the vertex of range Index on the line.
IntPatch_Point &	ChangeVertex (const Standard_Integer theIndex)
	Allows modifying the vertex with index theIndex on the line.
void	ComputeVertexParameters (const Standard_Real Tol)
	Set the parameters of all the vertex on the line. if a vertex is already in the line, its parameter is modified else a new point in the line is inserted.
const IntAna_Curve &	Curve () const
Public Member Functions inherited from IntPatch_Line
void	SetValue (const Standard_Boolean Uiso1, const Standard_Boolean Viso1, const Standard_Boolean Uiso2, const Standard_Boolean Viso2)
	To set the values returned by IsUIsoS1,.... The default values are False.
IntPatch_IType	ArcType () const
	Returns the type of geometry 3d (Line, Circle, Parabola, Hyperbola, Ellipse, Analytic, Walking, Restriction)
Standard_Boolean	IsTangent () const
	Returns TRUE if the intersection is a line of tangency between the 2 patches.
IntSurf_TypeTrans	TransitionOnS1 () const
	Returns the type of the transition of the line for the first surface. The transition is "constant" along the line. The transition is IN if the line is oriented in such a way that the system of vector (N1,N2,T) is right-handed, where N1 is the normal to the first surface at a point P, N2 is the normal to the second surface at a point P, T is the tangent to the intersection line at P. If the system of vector is left-handed, the transition is OUT. When N1 and N2 are colinear all along the intersection line, the transition will be.
IntSurf_TypeTrans	TransitionOnS2 () const
	Returns the type of the transition of the line for the second surface. The transition is "constant" along the line.
IntSurf_Situation	SituationS1 () const
	Returns the situation (INSIDE/OUTSIDE/UNKNOWN) of the first patch compared to the second one, when TransitionOnS1 or TransitionOnS2 returns TOUCH. Otherwise, an exception is raised.
IntSurf_Situation	SituationS2 () const
	Returns the situation (INSIDE/OUTSIDE/UNKNOWN) of the second patch compared to the first one, when TransitionOnS1 or TransitionOnS2 returns TOUCH. Otherwise, an exception is raised.
Standard_Boolean	IsUIsoOnS1 () const
	Returns TRUE if the intersection is a U isoparametric curve on the first patch.
Standard_Boolean	IsVIsoOnS1 () const
	Returns TRUE if the intersection is a V isoparametric curve on the first patch.
Standard_Boolean	IsUIsoOnS2 () const
	Returns TRUE if the intersection is a U isoparametric curve on the second patch.
Standard_Boolean	IsVIsoOnS2 () const
	Returns TRUE if the intersection is a V isoparametric curve on the second patch.
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.
Protected Member Functions inherited from IntPatch_Line
	IntPatch_Line (const Standard_Boolean Tang, const IntSurf_TypeTrans Trans1, const IntSurf_TypeTrans Trans2)
	To initialize the fields, when the transitions are In or Out.
	IntPatch_Line (const Standard_Boolean Tang, const IntSurf_Situation Situ1, const IntSurf_Situation Situ2)
	To initialize the fields, when the transitions are Touch.
	IntPatch_Line (const Standard_Boolean Tang)
	To initialize the fields, when the transitions are Undecided.
Protected Attributes inherited from IntPatch_Line
IntPatch_IType	typ

Detailed Description

Implementation of an intersection line described by a parametrized curve.

Constructor & Destructor Documentation

IntPatch_ALine() [1/3]

IntPatch_ALine::IntPatch_ALine	(	const IntAna_Curve &	C,
		const Standard_Boolean	Tang,
		const IntSurf_TypeTrans	Trans1,
		const IntSurf_TypeTrans	Trans2 )

Creates an analytic intersection line when the transitions are In or Out.

IntPatch_ALine() [2/3]

IntPatch_ALine::IntPatch_ALine	(	const IntAna_Curve &	C,
		const Standard_Boolean	Tang,
		const IntSurf_Situation	Situ1,
		const IntSurf_Situation	Situ2 )

Creates an analytic intersection line when the transitions are Touch.

IntPatch_ALine() [3/3]

IntPatch_ALine::IntPatch_ALine	(	const IntAna_Curve &	C,
		const Standard_Boolean	Tang )

Creates an analytic intersection line when the transitions are Undecided.

Member Function Documentation

AddVertex()

void IntPatch_ALine::AddVertex

(

const IntPatch_Point &

Pnt

)

To add a vertex in the list.

ChangeVertex()

IntPatch_Point & IntPatch_ALine::ChangeVertex ( const Standard_Integer theIndex )

inline

Allows modifying the vertex with index theIndex on the line.

ComputeVertexParameters()

void IntPatch_ALine::ComputeVertexParameters

(

const Standard_Real

Tol

)

Set the parameters of all the vertex on the line. if a vertex is already in the line, its parameter is modified else a new point in the line is inserted.

Curve()

const IntAna_Curve & IntPatch_ALine::Curve

(

)

const

D1()

Standard_Boolean IntPatch_ALine::D1	(	const Standard_Real	U,
		gp_Pnt &	P,
		gp_Vec &	Du )

Returns Standard_True when the derivative at parameter U is defined on the analytic intersection line. In that case, Du is the derivative. Returns Standard_False when it is not possible to evaluate the derivative. In both cases, P is the point at parameter U on the intersection.

FindParameter()

void IntPatch_ALine::FindParameter	(	const gp_Pnt &	P,
		TColStd_ListOfReal &	theParams ) const

Tries to find the parameters of the point P on the curve. If the method returns False, the "projection" is impossible. If the method returns True at least one parameter has been found. theParams is always sorted in ascending order.

FirstParameter()

Standard_Real IntPatch_ALine::FirstParameter

(

Standard_Boolean &

IsIncluded

)

const

Returns the first parameter on the intersection line. If IsIncluded returns True, Value and D1 methods can be call with a parameter equal to FirstParameter. Otherwise, the parameter must be greater than FirstParameter.

FirstPoint()

const IntPatch_Point & IntPatch_ALine::FirstPoint

(

)

const

Returns the IntPoint corresponding to the FirstPoint. An exception is raised when HasFirstPoint returns False.

HasFirstPoint()

Standard_Boolean IntPatch_ALine::HasFirstPoint

(

)

const

Returns True if the line has a known First point. This point is given by the method FirstPoint().

HasLastPoint()

Standard_Boolean IntPatch_ALine::HasLastPoint

(

)

const

Returns True if the line has a known Last point. This point is given by the method LastPoint().

LastParameter()

Standard_Real IntPatch_ALine::LastParameter

(

Standard_Boolean &

IsIncluded

)

const

Returns the last parameter on the intersection line. If IsIncluded returns True, Value and D1 methods can be call with a parameter equal to LastParameter. Otherwise, the parameter must be less than LastParameter.

LastPoint()

const IntPatch_Point & IntPatch_ALine::LastPoint

(

)

const

Returns the IntPoint corresponding to the LastPoint. An exception is raised when HasLastPoint returns False.

NbVertex()

Standard_Integer IntPatch_ALine::NbVertex

(

)

const

Replace()

void IntPatch_ALine::Replace	(	const Standard_Integer	Index,
		const IntPatch_Point &	Pnt )

Replaces the element of range Index in the list of points.

SetFirstPoint()

void IntPatch_ALine::SetFirstPoint

(

const Standard_Integer

IndFirst

)

SetLastPoint()

void IntPatch_ALine::SetLastPoint

(

const Standard_Integer

IndLast

)

Value()

gp_Pnt IntPatch_ALine::Value

(

const Standard_Real

U

)

Returns the point of parameter U on the analytic intersection line.

Vertex()

const IntPatch_Point & IntPatch_ALine::Vertex

(

const Standard_Integer

Index

)

const

Returns the vertex of range Index on the line.

---

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

• IntPatch_ALine.hxx