All Frameworks Class Hierarchy This Framework Previous Next Indexes
GSMInterfaces Interface CATIGSMCircle2PointsRad
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIGSMCircle2PointsRad
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMCircle2PointsRad
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:
- CATIGSMFactory.CreateCircle
Method Index
- o
GetDiameter(CATICkeParm_var&)
- Gets the diameter of the circle.
- o
GetDiameterMode(CATBoolean&)
- Gets DiameterMode.
- o
GetFirstPoint(CATISpecObject_var&)
- Gets the first passing point.
- o
GetOrientation(CATGSMOrientation&)
- Gets the circle orientation.
- o
GetRadius(CATICkeParm_var&)
- Gets the circle radius.
- o
GetSecondPoint(CATISpecObject_var&)
- Gets the second passing point.
- o
GetSupport(CATISpecObject_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(CATISpecObject_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(CATISpecObject_var)
- Sets the second passing point.
- o
SetSupport(CATISpecObject_var)
- Sets the support surface.
- o
UnsetGeodesic()
- Inactivates geodesic circle.
Methods
o GetDiameter
public virtual HRESULT GetDiameter( | CATICkeParm_var& | ohDiameter) = 0 |
-
Gets the diameter of the circle. 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 GetFirstPoint
public virtual HRESULT GetFirstPoint( | CATISpecObject_var& | oFirstPoint) = 0 |
-
Gets the first passing point.
- Parameters:
-
- oFirsPoint
- first point
o GetOrientation
-
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 HRESULT GetRadius( | CATICkeParm_var& | oRadius) = 0 |
-
Gets the circle radius. Succeeds only if DiameterMode is set to FALSE
- Parameters:
-
- oRadius
- circle radius
o GetSecondPoint
public virtual HRESULT GetSecondPoint( | CATISpecObject_var& | oSecondPoint) = 0 |
-
Gets the second passing point.
- Parameters:
-
- oSecondPoint
- second point
o GetSupport
public virtual HRESULT GetSupport( | CATISpecObject_var& | oSupport) = 0 |
-
Gets the support surface.
- Parameters:
-
- oSupport
- the support surface
o InvertOrientation
public virtual HRESULT InvertOrientation( | )= 0 |
-
Inverts the circle orientation.
o IsGeodesic
-
Queries whether the circle is geodesic or not.
- Parameters:
-
- oGeod
- geodesic type : when TRUE, the circle is geodesic.
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. When DiameterMode is changed, Radius/Diameter value,
which is stored will not be modified.
- Parameters:
-
- iDiameterMode
- Diameter Mode
o SetFirstPoint
-
Sets the first passing point.
- Parameters:
-
- iFirsPoint
- first point
o SetGeodesic
public virtual HRESULT SetGeodesic( | )= 0 |
-
Sets geodesic circle.
It puts the circle on the surface.
S_OK if OK, E_FAIL if fail
o SetOrientation
-
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
-
Sets DiameterMode to FALSE and then sets the radius.
- Parameters:
-
- iRadius
- radius
o SetSecondPoint
-
Sets the second passing point.
- Parameters:
-
- iSecondPoint
- second point
o SetSupport
-
Sets the support surface.
- Parameters:
-
- iSupport
- the support surface
o UnsetGeodesic
public virtual HRESULT UnsetGeodesic( | )= 0 |
-
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: CATIGSMCircle2PointsRad.h
If needed, your Imakefile.mk should include the module: CATGitInterfaces