CATGSMUseItf Interface CATIGSMUseConic
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMUseConic
Conic Curve.
Role: Allows to access data of the Conic feature created by using
five feature that can be points, tangents or one parameter. There is
always two extremity points and a planar support.
- See also:
-
Method Index
- o
CheckConicParameterValue(CATIMmiMechanicalFeature_var,CATMathVector&,CATMathVector&,CATIMmiMechanicalFeature_var,CATIMmiMechanicalFeature_var,double&,double&,int&)
- Check conic parametrer value.
- o
CheckPoint(CATIMmiMechanicalFeature_var,CATIMmiMechanicalFeature_var,int&,CATIMmiMechanicalFeature_var,CATIMmiMechanicalFeature_var)
- Checks the validity of a Conic Passing point.
- o
CheckStartAndEndTangentDirections(CATIMmiMechanicalFeature_var,CATMathVector&,CATMathVector&,CATIMmiMechanicalFeature_var,CATIMmiMechanicalFeature_var,CATICkeParm_var,CATIMmiMechanicalFeature_var,int&)
- Checks the validity and provides a status of the tangent directions at the start and end points.
- o
GetConicParm(double&)
- Gets the Conic Parameter value ( As a Double ).
- o
GetConicParm(CATICkeParm_var&)
- Gets the Conic Parameter ( As a literal ).
- o
GetConicUserTol(CATICkeParm_var&)
- Gets the Conic User Tolerance.
- o
GetDefParabol(int&)
- Get the requirement for default Parabolic Result
- o
GetDirectionVector(CATIGSMUseDirection_var&,int,CATMathVector&)
- Gets the Direction vector that corresponds to the Direction specifications.
- o
GetEndCst(CATIGSMUseCurveCst_var&)
- Gets the End Constraint Point of the Conic Curve.
- o
GetGSMConicType(CATGSMConicType&)
- Gets the Type of the Conic Curve.
- o
GetIntermediateCst(CATIGSMUseCurveCst_var&,int)
- Gets the Intermediate CSt at Position Pos (1<= Pos <=3 ).
- o
GetPassingPoint(int,CATIMmiMechanicalFeature_var&)
- Gets a Conic Passing Point.
- o
GetStartCst(CATIGSMUseCurveCst_var&)
- Gets the Starting Constraint Point of the Conic Curve.
- o
GetSupport(CATIMmiMechanicalFeature_var&)
- Gets the Support Plane of the Conic Curve.
- o
GetTangentDirectionAtPassingPoint(int,CATIGSMUseDirection_var&,int&)
- Gets the Tangent direction specifactions at a conic passing Point.
- o
GetTgtIntPoint(CATIMmiMechanicalFeature_var&)
- Gets the Tangent Intersection Point.
- o
GetUniquePointIndexWhereTangentIsSet(CATGSMConicType,int&)
- Gets the Unique Point index where a tangent constraint is set.
- o
SetConicParm(double)
- Sets the Conic Parameter.
- o
SetConicParm(CATICkeParm_var)
- Sets the Conic Parameter.
- o
SetConicUserTol(CATICkeParm_var)
- Sets the Conic User Tolerance.
- o
SetDefParabol(int&)
- Set the requirement for default Parabolic Result
- o
SetEndCst(CATIGSMUseCurveCst_var)
- Sets the End Constraint Point of the Conic Curve.
- o
SetIntermediateCst(CATIGSMUseCurveCst_var,int)
- Sets the Intermediate Conic CSt at Position Pos (1<= Pos <=3 ).
- o
SetStartCst(CATIGSMUseCurveCst_var)
- Sets the Starting Constraint Point of the Conic Curve.
- o
SetSupport(CATIMmiMechanicalFeature_var)
- Sets the Support Plane of the Conic Curve.
- o
SetTgtIntPoint(CATIMmiMechanicalFeature_var)
- Sets the Tangent Intersection Point.
Methods
o CheckConicParameterValue
| public virtual CheckConicParameterValue( | const | iPtTgtInt, |
| const | iStartMDir, |
| const | iEndMDir, |
| const | iStartPoint, |
| const | iStartEnd, |
| | iConicParmValue, |
| | oConicParmResol, |
| | ostatus) |
-
Check conic parametrer value.
- Parameters:
-
- iPtTgtInt
- Tangent Intersection Point
( Note : Can be NULL if iStartMDir and EndMDir are specified)
- iStartMDir
- Explicit specification of the Tangent Direction at the Start Point
- iEndMDir
- Explicit specification of the Tangent Direction at the End Point
- iStartPoint
- Conic curve Start Point
- iEndPoint
- Conic curve End Point
- iConicParmValue
- Conic Parameter specification
- iConicParmResol
- Conic Resolution
- iPassingPoint
- Any Intermediate Pasing point of the conic curve (must differs from the start point or the end point)
- ostatus
- Output status about conic parameter value
ostatus = ...
Implements a function from an interface.
- See also:
-
o CheckPoint
| public virtual CheckPoint( | const | iPoint, |
| const | iSupportPlane, |
| | oStatus, |
| const | iStartPoint | = NULL_var, |
| const | iEndPoint | = NULL_var ) |
-
Checks the validity of a Conic Passing point.
- Parameters:
-
- iPoint
- Passing Point to check
- iSupportPlane
- Support Plane of the Conic curve
- iStartPoint
- if specified, StartPoint of the conic curve
- iEndPoint
- if specified, End Point of the conic curve
- oStatus
- = -1 if the method failed to analyse
= 0 Point is OK
= 1 Point to check is not set in the support Plane
= 2 Point to check is aligned with the Start and End Points (makes
sense if iStartPoint and iEndPoint were set)
- See also:
-
o CheckStartAndEndTangentDirections
| public virtual CheckStartAndEndTangentDirections( | const | iPtTgtInt, |
| const | iStartMDir, |
| const | iEndMDir, |
| const | iStartPoint, |
| const | iEndPoint, |
| const | iConicParm, |
| const | iPassingPoint, |
| | ostatus) |
-
Checks the validity and provides a status of the tangent directions at the start and end points.
- Parameters:
-
- iPtTgtInt
- Tangent Intersection Point
( Note : Can be NULL if iStartMDir and EndMDir are specified)
It specifies the tangents directions as the intersections of the line (iStartPoint, iPtTgtInt) with
the line (iEndPoint,iPtTgtInt)
- iStartMDir
- Explicit specification of the Tangent Direction at the Start Point
- iEndMDir
- Explicit specification of the Tangent Direction at the End Point
- iStartPoint
- Conic curve Start Point
- iEndPoint
- Conic curve End Point
- iConicParm
- Conic Parameter specification
- iPassingPoint
- Any Intermediate Pasing point of the conic curve (must differs from the start point or the end point)
- ostatus
- Output status about the start and end tangent orientations
ostatus = 0: The start and end tangent directions intersect themselves and are
correctly oriented according to the conic curve orientation from
StartPoint to EndPoint
ostatus = 1: the 2 tangents intersect themselves : only starting tangent has to be inverted
ostatus = 2: the 2 tangents intersect themselves : only ending tangent has to be inverted
ostatus = 3: the 2 tTangents intersect themselves : both tangentes has to be inverted
ostatus = 10: the 2 tangents are parallel and correctly oriented
ostatus = 11: the 2 tangents are parallel : only starting tangent has to be inverted
ostatus = 12: the 2 tangents are parallel : only ending tangent has to be inverted
ostatus = 13: the 2 tangents are parallel : both tangentes has to be inverted
ostatus = -10: the 2 tangents are parallel and are detected not valid
ostatus = -1 : Input specifications are incomplete in order to perform tangent direction checks
o GetConicParm
| public virtual GetConicParm( | | oConicParm) |
-
Gets the Conic Parameter value ( As a Double ).
- Parameters:
-
- oConicParm
o GetConicParm
| public virtual GetConicParm( | | oConicParm) |
-
Gets the Conic Parameter ( As a literal ).
- Parameters:
-
- oConicParm
-
- See also:
-
o GetConicUserTol
| public virtual GetConicUserTol( | | oConicUserTol) |
-
Gets the Conic User Tolerance.
- Parameters:
-
- oConicUserTol
-
- See also:
-
o GetDefParabol
| public virtual GetDefParabol( | | oDefParabol) |
-
Get the requirement for default Parabolic Result
- Parameters:
-
- oDefParabol
- oDefParabol = 1, for default parabolic behaviour
oDefParabol = 0, for behvaiour obtained as in V4.
o GetDirectionVector
| public virtual GetDirectionVector( | const | iTgtDir, |
| const | iInvertDirFlag, |
| | oMDir) |
-
Gets the Direction vector that corresponds to the Direction specifications.
- Parameters:
-
- iTgtDir
- CATIGSMUse Direction specification
- iInvertDirFlag
- Flag value must be set to -1 to reverse the CATIGSMUse Direction specification.
- oMDir
- CATMathVector Direction
o GetEndCst
| public virtual GetEndCst( | | oEndCst) |
-
Gets the End Constraint Point of the Conic Curve.
- Parameters:
-
- oEndCst
-
- See also:
-
o GetGSMConicType
| public virtual GetGSMConicType( | | oType) |
-
Gets the Type of the Conic Curve.
- Parameters:
-
- oType
-
- oPointIndexWhereTangentIsSet
- = 1 if Tangent is set at the Conic Start point location
= 2 if Tangent is set at the second Conic point location
= 3 if Tangent is set at the third Conic point location
= 4 if Tangent is set at the Conic end point location
(makes sense only for the Conic curve type "TwoIntermediatePassingPointsPlusOneTangent")
o GetIntermediateCst
| public virtual GetIntermediateCst( | | oInterCst, |
| | Pos) |
-
Gets the Intermediate CSt at Position Pos (1<= Pos <=3 ).
- Parameters:
-
- oInterCst
-
- See also:
-
o GetPassingPoint
| public virtual GetPassingPoint( | | iPointNumber, |
| | oSpecPt) |
-
Gets a Conic Passing Point.
- Parameters:
-
- iPointNumber
- Order Number ( From 1 to 5 ) of the Point to get
iPointNumber = 1 must be set to retrieve the Start Point
iPointNumber = 5 must be set to retrieve the End Point
iPointNumber = 2, 3, or 4 must be set to retrieve
respectively the first,second, third intermediate passing point
- oSpecPt
- Retrieved Passing Point
o GetStartCst
| public virtual GetStartCst( | | oStartCst) |
-
Gets the Starting Constraint Point of the Conic Curve.
- Parameters:
-
- oStartCst
-
- See also:
-
o GetSupport
| public virtual GetSupport( | | oSupport) |
-
Gets the Support Plane of the Conic Curve.
- Parameters:
-
- oSupport
-
- See also:
-
o GetTangentDirectionAtPassingPoint
| public virtual GetTangentDirectionAtPassingPoint( | | iPointNumber, |
| | oTgtDir, |
| | oInvertDirFlag) |
-
Gets the Tangent direction specifactions at a conic passing Point.
- Parameters:
-
- iPointNumber
- Order Number ( From 1 to 5 ) of the Point to get:
iPointNumber = 1 must be set to retrieve the Start Point
iPointNumber = 5 must be set to retrieve the End Point
iPointNumber = 2, 3, or 4 must be set to retrieve
respectively the first,second, third intermediate passing point
- oTgtDir
- Retrieved CATIGSMUse Direction specification
- oInvertDirFlag
- Flag value must be set to -1 to reverse the CATIGSMUse Direction specification
o GetTgtIntPoint
| public virtual GetTgtIntPoint( | | oTgtIntPt) |
-
Gets the Tangent Intersection Point.
- Parameters:
-
- oTgtIntPt
-
- See also:
-
o GetUniquePointIndexWhereTangentIsSet
| public virtual GetUniquePointIndexWhereTangentIsSet( | | iType, |
| | oPointIndexWhereTangentIsSet) |
-
Gets the Unique Point index where a tangent constraint is set.
- Parameters:
-
- iType
-
- oPointIndexWhereTangentIsSet
- = 1 if Tangent is set at the Conic Start point location
= 2 if Tangent is set at the second Conic point location
= 3 if Tangent is set at the third Conic point location
= 4 if Tangent is set at the Conic end point location
(makes sense only for the Conic curve type "TwoIntermediatePassingPointsPlusOneTangent")
o SetConicParm
| public virtual SetConicParm( | const | iConicParm) |
-
Sets the Conic Parameter.
- Parameters:
-
- iConicParm
- ( As a Double )
o SetConicParm
| public virtual SetConicParm( | const | iConicParm) |
-
Sets the Conic Parameter.
- Parameters:
-
- iConicParm
-
- See also:
-
o SetConicUserTol
| public virtual SetConicUserTol( | const | iConicTol) |
-
Sets the Conic User Tolerance.
- Parameters:
-
- iConicTol
-
- See also:
-
o SetDefParabol
| public virtual SetDefParabol( | const | iDefParabol) |
-
Set the requirement for default Parabolic Result
- Parameters:
-
- iDefParabol
- iDefParabol = 1, for default parabolic behaviour
iDefParabol = 0, for behvaiour obtained as in V4.
o SetEndCst
| public virtual SetEndCst( | const | iEndCst) |
-
Sets the End Constraint Point of the Conic Curve.
- Parameters:
-
- iStartCst
-
- See also:
-
o SetIntermediateCst
| public virtual SetIntermediateCst( | const | iInterCst, |
| | iPos) |
-
Sets the Intermediate Conic CSt at Position Pos (1<= Pos <=3 ).
- Parameters:
-
- iInterCst
-
- iPos
-
- See also:
-
o SetStartCst
| public virtual SetStartCst( | const | iStartCst) |
-
Sets the Starting Constraint Point of the Conic Curve.
- Parameters:
-
- iStartCst
-
- See also:
-
o SetSupport
| public virtual SetSupport( | const | iSupport) |
-
Sets the Support Plane of the Conic Curve.
- Parameters:
-
- iSupport
-
- See also:
-
o SetTgtIntPoint
| public virtual SetTgtIntPoint( | const | iTgtIntPt) |
-
Sets the Tangent Intersection Point.
- Parameters:
-
- iTgtIntPt
-
- See also:
-
This object is included in the file: CATIGSMUseConic.h
If needed, your Imakefile.mk should include the module: CATGSMUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.