All Frameworks Class Hierarchy This Framework Previous Next Indexes
GeometricObjects Class CATCrvLimits
CATCrvLimits
Usage: you must use this class as is. You should never derive it.
public class CATCrvLimits
Class representing the limitations of a CATCurve.
The CATCrvLimits contains the two arc numbers and two local parameters
on these arcs of the limiting points.
The CATCrvLimits defines a closed interval. It can be empty (if
the high limit is smaller than the low one, or if some of them
is not defined): in this case, it does not contain any point.
- See also:
- CATCurve, CATCrvParam
Constructor and Destructor Index
- o
CATCrvLimits()
- Constructs an empty CATCrvLimits.
- o
CATCrvLimits(CATCrvLimits&)
- Copy Constructor.
- o
CATCrvLimits(CATCrvParam&,CATCrvParam&,CATVerificationMode)
- Constructs a CATCrvLimits from two CATCrvParams.
Method Index
- o
AddInside(CATCrvLimits&)
- Replaces this CATCrvLimits by its union with another CATCrvLimits.
- o
AddInside(CATCrvParam&)
- Replaces this by a CATCrvLimits that also contains a given CATCrvParam.
- o
AddInside(double)
- Replaces this by a CATCrvLimits that also contains a given global parameter.
- o
DistanceTo(CATCrvParam&)
- Returns the distance of a parameter to the nearest point of this CATCrvLimits.
- o
GetEquivalentLimits(CATCrvLimits&,CATCrvLimits&,CATCrvLimits&)
- Retrieves the CATCrvLimits having the same relative positioning
to this CATCrvLimits than iRefLim in iRefAll.
- o
GetEquivalentLimits(CATSurLimits&,CATSurLimits&,CATIsoParameter,CATCrvLimits&)
- Retrieves the CATCrvLimits having the same relative position
to this CATSurLimits than iRefPart in an isoparametric curve of RefAll.
- o
GetEquivalentParam(CATCrvLimits&,CATCrvParam&,CATCrvParam&)
- Retrieves the global parameter having the same relative position
to this CATCrvLimits than iRefParam in iRefAll.
- o
GetEquivalentParam(CATSurLimits&,CATSurParam&,CATIsoParameter,CATCrvParam&)
- Retrieves the global parameter having the same relative position
to this CATSurLimits than iRefPart in an isoparametric curve of iRefAll.
- o
GetExtremities(CATCrvParam&,CATCrvParam&)
- Retrieves the two CATCrvParam delimiting this CATCrvLimits.
- o
GetExtremities(double&,double&)
- Retrieves the extremities of a 1D box corresponding to the global parameters of this
CATCrvLimits.
- o
GetHigh(CATCrvParam&)
- Retrieves the high CATCrvParam of this CATCrvLimits.
- o
GetHighArcNumber()
- Returns the arc number of the high limit of this CATCrvLimits.
- o
GetHighLocalParam()
- Returns the local parameter of the high limit of this CATCrvLimits.
- o
GetHighParam()
- Returns the global parameter of the high limit of this CATCrvLimits.
- o
GetLocalExtremities(double&,double&,CATLONG32&,CATLONG32&)
- Retrieves the extremities of a 1D box corresponding to the global parameters of this
CATCrvLimits.
- o
GetLow(CATCrvParam&)
- Retrieves the low limitation of this CATCrvLimits.
- o
GetLowArcNumber()
- Returns the arc number of the low limit of this CATCrvLimits.
- o
GetLowLocalParam()
- Returns the local parameter of the low limit of this CATCrvLimits.
- o
GetLowParam()
- Returns the global parameter of the low limit of this CATCrvLimits.
- o
IsContaining(CATCrvLimits&)
- Use preferably the signature which takes as an input argument the tolerance.
- o
IsContaining(CATCrvLimits&,double)
- Tests whether this CATCrvLimits is including another CATCrvLimits.
- o
IsContaining(CATCrvParam&)
- Use preferably the signature which takes as an input argument the tolerance.
- o
IsContaining(CATCrvParam&,double)
- Tests whether this CATCrvParam is inside a CATCrvLimits at a given tolerance.
- o
IsEmpty()
- Tests whether this CATCrvLimits is empty.
- o
IsIntersecting(CATCrvLimits&)
- Tests whether this CATCrvLimits is intersecting another one.
- o
SetHigh(CATCrvParam&)
- Modifies the high CATCrvParam of this CATCrvLimits.
- o
SetLow(CATCrvParam&)
- Modifies the low CATCrvParam of this CATCrvLimits.
- o
SetToEmpty()
- Sets this CATCrvLimits to an empty one.
- o
SetToIntersection(CATCrvLimits&,CATCrvLimits&)
- Replaces this CATCrvLimits by the intersection of two other one.
- o
SetToUnion(CATCrvLimits&,CATCrvLimits&)
- Replaces this CATCrvLimits by the union of two other one.
- o
operator !=(CATCrvLimits&)
- Inequality operator.
- o
operator ==(CATCrvLimits&)
- Equality operator.
Constructor and Destructor
o CATCrvLimits
-
Constructs an empty CATCrvLimits.
o CATCrvLimits
-
Copy Constructor.
o CATCrvLimits
-
Constructs a CATCrvLimits from two CATCrvParams.
- Parameters:
-
- iLowParam
- The first limitation of the curve.
- iHighParam
- The last limitation of the curve.
- iMode
- Only use with the default value.
Methods
o AddInside
-
Replaces this CATCrvLimits by its union with another CATCrvLimits.
- Parameters:
-
- iLimits
- The limitations to union with this
o AddInside
-
Replaces this by a CATCrvLimits that also contains a given CATCrvParam.
- Parameters:
-
- iParam
- The parameter to take into account.
o AddInside
public void AddInside( | double | iGlobalParam) |
-
Replaces this by a CATCrvLimits that also contains a given global parameter.
- Parameters:
-
- iGlobalParam
- The parameter value to take into account.
o DistanceTo
-
Returns the distance of a parameter to the nearest point of this CATCrvLimits.
Check before that the CATCrvLimits is not empty.
- Parameters:
-
- iParam
- The parameter of the point.
- Returns:
- The distance between iParam and the nearest point of this.
o GetEquivalentLimits
-
Retrieves the CATCrvLimits having the same relative positioning
to this CATCrvLimits than iRefLim in iRefAll.
- Parameters:
-
- iRefAll
- The reference CATCrvLimits of global parameters (A1,A2).
- iRefLim
- The compared CATCrvLimits of global parameters (B1,B2).
- ioResultLimit
- The resulting CATCrvLimits of global parameters (R1,R2)
such that (with (T1,T2) the global
parameters of this):
(R1-T1)*(A2-A1) = (B1-A1)*(T2-T1)
(R2-T1)*(A2-A1) = (B2-A1)*(T2-T1)
o GetEquivalentLimits
-
Retrieves the CATCrvLimits having the same relative position
to this CATSurLimits than iRefPart in an isoparametric curve of RefAll.
Same as above for the two extreme parameters of the CATCrvLimits.
- Parameters:
-
- iRefAll
- The limits of a CATSurface.
- iRefPart
- The limits on iRefAll.
- iIsoParameter
- The direction of the isoparameter (IsoParameterU or
IsoParameterV). On this direction, iRefPoint has a global
parameter of value B and the isoparameter line passing
through this point has (A1,A2) limits.
- ioResultLimit
- The limit of extremal parameters defined in the following manner:
global parameter of value R verifying the equation
(with (T1,T2) the global parameters of this):
(R-T1)*(A2-A1) = (B-A1)*(T2-T1)
o GetEquivalentParam
-
Retrieves the global parameter having the same relative position
to this CATCrvLimits than iRefParam in iRefAll.
- Parameters:
-
- iRefAll
- The reference CATCrvLimits of global parameters (A1,A2).
- iRefParam
- The compared CATCrvParam of global parameters (B1,B2).
- ioResultParam
- The resulting CATCrvParam of global parameters R
verifying the following equation (with (T1,T2) the global
parameters of this):
(R1-T1)*(A2-A1) = (B1-A1)*(T2-T1)
o GetEquivalentParam
-
Retrieves the global parameter having the same relative position
to this CATSurLimits than iRefPart in an isoparametric curve of iRefAll.
- Parameters:
-
- iRefAll
- The limits of a CATSurface.
- iRefPoint
- The global parameter of a point on iRefAll.
- iIsoParameter
- The direction of the isoparameter (IsoParameterU or
IsoParameterV). On this direction, iRefPoint has a global
parameter of value B and the isoparameter line passing
through this point has (A1,A2) limits.
- ioResultParam
- The global parameter R verifying the following equation
(with (T1,T2) the global parameters of this):
(R-T1)*(A2-A1) = (B-A1)*(T2-T1)
o GetExtremities
-
Retrieves the two CATCrvParam delimiting this CATCrvLimits.
Check before that the CATCrvLimits is not empty.
- Parameters:
-
- ioLowParam
- The first limitation of the curve.
- ioHighParam
- The last limitation of the curve.
o GetExtremities
public void GetExtremities( | double& | ioGlobalLow, |
| double& | ioGlobalHigh) const |
-
Retrieves the extremities of a 1D box corresponding to the global parameters of this
CATCrvLimits.
Check before that the CATCrvLimits is not empty.
- Parameters:
-
- ioGlobalLow
- The global parameter value of the first limitation of the curve.
- ioGlobalHigh
- The global parameter value of the last limitation of the curve.
o GetHigh
-
Retrieves the high CATCrvParam of this CATCrvLimits.
Check before that the CATCrvLimits is not empty.
- Parameters:
-
- ioHighParam
- The last limitation of the curve.
o GetHighArcNumber
-
Returns the arc number of the high limit of this CATCrvLimits.
Check before that the CATCrvLimits is not empty.
- Returns:
- The arc number of the last limitation.
o GetHighLocalParam
-
Returns the local parameter of the high limit of this CATCrvLimits.
Check before that the CATCrvLimits is not empty.
- Returns:
- The local parameter (on the arc) of the last limitation.
o GetHighParam
public double GetHighParam( | )const |
-
Returns the global parameter of the high limit of this CATCrvLimits.
Check before that the CATCrvLimits is not empty.
- Returns:
- The parameter value of the last limitation.
o GetLocalExtremities
public void GetLocalExtremities( | double& | ioLocalLow, |
| double& | ioLocalHigh, |
| CATLONG32& | ioLowPartNumber, |
| CATLONG32& | ioHighPartNumber) const |
-
Retrieves the extremities of a 1D box corresponding to the global parameters of this
CATCrvLimits.
Check before that the CATCrvLimits is not empty.
- Parameters:
-
- ioLocalLow
- The local parameter value of the first limitation of the curve.
- ioLocalHigh
- The local parameter value of the last limitation of the curve.
- ioLowPartNumber
- The arc number of the first limitation of the curve.
- ioHighPartNumber
- The arc number of the last limitation of the curve.
o GetLow
-
Retrieves the low limitation of this CATCrvLimits.
Check before that the CATCrvLimits is not empty.
- Parameters:
-
- ioLowParam
- The first limitation of the curve.
o GetLowArcNumber
-
Returns the arc number of the low limit of this CATCrvLimits.
Check before that the CATCrvLimits is not empty.
- Returns:
- The arc number of the first limitation.
o GetLowLocalParam
-
Returns the local parameter of the low limit of this CATCrvLimits.
Check before that the CATCrvLimits is not empty.
- Returns:
- The local parameter (on the arc) of the first limitation.
o GetLowParam
public double GetLowParam( | )const |
-
Returns the global parameter of the low limit of this CATCrvLimits.
Check before that the CATCrvLimits is not empty.
- Returns:
- The parameter value of the first limitation.
o IsContaining
-
Use preferably the signature which takes as an input argument the tolerance.
Tests whether this CATCrvParam is inside a CATCrvLimits.
- Parameters:
-
- iParamToCompare
- The parameter to take into account.
- iTol
- The tolerance for the test.
- Returns:
- The result of the test.
Legal values:
- 0
- if the CATCrvLimits does not contain the
CATCrvParam.
- 1
- if the CATCrvLimits contains the CATCrvParam.
o IsContaining
-
Tests whether this CATCrvLimits is including another CATCrvLimits.
- Parameters:
-
- iOtherBox
- The limitationa to take into account.
- iTol
- The tolerance for the test.
- Returns:
- The result of the test.
Legal values:
- 0
- if the CATCrvLimits is not containing
iOtherBox.
- 1
- if the CATCrvLimits is containing
iOtherBox.
o IsContaining
-
Use preferably the signature which takes as an input argument the tolerance.
Tests whether this CATCrvParam is inside a CATCrvLimits.
- Parameters:
-
- iParamToCompare
- The parameter to take into account.
- Returns:
- The result of the test.
Legal values:
- 0
- if the CATCrvLimits does not contain the
CATCrvParam.
- 1
- if the CATCrvLimits contains the CATCrvParam.
o IsContaining
-
Tests whether this CATCrvParam is inside a CATCrvLimits at a given tolerance.
- Parameters:
-
- iParamToCompare
- The parameter to take into account.
- iTol
- The tolerance for the test.
- Returns:
- The result of the test.
Legal values:
- 0
- if the CATCrvLimits does not contain the
CATCrvParam.
- 1
- if the CATCrvLimits contains the CATCrvParam.
o IsEmpty
-
Tests whether this CATCrvLimits is empty.
- Returns:
- The result of the test.
Legal values:
- 0
- if it is not empty.
- 1
- if it is empty.
o IsIntersecting
-
Tests whether this CATCrvLimits is intersecting another one.
- Parameters:
-
- iBoxToCompare
- The limitations to compare with >tt.
- Returns:
- The result of the test.
Legal values:
- 0
- if there is no intersection.
- 1
- if there is an intersection (this is also the case
when there is just a point in common).
o SetHigh
-
Modifies the high CATCrvParam of this CATCrvLimits.
Check before that iHighParam is higher than iLowParam.
- Parameters:
-
- oHighParam
- The last limitation of the curve.
o SetLow
-
Modifies the low CATCrvParam of this CATCrvLimits.
Check before that iLowParam is lower than iHighParam.
- Parameters:
-
- iLowParam
- The first limitation of the curve.
o SetToEmpty
public INLINE void SetToEmpty( | ) |
-
Sets this CATCrvLimits to an empty one.
o SetToIntersection
-
Replaces this CATCrvLimits by the intersection of two other one.
The result can be an empty CATCrvLimits.
- Parameters:
-
- iLimits1
- The first limitation to operate.
- iLimits21
- The second limitation to operate.
o SetToUnion
-
Replaces this CATCrvLimits by the union of two other one.
this is replaced by the CATCrvLimits of low limit the lowest limit of the two CATCrvlimits and
of high limit the highest limit, even the two CATCrvLimits are not
intersecting each other.
- Parameters:
-
- iLimits1
- The first limitation to operate.
- iLimits21
- The second limitation to operate.
o operator !=
-
Inequality operator.
( Lim1 != Lim2 ) <=> (Lim1.GetLowParam != Lim2GetLowParam) or
(Lim1.GetHighParam != Lim2.GetHighParam)
o operator ==
-
Equality operator.
( Lim1 == Lim2 ) <=> (Lim1.GetLowParam == Lim2GetLowParam) and
(Lim1.GetHighParam == Lim2.GetHighParam)
This object is included in the file: CATCrvLimits.h
If needed, your Imakefile.mk should include the module: CATCGMGeoMath