All Frameworks Class Hierarchy This Framework Indexes Previous Next

GeometricObjects class CATSurParam

Usage: you must use this class as is. You should never derive it.

public class CATSurParam

Class representing the global parameter of a point on a CATSurface.

The parameter of a point on a surface is defined by two values, one in each direction of the surface: each value is the value of the isoparametric curve along a surface direction passing through the point. The global parameter value in one direction corresponds to a local parameter and a patch number in this direction. The local parameters are managed by the geometrical elements.
Note that you also can create CATSurParams by using the CreateParam method of the CATSurface interface.

See also:: CATSurface

Constructor and Destructor Index

o CATSurParam(): Default constructor.
o CATSurParam(CATSurParam&): Copy constructor.
o CATSurParam(double,double,CATSurLimits&)
o CATSurParam(double,double,CATSurLimits&): Constructs the CATSurParam whose U (resp.
o CATSurParam(double,double,CATSurParam&,CATSurParam&)
o CATSurParam(double,double,CATSurParam&,CATSurParam&): Constructs the CATSurParam whose U (resp.

Method Index

o DistanceTo(CATSurParam&): Returns the distance to another CATSurParam.
o GetLocalParamU(): Returns the local parameter in the first direction of this CATSurParam.
o GetLocalParamV(): Returns the local parameter in the second direction of this CATSurParam.
o GetParamU(): Returns the global parameter in the first direction of this CATSurParam.
o GetParamV(): Returns the global parameter in the second direction of this CATSurParam.
o GetParams(double&,double&): Returns the global parameter in each direction of this CATSurParam.
o GetPatchNumberU(): Returns the patch number in the first direction of this CATSurParam.
o GetPatchNumberV(): Returns the patch number in the second direction of this CATSurParam.
o SetLocalParamU(double): Modifies the local parameter in the first direction of this CATSurParam.
o SetLocalParamV(double): Modifies the local parameter in the second direction of this CATSurParam.
o SetParam(double,double): Modifies the global parameters.
o SetParam(CATSurParam&): Affects a CATSurParam.
o SetParam(double,double,CATSurLimits&): Modifies this CATSurParam with a barycentric method on a CATSurLimits.
o SetParam(double,double,CATSurParam&,CATSurParam&): Modifies this CATSurParam with a barycentric method on two CATSurParams.
o SetParamU(double): Modifies the global parameter in the first direction of this CATSurParam.
o SetParamV(double): Modifies the global parameter in the second direction of this CATSurParam.
o SetPatchNumberU(CATLONG32): Modifies the patch number in the first direction of this CATSurParam.
o SetPatchNumberV(CATLONG32): Modifies the patch number in the second direction of this CATSurParam.
o SquareDistanceTo(CATSurParam&): Returns the square distance to another CATSurParam.
o operator !=(CATSurParam&): Inequality operator.
o operator *(CATMathTransformation2D&): Move a CATSurParam with a CATMathTransformation2D.
o operator +(CATMathVector2D&): Addition operator.
o operator +=(CATMathVector2D&): Addition assignment operator.
o operator -(CATSurParam&): Subtraction operator.
o operator ==(CATSurParam&): Equality operator.

Constructor and Destructor

o CATSurParam

public CATSurParam(

)

Default constructor.
Avoids this as much as possible, because no CATSurface is related to.

o CATSurParam

public CATSurParam( const CATSurParam& iSurParamToCopy)

Copy constructor.

o CATSurParam

public CATSurParam(	double	`iLambdaU`,
	double	`iLambdaV`,
	const CATSurLimits&	`iBoxUV`)

o CATSurParam

public INLINE CATSurParam(	double	`iLambdaU`,
	double	`iLambdaV`,
	const CATSurLimits&	`iBoxUV`)

Constructs the CATSurParam whose U (resp. V) coordinate is the barycenter of the U (resp. V) coordinate of the limits of a CATSurLimits.
Check before that the CATSurLimits is not empty.
This allows you to reach each parameter of the rectangle defined by to points.

Parameters:

iLamdaU: The weigth used on the first U direction.
iLamdaV: The weigth used on the second V direction.
iBoxUV: The limits of parameters {(iP1(U),iP1(V)),(iP2(U),iP2(V))}.

Returns:

The CATSurParam of parameters
((1-iLambdaU)*iP1(U) + iLambdaU*iP2(U),(1-iLambdaV)*iP1(V) + iLambdaV*iP2(V))

o CATSurParam

public CATSurParam(	double	`iLambdaU`,
	double	`iLambdaV`,
	const CATSurParam&	`iP1`,
	const CATSurParam&	`iP2`)

o CATSurParam

public INLINE CATSurParam(	double	`iLambdaU`,
	double	`iLambdaV`,
	const CATSurParam&	`iP1`,
	const CATSurParam&	`iP2`)

Constructs the CATSurParam whose U (resp. V) coordinate is the barycenter of the U (resp. V) coordinate of two CATSurParams.
This allows you to reach each parameter of the rectangle defined by to points.

Parameters:

iLamdaU: The weigth used on the first U direction.
iLamdaV: The weigth used on the second V direction.
iP1: The fisrt CATSurParam (iP1(U),iP1(V)).
iP2: The second CATSurParam (iP2(U),iP2(V)).

Returns:

The CATSurParam of parameter
((1-iLambdaU)*iP1(U) + iLambdaU*iP2(U),(1-iLambdaV)*iP1(V) + iLambdaV*iP2(V))

Methods

o DistanceTo

public double DistanceTo( const CATSurParam& iOtherParam) const

Returns the distance to another CATSurParam.

Parameters:

iOtherParam: The other parameter.

o GetLocalParamU

public INLINE double GetLocalParamU(

)const

Returns the local parameter in the first direction of this CATSurParam.

Returns:: The parameter value.

o GetLocalParamV

public INLINE double GetLocalParamV(

)const

Returns the local parameter in the second direction of this CATSurParam.

Returns:: The parameter value.

o GetParamU

public double GetParamU(

)const

Returns the global parameter in the first direction of this CATSurParam.

Returns:: The parameter value.

o GetParamV

public double GetParamV(

)const

Returns the global parameter in the second direction of this CATSurParam.

Returns:: The parameter value.

o GetParams

public void GetParams(	double&	`ioGlobalParamU`,
	double&	`ioGlobalParamV`) const

Returns the global parameter in each direction of this CATSurParam.

Parameters:

ioGlobalParamU: The parameter value in the first direction.
ioGlobalParamV: The parameter value in the second direction.

o GetPatchNumberU

public INLINE CATLONG32 GetPatchNumberU(

)const

Returns the patch number in the first direction of this CATSurParam.

Returns:: The patch number.

o GetPatchNumberV

public INLINE CATLONG32 GetPatchNumberV(

)const

Returns the patch number in the second direction of this CATSurParam.

Returns:: The patch number.

o SetLocalParamU

public INLINE void SetLocalParamU( double iLocalParamU)

Modifies the local parameter in the first direction of this CATSurParam.

Parameters:

iPatchNumberU: The new parameter value.

o SetLocalParamV

public INLINE void SetLocalParamV( double iLocalParamV)

Modifies the local parameter in the second direction of this CATSurParam.

Parameters:

iPatchNumberV: The new parameter value.

o SetParam

public void SetParam(	double	`iGlobalParameterU`,
	double	`iGlobalParameterV`)

Modifies the global parameters.

Parameters:

iGlobalParameterU: The new value of the parameter in the first direction of the surface.
iGlobalParameterV: The new value of the parameter in the second direction of the surface.

o SetParam

public void SetParam( const CATSurParam& iCopiedSurParam)

Affects a CATSurParam.

Parameters:

iCopiedSurParam: The surface parameter to copy.

o SetParam

public void SetParam(	double	`iLambdaU`,
	double	`iLambdaV`,
	const CATSurLimits&	`iBoxUV`)

Modifies this CATSurParam with a barycentric method on a CATSurLimits.
Check before that the CATSurLimits is not empty.
This allows to reach each parameter of the rectangle defined by to points. this becomes the following parameter:
((1-iLambdaU)*iP1(U) + iLambdaU*iP2(U),(1-iLambdaV)*iP1(V) + iLambdaV*iP2(V))

Parameters:

iLamdaU: The weigth used on the first U direction.
iLamdaV: The weigth used on the second V direction.
iBoxUV: The limits of parameters {(iP1(U),iP1(V)),(iP2(U),iP2(V))}.

o SetParam

public void SetParam(	double	`iLambdaU`,
	double	`iLambdaV`,
	const CATSurParam&	`iP1`,
	const CATSurParam&	`iP2`)

Modifies this CATSurParam with a barycentric method on two CATSurParams.
This allows to reach each parameter of the rectangle defined by to points. this becomes the following parameter:
((1-iLambdaU)*iP1(U) + iLambdaU*iP2(U),(1-iLambdaV)*iP1(V) + iLambdaV*iP2(V))

Parameters:

iLamdaU: The weigth used on the first U direction.
iLamdaV: The weigth used on the second V direction.
iP1: The fisrt CATSurParam (iP1(U),iP1(V)).
iP2: The second CATSurParam (iP2(U),iP2(V)).

o SetParamU

public void SetParamU( double iGlobalParamU)

Modifies the global parameter in the first direction of this CATSurParam.

Parameters:

iGlobalParamU: The new parameter value.

o SetParamV

public void SetParamV( double iGlobalParamV)

Modifies the global parameter in the second direction of this CATSurParam.

Parameters:

iGlobalParamU: The new parameter value.

o SetPatchNumberU

public INLINE void SetPatchNumberU( CATLONG32 iPatchNumberU)

Modifies the patch number in the first direction of this CATSurParam.

Parameters:

iPatchNumberU: The new patch number.

o SetPatchNumberV

public INLINE void SetPatchNumberV( CATLONG32 iPatchNumberV)

Modifies the patch number in the second direction of this CATSurParam.

Parameters:

iPatchNumberV: The new patch number.

o SquareDistanceTo

public double SquareDistanceTo( const CATSurParam& iOtherParam) const

Returns the square distance to another CATSurParam.

Parameters:

iOtherParam: The other parameter.

o operator !=

public CATLONG32 operator !=( const CATSurParam& iSurParamToCompare) const

Inequality operator.
Let nu=iP.GetPatchNumberU, pu=iP.GetLocalParamU nv=iP.GetPatchNumberV, pv=iP.GetLocalParamV (iP1 != iP2)<=>( nu1 != nu2 or pu1 != pu2 or nv1 != nv2 or pv1 != pv2)

o operator *

public CATSurParam operator *( const CATMathTransformation2D& iTransfo2D) const

Move a CATSurParam with a CATMathTransformation2D.

o operator +

public CATSurParam operator +( const CATMathVector2D& iGlobalVector) const

Addition operator.

Returns:: The CATSurParam whose global parameters are the sum of the corresponding global parameters of the CATSurParam and the CATMathVector2D and whose surface reference is the CATSurParam one.

o operator +=

public void operator +=( const CATMathVector2D& iGlobalVector)

Addition assignment operator.

o operator -

public CATMathVector2D operator -( const CATSurParam& iOtherParam) const

Subtraction operator.

Returns:: The CATSurParam whose global parameters are the difference of the corresponding global parameters of the two CATSurParams and whose surface reference is the first CATSurParam one.

o operator ==

public CATLONG32 operator ==( const CATSurParam& iSurParamToCompare) const

Equality operator.
Let nu=iP.GetPatchNumberU, pu=iP.GetLocalParamU nv=iP.GetPatchNumberV, pv=iP.GetLocalParamV (iP1 == iP2)<=>( nu1 == nu2 and pu1 == pu2 and nv1 == nv2 and pv1 == pv2)

This object is included in the file: CATSurParam.h
If needed, your Imakefile.mk should include the module: CATGeometricObjects

GeometricObjects writeClassCharacteristic(); class CATSurParam

Constructor and Destructor Index

Method Index

Constructor and Destructor

Methods

GeometricObjects class CATSurParam