GeometricObjects CATCrvParam
Usage: you must use this class as is. You should never derive it.
public class CATCrvParam
Class representing the global parameter of a point on a CATCurve.
The value of
the global parameter is defined as the following way:
Let be a curve with two arcs. On the first arc, the local parameter goes
from 0 to L1 > 0; on the second arc, the local parameter
goes from 0 to L2 > 0. Let be a point of local parameter
L on the second arc of the curve.
The global parameter associated to this point is
L1 + L. The local parameters are managed by the geometric
elements. The first and last arc number are given by
the CATCurve::GetMaxLimits method.
Note that you also can create CATCrvParams by using the
CreateParam method of the CATCurve interface.
- See also:
-
Constructor and Destructor Index
- o
CATCrvParam(CATCrvParam&)
- Copy constructor.
- o
CATCrvParam(double,CATCrvLimits&)
-
- o
CATCrvParam(double,CATCrvLimits&)
- Constructs the parameter corresponding to a fraction of
the length of this CATCurve.
- o
CATCrvParam(double,CATCrvParam&,CATCrvParam&)
-
- o
CATCrvParam(double,CATCrvParam&,CATCrvParam&)
- Constructs the iP1 + iLambda * (iP2-iP1) parameter.
Method Index
- o
GetArcNumber()
- Returns the arc number of the CATCrvParam on this CATCurve.
- o
GetLocalParam()
- Returns the local parameter value of the CATCrvParam on this CATCurve.
- o
GetParam()
- Returns the value of the CATCrvParam on this CATCurve.
- o
SetArcNumber(CATLONG32)
-
- o
SetArcNumber(CATLONG32)
- Modifies the arc number of this CATCrvParam.
- o
SetLocalParam(double)
-
- o
SetLocalParam(double)
- Modifies the local parameter of this CATCrvParam.
- o
SetParam(double)
- Modifies the value of a CATCrvParam.
- o
SetParam(CATCrvParam&)
- Affects the data of another CATCrvParam.
- o
SetParam(double,CATCrvLimits&)
- Affects the parameter of a fraction of a trimmed CATCurve.
- o
SetParam(double,CATCrvParam&,CATCrvParam&)
- Affects the iP1 + iLambda (iP2-iP1) parameter.
- o
operator !=(CATCrvParam&)
- Inequality operator.
- o
operator >(CATCrvParam&)
- Greater-than operator.
- o
operator >=(CATCrvParam&)
- Greater-than or equal operator.
- o
operator <(CATCrvParam&)
- Less-than operator.
- o
operator <=(CATCrvParam&)
- Less-than or equal operator.
- o
operator *(CATMathTransformation1D&)
- Moves a CATCrvParam with a CATMathTransformation1D.
- o
operator +=(double)
- Addition assignment operator.
- o
operator ==(CATCrvParam&)
- Equality operator.
- o
operator-(CATCrvParam&)
- Subtraction operator.
Constructor and Destructor
o CATCrvParam
| public CATCrvParam( | const | iCrvParamToCopy) |
-
Copy constructor.
o CATCrvParam
| public CATCrvParam( | | iLambda, |
| const | iLimits) |
-
o CATCrvParam
| public CATCrvParam( | | iLambda, |
| const | iLimits) |
-
Constructs the parameter corresponding to a fraction of
the length of this CATCurve.
- Parameters:
-
- iLambda
- The fraction of the curve.
- iLimits
- The limits to take into account.
- Returns:
- The global parameter associated with this CATCurve referenced by
iLimits, of value
iStartLimit + iLambda *(iEndLimit-iStartLimit).
o CATCrvParam
| public CATCrvParam( | | iLambda, |
| const | iP1, |
| const | iP2) |
-
o CATCrvParam
| public CATCrvParam( | | iLambda, |
| const | iP1, |
| const | iP2) |
-
Constructs the iP1 + iLambda * (iP2-iP1) parameter.
The created CATCrvParam has the reference of iP1.
- Parameters:
-
- iLambda
- The barycentric coefficient.
- iP1
- The first parameter.
- iP2
- The second parameter.
Methods
o GetArcNumber
-
Returns the arc number of the CATCrvParam on this CATCurve.
- Returns:
- The arc number.
o GetLocalParam
-
Returns the local parameter value of the CATCrvParam on this CATCurve.
The local parameter.
o GetParam
-
Returns the value of the CATCrvParam on this CATCurve.
- Parameters:
-
- The
- parameter value.
o SetArcNumber
| public SetArcNumber( | | iNewArcNumber) |
-
o SetArcNumber
| public SetArcNumber( | | iNewArcNumber) |
-
Modifies the arc number of this CATCrvParam.
The associated parameter remains the same.
- Parameters:
-
- The
- new arc number. To have the beginning and end arc, use CATCurve::GetMaxLimits.
o SetLocalParam
| public SetLocalParam( | | iLobalParam) |
-
o SetLocalParam
| public SetLocalParam( | | iLobalParam) |
-
Modifies the local parameter of this CATCrvParam.
The associated arc number remains the same.
- Parameters:
-
- iLocalParam
- The new value of the local parameter.
o SetParam
| public SetParam( | | iGlobalParmeter) |
-
Modifies the value of a CATCrvParam.
Performances will be better if you use the affectation operator =.
- Parameters:
-
- iGlobalParameter
- The new value of the global parameter.
o SetParam
| public SetParam( | const | iParamToCopy) |
-
Affects the data of another CATCrvParam.
- Parameters:
-
- iParamToCopy
- The values to copy (parameter and reference).
o SetParam
| public SetParam( | | iLambda, |
| const | iLimits) |
-
Affects the parameter of a fraction of a trimmed CATCurve.
this becomes the global parameter associated with the CATCurve referenced by
iLimits, of value
iStartLimit + iLambda *(iEndLimit-iStartLimit).
- Parameters:
-
- iLambda
- The fraction of the curve.
- iLimits
- The limits to take into account.
o SetParam
| public SetParam( | | iLambda, |
| const | iP1, |
| const | iP2) |
-
Affects the iP1 + iLambda (iP2-iP1) parameter.
*
this CATCrvParam has the reference of iP1.
- Parameters:
-
- iLambda
- The barycentric coefficient.
- iP1
- The first parameter.
- iP2
- The seond parameter.
o operator !=
| public operator !=( | const | iOtherParam) |
-
Inequality operator.
Let n=iP.GetArcNumber, p=iP.GetLocalParam
(iP1 != iP2)<=>( n1 != n2 or p1 != p2)
o operator >
| public operator >( | const | iOtherParam) |
-
Greater-than operator.
Let n=iP.GetArcNumber, p=iP.GetLocalParam
(iP1 > iP2)<=>( (n1 > n2) or (n1 == n2 and p1 > p2)
o operator >=
| public operator >=( | const | iOtherParam) |
-
Greater-than or equal operator.
Let n=iP.GetArcNumber, p=iP.GetLocalParam
(iP1 >= iP2)<=>( (n1 > n2) or (n1 == n2 and p1 >= p2)
o operator <
| public operator <( | const | iOtherParam) |
-
Less-than operator.
Let n=iP.GetArcNumber, p=iP.GetLocalParam
(iP1 < iP2)<=>( (n1 < n2) or (n1 == n2 and p1 < p2)
o operator <=
| public operator <=( | const | iOtherParam) |
-
Less-than or equal operator.
Let n=iP.GetArcNumber, p=iP.GetLocalParam
(iP1 <= iP2)<=>( (n1 < n2) or (n1 == n2 and p1 <= p2)
o operator *
| public operator *( | const | iTransfo1D) |
-
Moves a CATCrvParam with a CATMathTransformation1D.
o operator +=
| public operator +=( | | iGlobalParamToAdd) |
-
Addition assignment operator.
o operator ==
| public operator ==( | const | iOtherParam) |
-
Equality operator.
Let n=iP.GetArcNumber, p=iP.GetLocalParam
(iP1 == iP2)<=>( n1 == n2 and p1 == p2)
o operator-
| public operator-( | const | iParamToSubstrct) |
-
Subtraction operator.
- Returns:
- The value of the difference of two global parameters.
This object is included in the file: CATCrvParam.h
If needed, your Imakefile.mk should include the module: CATGeometricObjects
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.