CATGSMUseItf Interface CATIGSMUseCircle

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

interface CATIGSMUseCircle

Method Index


o GetAngles(CATICkeParm_var&,CATICkeParm_var&)
Gets the start and end angles.
o GetAxis(int,CATIMmiMechanicalFeature_var&)
Returns the axis created.
o GetAxisComputationMode(CATBoolean&)
Gets the axis computation Mode.
o GetCenter(CATMathPoint&)
Gets the mathematical center of the circle.
o GetCircleType(int&)
Gets the circle type.
o GetDirection(CATIGSMUseDirection_var&)
Returns the direction if specified at the time of creation of axes.
o GetLimitation(CATIGSMUseCircleLimitation&)
Gets the limitation type for the circle (see CATIGSMUseCircleLimitation enumeration).
o GetRadius(CATPositiveLength&)
Gets the radius of the circle.
o GetReferenceDirection(CATMathDirection&)
Gets the the reference direction for angles calculation of the circle.
o SetAngles(CATICkeParm_var,CATICkeParm_var)
Sets the start and end angles.
o SetAxisComputationMode(CATBoolean)
Sets the axis computation Mode.
o SetCircleType(int,CATListValCATIMmiMechanicalFeature_var*,int*)
Sets the circle type.
o SetDirection(CATIGSMUseDirection_var)
Sets the direction for axis computation.
o SetLimitation(CATIGSMUseCircleLimitation)
Sets the limitation type for the circle (see CATIGSMUseCircleLimitation enumeration).

Enumerated Type Index


o CATIGSMUseCircleLimitation
different kinds of circle limitation :

Methods


o GetAngles
public virtual HRESULT GetAngles(CATICkeParm_var& oStart,
CATICkeParm_var& iEnd) = 0
Gets the start and end angles. Angles are used only when limitation type is "Angles"
Parameters:
oStart
start length
oEnd
end length
o GetAxis
public virtual HRESULT GetAxis( const int iRank,
CATIMmiMechanicalFeature_var& oElem)= 0
Returns the axis created. the axis with following "Axis Type" are generated.
Parameters:
iRank
3 - CATGSMAxisLineType_NormalToCircle 2 - CATGSMAxisLineType_NormalToDirection 1 - CATGSMAxisLineType_AlignedWithDirection
oElem
Axis
o GetAxisComputationMode
public virtual HRESULT GetAxisComputationMode(CATBoolean& oMode) = 0
Gets the axis computation Mode.
Parameters:
oMode
Boolean value indicating the axis computation mode.
o GetCenter
public virtual HRESULT GetCenter(CATMathPoint& oCenter) = 0
Gets the mathematical center of the circle. This information is available once the circle has been computed. If return integer is 1, the center is not available
Parameters:
oCenter
circle center
o GetCircleType
public virtual HRESULT GetCircleType(int& oT) = 0
Gets the circle type.
Parameters:
oT
Type of circle
o GetDirection
public virtual HRESULT GetDirection(CATIGSMUseDirection_var& ohDir) = 0
Returns the direction if specified at the time of creation of axes.
o GetLimitation
public virtual HRESULT GetLimitation(CATIGSMUseCircleLimitation& oLimit) = 0
Gets the limitation type for the circle (see CATIGSMUseCircleLimitation enumeration).
Parameters:
oLimit
circle limitation
o GetRadius
public virtual HRESULT GetRadius(CATPositiveLength& oRadius) = 0
Gets the radius of the circle. This information is available once the circle has been computed. If return integer is 1, the center is not available
Parameters:
oRadius
circle radius
o GetReferenceDirection
public virtual HRESULT GetReferenceDirection(CATMathDirection& oDirection) = 0
Gets the the reference direction for angles calculation of the circle. This information is available once the circle has been computed. If return integer is 1, the center is not available
Parameters:
oDirection
direction
o SetAngles
public virtual HRESULT SetAngles( const CATICkeParm_var iStart,
const CATICkeParm_var iEnd) = 0
Sets the start and end angles. Angles are used only when limitation type is "Angles".
Parameters:
iStart
start length
iEnd
end length
o SetAxisComputationMode
public virtual HRESULT SetAxisComputationMode( const CATBoolean iMode) = 0
Sets the axis computation Mode.
Parameters:
iMode
TRUE - Computes the axis, FALSE - removes the axes.
o SetCircleType
public virtual HRESULT SetCircleType(int iType,
CATListValCATIMmiMechanicalFeature_var* iElems= NULL,
int* iReportedSpecPositionTab= NULL) = 0
Sets the circle type.
Parameters:
iType
The new feature type
iElems
The list of specs to prepare for report to new feature
iReportedSpecPositionTab
Array containing for each feature the position in the new feature attributes structure.
Example : iReportedSpecPositionTab[0] = 2,
means that the first feature of iElems list (iElems[1]) has the second position in the new feature, according to the replace acceptance (a point can only be replaced by a point, for instance).
if iReportedSpecPositionTab[i]=0 the replace for ith element could not be done.
Array has to be allocated by calling method.
See also:
CATIGSMUseFactory.CreateCircleType
o SetDirection
public virtual HRESULT SetDirection( const CATIGSMUseDirection_var ihDir) = 0
Sets the direction for axis computation. When direction is specified, the axis with following "Axis Type" are generated. CATGSMAxisLineType_NormalToDirection CATGSMAxisLineType_AlignedWithDirection For generation of axis the axis computation mode must be set to TRUE.
o SetLimitation
public virtual HRESULT SetLimitation( const CATIGSMUseCircleLimitation iLimit) = 0
Sets the limitation type for the circle (see CATIGSMUseCircleLimitation enumeration).
Parameters:
iLimit
Type of Plane enum CATIGSMUseCircleLimitation {Angles, Whole ,Trimmed , Complementary = 3};

Enumerated Types


o CATIGSMUseCircleLimitation 
enum CATIGSMUseCircleLimitation {
  Angles,
  Whole,
  Trimmed,
  Complementary
}
different kinds of circle limitation :
Parameters:
Angles
The circle is limited by given angles.
This option is only available for center/radius and center/point circles.
Whole
The circle is entire.
Trimmed
The circle is trimmed by points
(only when there are at least 2 passing points defining the circle)
Complementary
This is the complementary circle of the previous one.
This object is included in the file: CATIGSMUseCircle.h
If needed, your Imakefile.mk should include the module: CATGSMUseItf

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.