HatchGen_PointOnHatching Class Reference

#include <HatchGen_PointOnHatching.hxx>

Inheritance diagram for HatchGen_PointOnHatching:

Public Member Functions
	HatchGen_PointOnHatching ()
	Creates an empty point.
	HatchGen_PointOnHatching (const IntRes2d_IntersectionPoint &Point)
	Creates a point from an intersection point.
void	AddPoint (const HatchGen_PointOnElement &Point, const double Confusion)
	Adds a point on element to the point.
int	NbPoints () const
	Returns the number of elements intersecting the hatching at this point.
const HatchGen_PointOnElement &	Point (const int Index) const
	Returns the Index-th point on element of the point. The exception OutOfRange is raised if Index > NbPoints.
void	RemPoint (const int Index)
	Removes the Index-th point on element of the point. The exception OutOfRange is raised if Index > NbPoints.
void	ClrPoints ()
	Removes all the points on element of the point.
bool	IsLower (const HatchGen_PointOnHatching &Point, const double Confusion) const
	Tests if the point is lower than an other. A point on hatching P1 is said to be lower than an other P2 if : P2.myParam - P1.myParam > Confusion.
bool	IsEqual (const HatchGen_PointOnHatching &Point, const double Confusion) const
	Tests if the point is equal to an other. A point on hatching P1 is said to be equal to an other P2 if : | P2.myParam - P1.myParam | <= Confusion.
bool	IsGreater (const HatchGen_PointOnHatching &Point, const double Confusion) const
	Tests if the point is greater than an other. A point on hatching P1 is said to be greater than an other P2 if : P1.myParam - P2.myParam > Confusion.
void	Dump (const int Index=0) const override
	Dump of the point.
Public Member Functions inherited from HatchGen_IntersectionPoint
void	SetIndex (const int Index)
	Sets the index of the supporting curve.
int	Index () const
	Returns the index of the supporting curve.
void	SetParameter (const double Parameter)
	Sets the parameter on the curve.
double	Parameter () const
	Returns the parameter on the curve.
void	SetPosition (const TopAbs_Orientation Position)
	Sets the position of the point on the curve.
TopAbs_Orientation	Position () const
	Returns the position of the point on the curve.
void	SetStateBefore (const TopAbs_State State)
	Sets the transition state before the intersection.
TopAbs_State	StateBefore () const
	Returns the transition state before the intersection.
void	SetStateAfter (const TopAbs_State State)
	Sets the transition state after the intersection.
TopAbs_State	StateAfter () const
	Returns the transition state after of the intersection.
void	SetSegmentBeginning (const bool State=true)
	Sets the flag that the point is the beginning of a segment.
bool	SegmentBeginning () const
	Returns the flag that the point is the beginning of a segment.
void	SetSegmentEnd (const bool State=true)
	Sets the flag that the point is the end of a segment.
bool	SegmentEnd () const
	Returns the flag that the point is the end of a segment.

Protected Attributes
NCollection_Sequence< HatchGen_PointOnElement >	myPoints
Protected Attributes inherited from HatchGen_IntersectionPoint
int	myIndex
double	myParam
TopAbs_Orientation	myPosit
TopAbs_State	myBefore
TopAbs_State	myAfter
bool	mySegBeg
bool	mySegEnd

Additional Inherited Members
Protected Member Functions inherited from HatchGen_IntersectionPoint
	HatchGen_IntersectionPoint ()
	Creates an empty intersection point.
	~HatchGen_IntersectionPoint ()=default
	Destructor is protected for safer inheritance.

Constructor & Destructor Documentation

HatchGen_PointOnHatching() [1/2]

HatchGen_PointOnHatching::HatchGen_PointOnHatching

(

)

Creates an empty point.

HatchGen_PointOnHatching() [2/2]

HatchGen_PointOnHatching::HatchGen_PointOnHatching

(

const IntRes2d_IntersectionPoint &

Point

)

Creates a point from an intersection point.

Member Function Documentation

AddPoint()

void HatchGen_PointOnHatching::AddPoint	(	const HatchGen_PointOnElement &	Point,
		const double	Confusion )

Adds a point on element to the point.

ClrPoints()

void HatchGen_PointOnHatching::ClrPoints

(

)

Removes all the points on element of the point.

Dump()

void HatchGen_PointOnHatching::Dump ( const int Index = 0 ) const

overridevirtual

Dump of the point.

Implements HatchGen_IntersectionPoint.

IsEqual()

bool HatchGen_PointOnHatching::IsEqual	(	const HatchGen_PointOnHatching &	Point,
		const double	Confusion ) const

Tests if the point is equal to an other. A point on hatching P1 is said to be equal to an other P2 if : | P2.myParam - P1.myParam | <= Confusion.

IsGreater()

bool HatchGen_PointOnHatching::IsGreater	(	const HatchGen_PointOnHatching &	Point,
		const double	Confusion ) const

Tests if the point is greater than an other. A point on hatching P1 is said to be greater than an other P2 if : P1.myParam - P2.myParam > Confusion.

IsLower()

bool HatchGen_PointOnHatching::IsLower	(	const HatchGen_PointOnHatching &	Point,
		const double	Confusion ) const

Tests if the point is lower than an other. A point on hatching P1 is said to be lower than an other P2 if : P2.myParam - P1.myParam > Confusion.

NbPoints()

int HatchGen_PointOnHatching::NbPoints

(

)

const

Returns the number of elements intersecting the hatching at this point.

Point()

const HatchGen_PointOnElement & HatchGen_PointOnHatching::Point

(

const int

Index

)

const

Returns the Index-th point on element of the point. The exception OutOfRange is raised if Index > NbPoints.

RemPoint()

void HatchGen_PointOnHatching::RemPoint

(

const int

Index

)

Removes the Index-th point on element of the point. The exception OutOfRange is raised if Index > NbPoints.

Field Documentation

myPoints

NCollection_Sequence<HatchGen_PointOnElement> HatchGen_PointOnHatching::myPoints

protected

---

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

• HatchGen_PointOnHatching.hxx