All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GSMInterfaces Interface CATIGSMCircleCtrRad

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIGSMCircleCtrRad
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIGSMCircleCtrRad

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:
CATIGSMFactory.CreateCircle


Method Index


o GetCenter(CATISpecObject_var&)
Gets the circle center.
o GetDiameter(CATICkeParm_var&)
Gets the diameter of the circle.
o GetDiameterMode(CATBoolean&)
Gets DiameterMode.
o GetFirstDirection(CATIGSMDirection_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(CATISpecObject_var&)
Gets the support surface.
o IsGeodesic(CATBoolean&)
Queries whether the circle is geodesic or not.
o SetCenter(CATISpecObject_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(CATIGSMDirection_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(CATISpecObject_var)
Sets the support surface.
o UnsetGeodesic()
Inactivates geodesic circle.

Methods


o GetCenter
public virtual HRESULT GetCenter(CATISpecObject_var& oCenter) = 0
Gets the circle center.
Parameters:
oCenter
center 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
public virtual HRESULT GetDiameterMode(CATBoolean& oDiameterMode) = 0
Gets DiameterMode.
DiameterMode = FALSE implies radius (default),
DiameterMode = TRUE implies diameter
Parameters:
oDiameterMode
Diameter Mode
o GetFirstDirection
public virtual HRESULT GetFirstDirection(CATIGSMDirection_var& oElem) = 0
Gets the first direction.
The direction is used as angle reference.
Parameters:
oElem
first direction
See also:
CATIGSMDirection
o GetRadius
public virtual HRESULT GetRadius(CATICkeParm_var& oRadius) = 0
Gets the circle radius.
Note: Succeeds only if DiameterMode is set to FALSE
Parameters:
oRadius
radius positive value
o GetSecondDirection
public virtual HRESULT GetSecondDirection(CATMathDirection& oDir) = 0
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:
CATMathDirection
o GetSupport
public virtual HRESULT GetSupport(CATISpecObject_var& oSupport) = 0
Gets the support surface.
Parameters:
oSupport
the support surface
o IsGeodesic
public virtual HRESULT IsGeodesic(CATBoolean& oGeodesic) = 0
Queries whether the circle is geodesic or not.
Parameters:
oGeodesic
geodesic flag (TRUE)
o SetCenter
public virtual HRESULT SetCenter( const CATISpecObject_var iCenter) = 0
Sets the circle center.
Parameters:
iCenter
center point
o SetDiameter
public virtual HRESULT SetDiameter( const CATICkeParm_var ihDiameter) = 0
Sets DiameterMode to TRUE and then sets the diameter.
Parameters:
ihDiameter
diameter
o SetDiameterMode
public virtual HRESULT SetDiameterMode( const CATBoolean iDiameterMode) = 0
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 HRESULT SetFirstDirection( const CATIGSMDirection_var iElem) = 0
Sets the first direction.
The direction is used as angle reference.
Parameters:
iElem
first direction
See also:
CATIGSMDirection
o SetGeodesic
public virtual HRESULT SetGeodesic()= 0
Sets the circle on the surface (Geodesic mode).
o SetRadius
public virtual HRESULT SetRadius( const CATICkeParm_var iRadius) = 0
Sets DiameterMode to FALSE and then sets the radius.
Parameters:
iRadius
radius
o SetSecondDirection
public virtual HRESULT SetSecondDirection( const CATMathDirection& iDir) = 0
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:
CATMathDirection
o SetSupport
public virtual HRESULT SetSupport( const CATISpecObject_var iSupport) = 0
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: CATIGSMCircleCtrRad.h
If needed, your Imakefile.mk should include the module: CATGitInterfaces

Copyright © 2003, Dassault Systèmes. All rights reserved.