All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GSMInterfaces Interface CATIGSMCircleCenterAxis

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

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


interface CATIGSMCircleCenterAxis

Interface to circle feature defined by a center and an axis.
Role: Allows you to acess data of circle feature created from the center and axis/line specified.

See also:
CATIGSMFactory.CreateCircle


Method Index


o GetAxis(CATISpecObject_var&)
Gets the axis.
o GetDiameter(CATICkeParm_var&)
Gets the diameter of the circle.
o GetDiameterMode(CATBoolean&)
Gets DiameterMode.
o GetPoint(CATISpecObject_var&)
Gets the point.
o GetProjectionMode(CATBoolean&)
Gets ProjectionMode.
o GetRadius(CATICkeParm_var&)
Gets the radius of the circle.
o SetAxis(CATISpecObject_var)
Sets the axis.
o SetDiameter(CATICkeParm_var)
Sets DiameterMode to TRUE and then sets the diameter.
o SetDiameterMode(CATBoolean)
Sets DiameterMode.
o SetPoint(CATISpecObject_var)
Sets the point.
o SetProjectionMode(CATBoolean)
Sets ProjectionMode.
o SetRadius(CATICkeParm_var)
Sets DiameterMode to FALSE and then sets the radius.

Methods


o GetAxis
public virtual HRESULT GetAxis(CATISpecObject_var& ohAxis) = 0
Gets the axis.
Parameters:
ohAxis
Axis of plane in which circle is lying
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 GetPoint
public virtual HRESULT GetPoint(CATISpecObject_var& ohPoint) = 0
Gets the point.
Parameters:
ohPoint
Element used for center computation
o GetProjectionMode
public virtual HRESULT GetProjectionMode(CATBoolean& oProjection) = 0
Gets ProjectionMode.
ProjectionMode = TRUE (default) implies point will be projected on to axis/line,
ProjectionMode = FALSE implies that point will be center of the circle.
Parameters:
oProjection
Projection Mode
o GetRadius
public virtual HRESULT GetRadius(CATICkeParm_var& ohRadius) = 0
Gets the radius of the circle.
Note: Succeeds only if DiameterMode is set to FALSE
Parameters:
ohRadius
radius
o SetAxis
public virtual HRESULT SetAxis( const CATISpecObject_var ihAxis) = 0
Sets the axis.
Parameters:
ihAxis
Axis of plane in which circle is lying
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 SetPoint
public virtual HRESULT SetPoint( const CATISpecObject_var ihPoint) = 0
Sets the point.
Parameters:
ihPoint
Element used for center computation
o SetProjectionMode
public virtual HRESULT SetProjectionMode( const CATBoolean iProjection) = 0
Sets ProjectionMode.
ProjectionMode = TRUE (default) implies point will be projected on to axis/line,
ProjectionMode = FALSE implies that point will be center of the circle.
Parameters:
iProjection
Projection Mode
o SetRadius
public virtual HRESULT SetRadius( const CATICkeParm_var ihRadius) = 0
Sets DiameterMode to FALSE and then sets the radius.
Parameters:
ihRadius
radius

This object is included in the file: CATIGSMCircleCenterAxis.h
If needed, your Imakefile.mk should include the module: CATGitInterfaces

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