IntRes2d_Domain Class Reference

Definition of the domain of parameter on a 2d-curve. Most of the time, a domain is defined by two extremities. An extremity is made of : More...

#include <IntRes2d_Domain.hxx>

Public Member Functions
	IntRes2d_Domain ()
	Creates an infinite Domain (HasFirstPoint = False and HasLastPoint = False).
	IntRes2d_Domain (const gp_Pnt2d &Pnt1, const Standard_Real Par1, const Standard_Real Tol1, const gp_Pnt2d &Pnt2, const Standard_Real Par2, const Standard_Real Tol2)
	Creates a bounded Domain.
	IntRes2d_Domain (const gp_Pnt2d &Pnt, const Standard_Real Par, const Standard_Real Tol, const Standard_Boolean First)
	Creates a semi-infinite Domain. If First is set to True, the given point is the first point of the domain, otherwise it is the last point.
void	SetValues (const gp_Pnt2d &Pnt1, const Standard_Real Par1, const Standard_Real Tol1, const gp_Pnt2d &Pnt2, const Standard_Real Par2, const Standard_Real Tol2)
	Sets the values for a bounded domain.
void	SetValues ()
	Sets the values for an infinite domain.
void	SetValues (const gp_Pnt2d &Pnt, const Standard_Real Par, const Standard_Real Tol, const Standard_Boolean First)
	Sets the values for a semi-infinite domain.
void	SetEquivalentParameters (const Standard_Real zero, const Standard_Real period)
	Defines a closed domain.
Standard_Boolean	HasFirstPoint () const
	Returns True if the domain has a first point, i-e a point defining the lowest admitted parameter on the curve.
Standard_Real	FirstParameter () const
	Returns the parameter of the first point of the domain The exception DomainError is raised if HasFirstPoint returns False.
const gp_Pnt2d &	FirstPoint () const
	Returns the first point of the domain. The exception DomainError is raised if HasFirstPoint returns False.
Standard_Real	FirstTolerance () const
	Returns the tolerance of the first (left) bound. The exception DomainError is raised if HasFirstPoint returns False.
Standard_Boolean	HasLastPoint () const
	Returns True if the domain has a last point, i-e a point defining the highest admitted parameter on the curve.
Standard_Real	LastParameter () const
	Returns the parameter of the last point of the domain. The exception DomainError is raised if HasLastPoint returns False.
const gp_Pnt2d &	LastPoint () const
	Returns the last point of the domain. The exception DomainError is raised if HasLastPoint returns False.
Standard_Real	LastTolerance () const
	Returns the tolerance of the last (right) bound. The exception DomainError is raised if HasLastPoint returns False.
Standard_Boolean	IsClosed () const
	Returns True if the domain is closed.
void	EquivalentParameters (Standard_Real &zero, Standard_Real &zeroplusperiod) const
	Returns Equivalent parameters if the domain is closed. Otherwise, the exception DomainError is raised.

Detailed Description

Definition of the domain of parameter on a 2d-curve. Most of the time, a domain is defined by two extremities. An extremity is made of :

• a point in 2d-space (Pnt2d from gp),
• a parameter on the curve,
• a tolerance in the 2d-space. Sometimes, it can be made of 0 or 1 point ( for an infinite or semi-infinite line for example).

For Intersection algorithms, Ellipses and Circles Domains must be closed. So, SetEquivalentParameters(.,.) method must be called after initializing the first and the last bounds.

Constructor & Destructor Documentation

IntRes2d_Domain() [1/3]

IntRes2d_Domain::IntRes2d_Domain

(

)

Creates an infinite Domain (HasFirstPoint = False and HasLastPoint = False).

IntRes2d_Domain() [2/3]

IntRes2d_Domain::IntRes2d_Domain	(	const gp_Pnt2d &	Pnt1,
		const Standard_Real	Par1,
		const Standard_Real	Tol1,
		const gp_Pnt2d &	Pnt2,
		const Standard_Real	Par2,
		const Standard_Real	Tol2
	)

Creates a bounded Domain.

IntRes2d_Domain() [3/3]

IntRes2d_Domain::IntRes2d_Domain	(	const gp_Pnt2d &	Pnt,
		const Standard_Real	Par,
		const Standard_Real	Tol,
		const Standard_Boolean	First
	)

Creates a semi-infinite Domain. If First is set to True, the given point is the first point of the domain, otherwise it is the last point.

Member Function Documentation

EquivalentParameters()

void IntRes2d_Domain::EquivalentParameters	(	Standard_Real &	zero,
		Standard_Real &	zeroplusperiod
	)		const

Returns Equivalent parameters if the domain is closed. Otherwise, the exception DomainError is raised.

FirstParameter()

Standard_Real IntRes2d_Domain::FirstParameter

(

)

const

Returns the parameter of the first point of the domain The exception DomainError is raised if HasFirstPoint returns False.

FirstPoint()

const gp_Pnt2d & IntRes2d_Domain::FirstPoint

(

)

const

Returns the first point of the domain. The exception DomainError is raised if HasFirstPoint returns False.

FirstTolerance()

Standard_Real IntRes2d_Domain::FirstTolerance

(

)

const

Returns the tolerance of the first (left) bound. The exception DomainError is raised if HasFirstPoint returns False.

HasFirstPoint()

Standard_Boolean IntRes2d_Domain::HasFirstPoint

(

)

const

Returns True if the domain has a first point, i-e a point defining the lowest admitted parameter on the curve.

HasLastPoint()

Standard_Boolean IntRes2d_Domain::HasLastPoint

(

)

const

Returns True if the domain has a last point, i-e a point defining the highest admitted parameter on the curve.

IsClosed()

Standard_Boolean IntRes2d_Domain::IsClosed

(

)

const

Returns True if the domain is closed.

LastParameter()

Standard_Real IntRes2d_Domain::LastParameter

(

)

const

Returns the parameter of the last point of the domain. The exception DomainError is raised if HasLastPoint returns False.

LastPoint()

const gp_Pnt2d & IntRes2d_Domain::LastPoint

(

)

const

Returns the last point of the domain. The exception DomainError is raised if HasLastPoint returns False.

LastTolerance()

Standard_Real IntRes2d_Domain::LastTolerance

(

)

const

Returns the tolerance of the last (right) bound. The exception DomainError is raised if HasLastPoint returns False.

SetEquivalentParameters()

void IntRes2d_Domain::SetEquivalentParameters	(	const Standard_Real	zero,
		const Standard_Real	period
	)

Defines a closed domain.

SetValues() [1/3]

void IntRes2d_Domain::SetValues

(

)

Sets the values for an infinite domain.

SetValues() [2/3]

void IntRes2d_Domain::SetValues	(	const gp_Pnt2d &	Pnt,
		const Standard_Real	Par,
		const Standard_Real	Tol,
		const Standard_Boolean	First
	)

Sets the values for a semi-infinite domain.

SetValues() [3/3]

void IntRes2d_Domain::SetValues	(	const gp_Pnt2d &	Pnt1,
		const Standard_Real	Par1,
		const Standard_Real	Tol1,
		const gp_Pnt2d &	Pnt2,
		const Standard_Real	Par2,
		const Standard_Real	Tol2
	)

Sets the values for a bounded domain.

---

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

• IntRes2d_Domain.hxx