Contap_SurfFunction Class Reference

This class describes the function on a parametric surface. the form of the function is F(u,v) = 0 where u and v are the parameteric coordinates of a point on the surface, to compute the contours of the surface. More...

#include <Contap_SurfFunction.hxx>

Inheritance diagram for Contap_SurfFunction:

Public Member Functions
	Contap_SurfFunction ()
void	Set (const Handle< Adaptor3d_HSurface > &S)
void	Set (const gp_Pnt &Eye)
void	Set (const gp_Dir &Dir)
void	Set (const gp_Dir &Dir, const Standard_Real Angle)
void	Set (const gp_Pnt &Eye, const Standard_Real Angle)
void	Set (const Standard_Real Tolerance)
Standard_Integer	NbVariables () const
	This method has to return 2. More...
Standard_Integer	NbEquations () const
	This method has to return 1. More...
Standard_Boolean	Value (const math_Vector &X, math_Vector &F)
	The dimension of F is 1. More...
Standard_Boolean	Derivatives (const math_Vector &X, math_Matrix &D)
	The dimension of D is (1,2). More...
Standard_Boolean	Values (const math_Vector &X, math_Vector &F, math_Matrix &D)
	returns the values <F> of the functions and the derivatives <D> for the variable <X>. Returns True if the computation was done successfully, False otherwise. More...
Standard_Real	Root () const
	Root is the value of the function at the solution. It is a vector of dimension 1, i-e a real. More...
Standard_Real	Tolerance () const
	Returns the value Tol so that if Abs(Func.Root())<Tol the function is considered null. More...
const gp_Pnt &	Point () const
	Returns the value of the solution point on the surface. More...
Standard_Boolean	IsTangent ()
const gp_Vec &	Direction3d ()
const gp_Dir2d &	Direction2d ()
Contap_TFunction	FunctionType () const
const gp_Pnt &	Eye () const
const gp_Dir &	Direction () const
Standard_Real	Angle () const
const Handle< Adaptor3d_HSurface > &	Surface () const
Public Member Functions inherited from math_FunctionSet
virtual Standard_Integer	GetStateNumber ()
	Returns the state of the function corresponding to the latestcall of any methods associated with the function. This function is called by each of the algorithms described later which define the function Integer Algorithm::StateNumber(). The algorithm has the responsibility to call this function when it has found a solution (i.e. a root or a minimum) and has to maintain the association between the solution found and this StateNumber. Byu default, this method returns 0 (which means for the algorithm: no state has been saved). It is the responsibility of the programmer to decide if he needs to save the current state of the function and to return an Integer that allows retrieval of the state. More...
virtual	~math_FunctionSet ()

Detailed Description

This class describes the function on a parametric surface. the form of the function is F(u,v) = 0 where u and v are the parameteric coordinates of a point on the surface, to compute the contours of the surface.

Constructor & Destructor Documentation

Contap_SurfFunction()

Contap_SurfFunction::Contap_SurfFunction

(

)

Member Function Documentation

Angle()

Standard_Real Contap_SurfFunction::Angle

(

)

const

Derivatives()

Standard_Boolean Contap_SurfFunction::Derivatives ( const math_Vector &  X, math_Matrix &  D  )

virtual

The dimension of D is (1,2).

Implements math_FunctionSetWithDerivatives.

Direction()

const gp_Dir& Contap_SurfFunction::Direction

(

)

const

Direction2d()

const gp_Dir2d& Contap_SurfFunction::Direction2d

(

)

Direction3d()

const gp_Vec& Contap_SurfFunction::Direction3d

(

)

Eye()

const gp_Pnt& Contap_SurfFunction::Eye

(

)

const

FunctionType()

Contap_TFunction Contap_SurfFunction::FunctionType

(

)

const

IsTangent()

Standard_Boolean Contap_SurfFunction::IsTangent

(

)

NbEquations()

Standard_Integer Contap_SurfFunction::NbEquations ( ) const

virtual

This method has to return 1.

Implements math_FunctionSetWithDerivatives.

NbVariables()

Standard_Integer Contap_SurfFunction::NbVariables ( ) const

virtual

This method has to return 2.

Implements math_FunctionSetWithDerivatives.

Point()

const gp_Pnt& Contap_SurfFunction::Point

(

)

const

Returns the value of the solution point on the surface.

Root()

Standard_Real Contap_SurfFunction::Root

(

)

const

Root is the value of the function at the solution. It is a vector of dimension 1, i-e a real.

Set() [1/6]

void Contap_SurfFunction::Set

(

const Handle< Adaptor3d_HSurface > &

S

)

Set() [2/6]

void Contap_SurfFunction::Set

(

const gp_Pnt &

Eye

)

Set() [3/6]

void Contap_SurfFunction::Set

(

const gp_Dir &

Dir

)

Set() [4/6]

void Contap_SurfFunction::Set	(	const gp_Dir &	Dir,
		const Standard_Real	Angle
	)

Set() [5/6]

void Contap_SurfFunction::Set	(	const gp_Pnt &	Eye,
		const Standard_Real	Angle
	)

Set() [6/6]

void Contap_SurfFunction::Set

(

const Standard_Real

Tolerance

)

Surface()

const Handle< Adaptor3d_HSurface >& Contap_SurfFunction::Surface

(

)

const

Tolerance()

Standard_Real Contap_SurfFunction::Tolerance

(

)

const

Returns the value Tol so that if Abs(Func.Root())<Tol the function is considered null.

Value()

Standard_Boolean Contap_SurfFunction::Value ( const math_Vector &  X, math_Vector &  F  )

virtual

The dimension of F is 1.

Implements math_FunctionSetWithDerivatives.

Values()

Standard_Boolean Contap_SurfFunction::Values ( const math_Vector &  X, math_Vector &  F, math_Matrix &  D  )

virtual

returns the values <F> of the functions and the derivatives <D> for the variable <X>. Returns True if the computation was done successfully, False otherwise.

Implements math_FunctionSetWithDerivatives.

---

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

• Contap_SurfFunction.hxx