CATGSMUseItf Interface CATIGSMUseCircle2PointsRad
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMUseCircle2PointsRad
Interface to circle feature passing by two point with a given radius.
Role: Allows you to access data of the circle feature created by using
two passing points and a radius.
- See also:
-
Method Index
- o
GetDiameter(CATICkeParm_var&)
- Gets the diameter of the circle.
- o
GetDiameterMode(CATBoolean&)
- Gets DiameterMode.
- o
GetFirstPoint(CATIMmiMechanicalFeature_var&)
- Gets the first passing point.
- o
GetOrientation(CATGSMOrientation&)
- Gets the circle orientation.
- o
GetRadius(CATICkeParm_var&)
- Gets the circle radius.
- o
GetSecondPoint(CATIMmiMechanicalFeature_var&)
- Gets the second passing point.
- o
GetSupport(CATIMmiMechanicalFeature_var&)
- Gets the support surface.
- o
InvertOrientation()
- Inverts the circle orientation.
- o
IsGeodesic(CATBoolean&)
- Queries whether the circle is geodesic or not.
- o
SetDiameter(CATICkeParm_var)
- Sets DiameterMode to TRUE and then sets the diameter.
- o
SetDiameterMode(CATBoolean)
- Sets DiameterMode.
- o
SetFirstPoint(CATIMmiMechanicalFeature_var)
- Sets the first passing point.
- o
SetGeodesic()
- Sets geodesic circle.
- o
SetOrientation(CATGSMOrientation)
- Sets the circle orientation.
- o
SetRadius(CATICkeParm_var)
- Sets DiameterMode to FALSE and then sets the radius.
- o
SetSecondPoint(CATIMmiMechanicalFeature_var)
- Sets the second passing point.
- o
SetSupport(CATIMmiMechanicalFeature_var)
- Sets the support surface.
- o
UnsetGeodesic()
- Inactivates geodesic circle.
Methods
o GetDiameter
| public virtual GetDiameter( | | ohDiameter) |
-
Gets the diameter of the circle. 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 GetFirstPoint
| public virtual GetFirstPoint( | | oFirstPoint) |
-
Gets the first passing point.
- Parameters:
-
- oFirsPoint
- first point
o GetOrientation
| public virtual GetOrientation( | | oOrientation) |
-
Gets the circle orientation.
Defines the side where circle is computed using the cross product of
the direction of line between the 2 passing points and normal direction of the plane.
- Parameters:
-
- oOrientation
- orientation
o GetRadius
| public virtual GetRadius( | | oRadius) |
-
Gets the circle radius. Succeeds only if DiameterMode is set to FALSE
- Parameters:
-
- oRadius
- circle radius
o GetSecondPoint
| public virtual GetSecondPoint( | | oSecondPoint) |
-
Gets the second passing point.
- Parameters:
-
- oSecondPoint
- second point
o GetSupport
| public virtual GetSupport( | | oSupport) |
-
Gets the support surface.
- Parameters:
-
- oSupport
- the support surface
o InvertOrientation
| public virtual InvertOrientation( | ) |
-
Inverts the circle orientation.
o IsGeodesic
| public virtual IsGeodesic( | | oGeod) |
-
Queries whether the circle is geodesic or not.
- Parameters:
-
- oGeod
- geodesic type : when TRUE, the circle is geodesic.
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. When DiameterMode is changed, Radius/Diameter value,
which is stored will not be modified.
- Parameters:
-
- iDiameterMode
- Diameter Mode
o SetFirstPoint
| public virtual SetFirstPoint( | const | iFirstPoint) |
-
Sets the first passing point.
- Parameters:
-
- iFirsPoint
- first point
o SetGeodesic
| public virtual SetGeodesic( | ) |
-
Sets geodesic circle.
It puts the circle on the surface.
S_OK if OK, E_FAIL if fail
o SetOrientation
| public virtual SetOrientation( | const | iOrientation) |
-
Sets the circle orientation.
Defines the side where circle is computed using the cross product of
the direction of line between the 2 passing points and normal direction of the plane.
- Parameters:
-
- iOrientation
- orientation
o SetRadius
| public virtual SetRadius( | const | iRadius) |
-
Sets DiameterMode to FALSE and then sets the radius.
- Parameters:
-
- iRadius
- radius
o SetSecondPoint
| public virtual SetSecondPoint( | const | iSecondPoint) |
-
Sets the second passing point.
- Parameters:
-
- iSecondPoint
- second point
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: CATIGSMUseCircle2PointsRad.h
If needed, your Imakefile.mk should include the module: CATGSMUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.