CATGSMUseItf Interface CATIGSMUseCircleCtrRad
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMUseCircleCtrRad
Interface to circle feature defined by a center and a radius.
Role: Allows you to access data of the circle feature created by using
its center and a radius.
- See also:
-
Method Index
- o
GetCenter(CATIMmiMechanicalFeature_var&)
- Gets the circle center.
- o
GetDiameter(CATICkeParm_var&)
- Gets the diameter of the circle.
- o
GetDiameterMode(CATBoolean&)
- Gets DiameterMode.
- o
GetFirstDirection(CATIGSMUseDirection_var&)
- Gets the first direction.
- o
GetRadius(CATICkeParm_var&)
- Gets the circle radius.
- o
GetSecondDirection(CATMathDirection&)
- Gets the second direction on the plane to compute the point (for stability).
- o
GetSupport(CATIMmiMechanicalFeature_var&)
- Gets the support surface.
- o
IsGeodesic(CATBoolean&)
- Queries whether the circle is geodesic or not.
- o
SetCenter(CATIMmiMechanicalFeature_var)
- Sets the circle center.
- o
SetDiameter(CATICkeParm_var)
- Sets DiameterMode to TRUE and then sets the diameter.
- o
SetDiameterMode(CATBoolean)
- Sets DiameterMode.
- o
SetFirstDirection(CATIGSMUseDirection_var)
- Sets the first direction.
- o
SetGeodesic()
- Sets the circle on the surface (Geodesic mode).
- o
SetRadius(CATICkeParm_var)
- Sets DiameterMode to FALSE and then sets the radius.
- o
SetSecondDirection(CATMathDirection&)
- Sets the second direction on the plane to compute the point (for stability).
- o
SetSupport(CATIMmiMechanicalFeature_var)
- Sets the support surface.
- o
UnsetGeodesic()
- Inactivates geodesic circle.
Methods
o GetCenter
| public virtual GetCenter( | | oCenter) |
-
Gets the circle center.
- Parameters:
-
- oCenter
- center point
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),
DiameterMode = TRUE implies diameter
- Parameters:
-
- oDiameterMode
- Diameter Mode
o GetFirstDirection
| public virtual GetFirstDirection( | | oElem) |
-
Gets the first direction.
The direction is used as angle reference.
- Parameters:
-
- oElem
- first direction
- See also:
-
o GetRadius
| public virtual GetRadius( | | oRadius) |
-
Gets the circle radius.
Note: Succeeds only if DiameterMode is set to FALSE
- Parameters:
-
- oRadius
- radius positive value
o GetSecondDirection
| public virtual GetSecondDirection( | | oDir) |
-
Gets the second direction on the plane to compute the point (for stability).
This direction has to be kept perpendicular to the first direction
- Parameters:
-
- oDir
- second direction
- See also:
-
o GetSupport
| public virtual GetSupport( | | oSupport) |
-
Gets the support surface.
- Parameters:
-
- oSupport
- the support surface
o IsGeodesic
| public virtual IsGeodesic( | | oGeodesic) |
-
Queries whether the circle is geodesic or not.
- Parameters:
-
- oGeodesic
- geodesic flag (TRUE)
o SetCenter
| public virtual SetCenter( | const | iCenter) |
-
Sets the circle center.
- Parameters:
-
- iCenter
- center point
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 SetFirstDirection
| public virtual SetFirstDirection( | const | iElem) |
-
Sets the first direction.
The direction is used as angle reference.
- Parameters:
-
- iElem
- first direction
- See also:
-
o SetGeodesic
| public virtual SetGeodesic( | ) |
-
Sets the circle on the surface (Geodesic mode).
o SetRadius
| public virtual SetRadius( | const | iRadius) |
-
Sets DiameterMode to FALSE and then sets the radius.
- Parameters:
-
- iRadius
- radius
o SetSecondDirection
| public virtual SetSecondDirection( | const | iDir) |
-
Sets the second direction on the plane to compute the point (for stability).
This direction has to be kept perpendicular to the first direction
- Parameters:
-
- iDir
- second direction
- See also:
-
o SetSupport
| public virtual SetSupport( | const | iSupport) |
-
Sets the support surface.
- Parameters:
-
- iSupport
- the support surface
o UnsetGeodesic
| public virtual UnsetGeodesic( | ) |
-
Inactivates geodesic circle.
Note: The circle becomes euclidean, and the surface is used to compute the circle axis.
This object is included in the file: CATIGSMUseCircleCtrRad.h
If needed, your Imakefile.mk should include the module: CATGSMUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.