All Frameworks Class Hierarchy This Framework Previous Next Indexes
GSMInterfaces Interface CATIGSMCircleCenterTangent
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIGSMCircleCenterTangent
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMCircleCenterTangent
Interface to the circle center tngent feature.
Role: Allows you to access data of the circle center tangent feature.
This circle is defined by a point/curve center and tangent to a curve.
Several solution are provided and user has to choose the convinient one
It is created by using center element, a tangent curve and a support.
- See also:
- CATIGSMFactory.CreateTangentCircle
Method Index
- o
GetBeginOfCircle(int&)
- Gets the number of the beginning curve of the circle.
- o
GetCenterElem(CATISpecObject_var&)
- Gets the Center Element on which the center of circle lies or its a center itself.
- 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
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
GetSecondOrientation(CATGSMOrientation&)
- Gets the second curve orientation for circle computation.
- o
GetSecondTangentOrientation(CATGSMOrientation&)
- Gets the second tangent curve orientation for circle computation.
- o
GetSupport(CATISpecObject_var&)
- Gets the support surface.
- o
GetTangentCurve(CATISpecObject_var&)
- Gets the Tangent curve to which the circle will be tangent.
- 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
SetCenterElem(CATISpecObject_var)
- Sets the Center Elemnet on which the center of circle lies or its a center itself.
- 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
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
SetSecondOrientation(CATGSMOrientation)
- Sets the second curve orientation for circle computation.
- o
SetSecondTangentOrientation(CATGSMOrientation)
- Sets the second tangent curve orientation for circle computation.
- o
SetSupport(CATISpecObject_var)
- Sets the support surface.
- o
SetTangentCurve(CATISpecObject_var)
- Sets the Tangent Curve to which the circle will be tangent.
Methods
o GetBeginOfCircle
public virtual HRESULT GetBeginOfCircle( | int& | oNumWire) = 0 |
-
Gets the number of the beginning curve of the circle.
This parameter is used to stabilize the resulting circle.
o GetCenterElem
public virtual HRESULT GetCenterElem( | CATISpecObject_var& | oCenterElem) = 0 |
-
Gets the Center Element on which the center of circle lies or its a center itself.
- Parameters:
-
- oCenterElem
- Center Elem : a curve or a point
o GetDiameter
public virtual HRESULT GetDiameter( | CATICkeParm_var& | ohDiameter) = 0 |
-
Gets the diameter of the circle.
Note:Succeeds only if DiameterMode is set to TRUE
- Parameters:
-
- ohDiameter
- diameter
o GetDiameterMode
-
Gets DiameterMode.
DiameterMode = FALSE implies radius (default),
DiameterMode = TRUE implies diameter.
- Parameters:
-
- oDiameterMode
- Diameter Mode
o GetDiscriminationIndex
public virtual HRESULT GetDiscriminationIndex( | int& | oIndexSol) = 0 |
-
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 GetFirstOrientation
-
Gets the first curve orientation for circle computation.
- Parameters:
-
- oFirstOrient
- first orientation
o GetFirstTangentOrientation
-
Gets the first tangent curve orientation for circle computation.
- Parameters:
-
- oFirstOrient
- first orientation
o GetPlaneNormal
-
Get the Normal of the plane created when the Support of the curve is not specified.
- Parameters:
-
- oNormal
- CATMathVector
o GetRadius
public virtual HRESULT GetRadius( | CATICkeParm_var& | oRadius) = 0 |
-
Gets the radius of the circle.
Note: Succeeds only if DiameterMode is set to FALSE
- Parameters:
-
- oRadius
- radius
o GetSecondOrientation
-
Gets the second curve orientation for circle computation.
- Parameters:
-
- oSecondOrient
- second orientation
o GetSecondTangentOrientation
-
Gets the second tangent curve orientation for circle computation.
- Parameters:
-
- oSecontOrient
- second orientation
o GetSupport
public virtual HRESULT GetSupport( | CATISpecObject_var& | oSupport) = 0 |
-
Gets the support surface.
- Parameters:
-
- oSupport
- the support surface
o GetTangentCurve
public virtual HRESULT GetTangentCurve( | CATISpecObject_var& | oTangentCurve) = 0 |
-
Gets the Tangent curve to which the circle will be tangent.
- Parameters:
-
- oTangentCurve
- Tangent Curve
o InvertFirstOrientation
public virtual HRESULT InvertFirstOrientation( | )= 0 |
-
Inverts the first curve orientation for circle computation.
o InvertSecondOrientation
public virtual HRESULT InvertSecondOrientation( | )= 0 |
-
Inverts the second curve orientation for circle computation.
o SetBeginOfCircle
public virtual HRESULT SetBeginOfCircle( | int | iNumWire) = 0 |
-
Sets the number of the beginning curve of the circle.
This parameter is used to stabilize the resulting circle.
o SetCenterElem
-
Sets the Center Elemnet on which the center of circle lies or its a center itself.
- Parameters:
-
- iCenterElem
- Center Elem : a curve or a point
o SetDiameter
-
Sets DiameterMode to TRUE and then sets the diameter.
- Parameters:
-
- ihDiameter
- diameter
o SetDiameterMode
-
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 HRESULT SetDiscriminationIndex( | int | iIndexSol) = 0 |
-
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 SetFirstOrientation
-
Sets the first curve orientation for circle computation.
- Parameters:
-
- iFirstOrient
- first orientation
o SetFirstTangentOrientation
-
Sets the first tangent curve orientation for circle computation.
- Parameters:
-
- iFirstOrient
- first orientation
o SetPlaneNormal
-
Set the Normal of the plane created when the Support of the curve is not specified.
- Parameters:
-
- iNormal
- CATMathVector
o SetRadius
-
Sets DiameterMode to FALSE and then sets the radius.
- Parameters:
-
- iRadius
- radius
o SetSecondOrientation
-
Sets the second curve orientation for circle computation.
- Parameters:
-
- iSecondOrient
- second orientation
o SetSecondTangentOrientation
-
Sets the second tangent curve orientation for circle computation.
- Parameters:
-
- iSecondOrient
- second orientation
o SetSupport
-
Sets the support surface.
- Parameters:
-
- iSupport
- the support surface
o SetTangentCurve
-
Sets the Tangent Curve to which the circle will be tangent.
- Parameters:
-
- iTangentCurve
- Tangent Curve
This object is included in the file: CATIGSMCircleCenterTangent.h
If needed, your Imakefile.mk should include the module: CATGitInterfaces