IntPolyh_Couple Class Reference

The class represents the couple of indices with additional characteristics such as analyzed flag and an angle.
In IntPolyh_MaillageAffinage algorithm the class is used as a couple of interfering triangles with the intersection angle. More...

#include <IntPolyh_Couple.hxx>

Public Member Functions
	IntPolyh_Couple ()
	Constructor. More...
	IntPolyh_Couple (const Standard_Integer theTriangle1, const Standard_Integer theTriangle2, const Standard_Real theAngle=-2.0)
	Constructor. More...
Standard_Integer	FirstValue () const
	Returns the first index. More...
Standard_Integer	SecondValue () const
	Returns the second index. More...
Standard_Boolean	IsAnalyzed () const
	Returns TRUE if the couple has been analyzed. More...
Standard_Real	Angle () const
	Returns the angle. More...
void	SetCoupleValue (const Standard_Integer theInd1, const Standard_Integer theInd2)
	Sets the triangles. More...
void	SetAnalyzed (const Standard_Boolean theAnalyzed)
	Sets the analyzed flag. More...
void	SetAngle (const Standard_Real theAngle)
	Sets the angle. More...
Standard_Boolean	IsEqual (const IntPolyh_Couple &theOther) const
	Returns true if the Couple is equal to <theOther> More...
Standard_Integer	HashCode (const Standard_Integer theUpperBound) const
	Computes a hash code for this couple, in the range [1, theUpperBound]. More...
void	Dump (const Standard_Integer v) const

Detailed Description

The class represents the couple of indices with additional characteristics such as analyzed flag and an angle.
In IntPolyh_MaillageAffinage algorithm the class is used as a couple of interfering triangles with the intersection angle.

Constructor & Destructor Documentation

IntPolyh_Couple() [1/2]

IntPolyh_Couple::IntPolyh_Couple ( )

inline

Constructor.

IntPolyh_Couple() [2/2]

IntPolyh_Couple::IntPolyh_Couple ( const Standard_Integer  theTriangle1, const Standard_Integer  theTriangle2, const Standard_Real  theAngle = -2.0  )

inline

Constructor.

Member Function Documentation

Angle()

Standard_Real IntPolyh_Couple::Angle ( ) const

inline

Returns the angle.

Dump()

void IntPolyh_Couple::Dump

(

const Standard_Integer

v

)

const

FirstValue()

Standard_Integer IntPolyh_Couple::FirstValue ( ) const

inline

Returns the first index.

HashCode()

Standard_Integer IntPolyh_Couple::HashCode ( const Standard_Integer  theUpperBound ) const

inline

Computes a hash code for this couple, in the range [1, theUpperBound].

Parameters

theUpperBound

the upper bound of the range a computing hash code must be within

Returns

a computed hash code, in the range [1, theUpperBound]

IsAnalyzed()

Standard_Boolean IntPolyh_Couple::IsAnalyzed ( ) const

inline

Returns TRUE if the couple has been analyzed.

IsEqual()

Standard_Boolean IntPolyh_Couple::IsEqual ( const IntPolyh_Couple &  theOther ) const

inline

Returns true if the Couple is equal to <theOther>

SecondValue()

Standard_Integer IntPolyh_Couple::SecondValue ( ) const

inline

Returns the second index.

SetAnalyzed()

void IntPolyh_Couple::SetAnalyzed ( const Standard_Boolean  theAnalyzed )

inline

Sets the analyzed flag.

SetAngle()

void IntPolyh_Couple::SetAngle ( const Standard_Real  theAngle )

inline

Sets the angle.

SetCoupleValue()

void IntPolyh_Couple::SetCoupleValue ( const Standard_Integer  theInd1, const Standard_Integer  theInd2  )

inline

Sets the triangles.

---

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

• IntPolyh_Couple.hxx