CATGSMUseItf Interface CATIGSMUseCircleBitangentRadius
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMUseCircleBitangentRadius
Interface to circle tangent to two curves feature.
Role: Allows you to access data of the circle feature created to
be tangent to 2 curves with a given radius,
with respect to a support surface.
The curves can be degenerated into points.
- See also:
-
Method Index
- o
GetBeginOfCircle(int&)
- Gets the number of the beginning curve of the circle.
- o
GetDiameter(CATICkeParm_var&)
- Gets the diameter of the circle.
- o
GetDiameterMode(CATBoolean&)
- Gets DiameterMode.
- o
GetDiscriminationIndex(int&)
- Get the Index of the solution.
- o
GetFirstCurve(CATIMmiMechanicalFeature_var&)
- Gets the first element to which the circle will be tangent.
- o
GetFirstOrientation(CATGSMOrientation&)
- Gets the first curve orientation for circle computation.
- o
GetFirstTangentOrientation(CATGSMOrientation&)
- Gets the first tangent curve orientation for circle computation.
- o
GetPlaneNormal(CATMathVector&)
- Get the Normal of the plane created when the Support of the curve is not specified.
- o
GetRadius(CATICkeParm_var&)
- Gets the radius of the circle.
- o
GetSecondCurve(CATIMmiMechanicalFeature_var&)
- Gets the second element to which the circle will be tangent.
- o
GetSecondOrientation(CATGSMOrientation&)
- Gets the second curve orientation for circle computation.
- o
GetSecondTangentOrientation(CATGSMOrientation&)
- Gets the second tangent curve orientation for circle computation.
- o
GetSupport(CATIMmiMechanicalFeature_var&)
- Gets the support surface.
- o
GetTrimMode(CATGSMCornerTrimMode&)
- Queries whether reference curves are trimmed or not.
- o
InvertFirstOrientation()
- Inverts the first curve orientation for circle computation.
- o
InvertSecondOrientation()
- Inverts the second curve orientation for circle computation.
- o
SetBeginOfCircle(int)
- Sets the number of the beginning curve of the circle.
- o
SetDiameter(CATICkeParm_var)
- Sets DiameterMode to TRUE and then sets the diameter.
- o
SetDiameterMode(CATBoolean)
- Sets DiameterMode.
- o
SetDiscriminationIndex(int)
- Set the Index of the solution.
- o
SetFirstCurve(CATIMmiMechanicalFeature_var)
- Sets the first element to which the circle will be tangent.
- o
SetFirstOrientation(CATGSMOrientation)
- Sets the first curve orientation for circle computation.
- o
SetFirstTangentOrientation(CATGSMOrientation)
- Sets the first tangent curve orientation for circle computation.
- o
SetPlaneNormal(CATMathVector&)
- Set the Normal of the plane created when the Support of the curve is not specified.
- o
SetRadius(CATICkeParm_var)
- Sets DiameterMode to FALSE and then sets the radius.
- o
SetSecondCurve(CATIMmiMechanicalFeature_var)
- Sets the second element to which the circle will be tangent.
- o
SetSecondOrientation(CATGSMOrientation)
- Sets the second curve orientation for circle computation.
- o
SetSecondTangentOrientation(CATGSMOrientation)
- Sets the second tangent curve orientation for circle computation.
- o
SetSupport(CATIMmiMechanicalFeature_var)
- Sets the support surface.
- o
SetTrimMode(CATGSMCornerTrimMode)
- Sets the trim mode of the reference curves.
Methods
o GetBeginOfCircle
| public virtual GetBeginOfCircle( | | NumWire) |
-
Gets the number of the beginning curve of the circle.
This parameter is used to stabilize the resulting circle
o GetDiameter
| public virtual GetDiameter( | | ohDiameter) |
-
Gets the diameter of the circle.
Note: Succeeds only if DiameterMode is set to TRUE
- Parameters:
-
- ohDiameter
- diameter
o GetDiameterMode
| public virtual GetDiameterMode( | | oDiameterMode) |
-
Gets DiameterMode. DiameterMode = FALSE implies radius (default),
Note: DiameterMode = TRUE implies diameter
- Parameters:
-
- oDiameterMode
- Diameter Mode
o GetDiscriminationIndex
| public virtual GetDiscriminationIndex( | | oIndexSol) |
-
Get the Index of the solution.
Several resulting solutions produced by the operator can be same
oriented regarding to the input wire bodies.
In such a case, they are sorted in order to distinguish them.
The Sequence FirstOrientation - SecondOrientation - IndexSol
allows you to identifie a unique one-domain solution.
- Parameters:
-
- oIndexSol
- int oIndexSol
o GetFirstCurve
| public virtual GetFirstCurve( | | oFirstElem) |
-
Gets the first element to which the circle will be tangent.
- Parameters:
-
- oFirstElem
- first element : a curve or a point
o GetFirstOrientation
| public virtual GetFirstOrientation( | | oFirstOrient) |
-
Gets the first curve orientation for circle computation.
- Parameters:
-
- oFirstOrient
- first orientation
o GetFirstTangentOrientation
| public virtual GetFirstTangentOrientation( | | oFirstOrient) |
-
Gets the first tangent curve orientation for circle computation.
- Parameters:
-
- oFirstOrient
- first orientation
o GetPlaneNormal
| public virtual GetPlaneNormal( | | oNormal) |
-
Get the Normal of the plane created when the Support of the curve is not specified.
- Parameters:
-
- oNormal
- CATMathVector
o GetRadius
| public virtual GetRadius( | | oRadius) |
-
Gets the radius of the circle.
Note: Succeeds only if DiameterMode is set to FALSE
- Parameters:
-
- oRadius
- radius
o GetSecondCurve
| public virtual GetSecondCurve( | | oSecondElem) |
-
Gets the second element to which the circle will be tangent.
- Parameters:
-
- oSecondElem
- second element : a curve or a point
o GetSecondOrientation
| public virtual GetSecondOrientation( | | oSecondOrient) |
-
Gets the second curve orientation for circle computation.
- Parameters:
-
- oSecondOrient
- second orientation
o GetSecondTangentOrientation
| public virtual GetSecondTangentOrientation( | | oSecondOrient) |
-
Gets the second tangent curve orientation for circle computation.
- Parameters:
-
- oSecontOrient
- second orientation
o GetSupport
| public virtual GetSupport( | | oSupport) |
-
Gets the support surface.
- Parameters:
-
- oSupport
- support
o GetTrimMode
| public virtual GetTrimMode( | | oTrimMode) |
-
Queries whether reference curves are trimmed or not.
- Parameters:
-
- oTrimMode
-
- See also:
-
o InvertFirstOrientation
| public virtual InvertFirstOrientation( | ) |
-
Inverts the first curve orientation for circle computation.
o InvertSecondOrientation
| public virtual InvertSecondOrientation( | ) |
-
Inverts the second curve orientation for circle computation.
o SetBeginOfCircle
| public virtual SetBeginOfCircle( | | NumWire) |
-
Sets the number of the beginning curve of the circle.
This parameter is used to stabilize the resulting circle
o SetDiameter
| public virtual SetDiameter( | const | ihDiameter) |
-
Sets DiameterMode to TRUE and then sets the diameter.
- Parameters:
-
- ihDiameter
- diameter
o SetDiameterMode
| public virtual SetDiameterMode( | const | iDiameterMode) |
-
Sets DiameterMode.
DiameterMode = FALSE implies radius (default),
DiameterMode = TRUE implies diameter.
Note: When DiameterMode is changed, Radius/Diameter value which is stored will not be modified.
- Parameters:
-
- iDiameterMode
- Diameter Mode
o SetDiscriminationIndex
| public virtual SetDiscriminationIndex( | | iIndexSol) |
-
Set the Index of the solution.
Several resulting solutions produced by the operator can be same
oriented regarding to the input wire bodies.
In such a case, they are sorted in order to distinguish them.
The Sequence FirstOrientation - SecondOrientation - IndexSol
allows you to identifie a unique one-domain solution.
- Parameters:
-
- iIndexSol
- int iIndexSol
o SetFirstCurve
| public virtual SetFirstCurve( | const | iFirstElem) |
-
Sets the first element to which the circle will be tangent.
- Parameters:
-
- iFirstElem
- first element : a curve or a point
o SetFirstOrientation
| public virtual SetFirstOrientation( | const | iFirstOrient) |
-
Sets the first curve orientation for circle computation.
- Parameters:
-
- iFirstOrient
- first orientation
o SetFirstTangentOrientation
| public virtual SetFirstTangentOrientation( | const | iFirstOrient) |
-
Sets the first tangent curve orientation for circle computation.
- Parameters:
-
- iFirstOrient
- first orientation
o SetPlaneNormal
| public virtual SetPlaneNormal( | const | iNormal) |
-
Set the Normal of the plane created when the Support of the curve is not specified.
- Parameters:
-
- iNormal
- CATMathVector
o SetRadius
| public virtual SetRadius( | const | iRadius) |
-
Sets DiameterMode to FALSE and then sets the radius.
- Parameters:
-
- iRadius
- radius
o SetSecondCurve
| public virtual SetSecondCurve( | const | iSecondElem) |
-
Sets the second element to which the circle will be tangent.
- Parameters:
-
- iSecondElem
- second element : a curve or a point
o SetSecondOrientation
| public virtual SetSecondOrientation( | const | iSecondOrient) |
-
Sets the second curve orientation for circle computation.
- Parameters:
-
- iSecondOrient
- second orientation
o SetSecondTangentOrientation
| public virtual SetSecondTangentOrientation( | const | iSecondOrient) |
-
Sets the second tangent curve orientation for circle computation.
- Parameters:
-
- iSecondOrient
- second orientation
o SetSupport
| public virtual SetSupport( | const | iSupport) |
-
Sets the support surface.
- Parameters:
-
- iSupport
- support
o SetTrimMode
| public virtual SetTrimMode( | | iTrimMode) |
-
Sets the trim mode of the reference curves.
- Parameters:
-
- iTrimMode
-
- See also:
-
This object is included in the file: CATIGSMUseCircleBitangentRadius.h
If needed, your Imakefile.mk should include the module: CATGSMUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.