All Frameworks Class Hierarchy This Framework Previous Next Indexes
GSMInterfaces Interface CATIGSMCircle
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIGSMCircle
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMCircle
Interface to circle feature.
Role: To set/change the type of the circle.
Circle types :
Legal values :
CirclePtRad = 0
CircleCtrPt = 1
Circle2Pts = 2
Circle3Pts = 3
CircleBitgtRad = 4
CircleBitgtPt = 5
CircleTritgt = 6
CircleExplicit = 30
Method Index
- o
GetAngles(CATICkeParm_var&,CATICkeParm_var&)
- Gets the start and end angles.
- o
GetAxis(int,CATISpecObject_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(CATIGSMDirection_var&)
- Returns the direction if specified at the time of creation of axes.
- o
GetLimitation(CATIGSMCircleLimitation&)
- Gets the limitation type for the circle (see CATIGSMCircleLimitation 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
SetDirection(CATIGSMDirection_var)
- Sets the direction for axis computation.
- o
SetLimitation(CATIGSMCircleLimitation)
- Sets the limitation type for the circle (see CATIGSMCircleLimitation enumeration).
Enumerated Type Index
- o
CATIGSMCircleLimitation
- 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, |
| CATISpecObject_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
-
Gets the axis computation Mode.
- Parameters:
-
- oMode
- Boolean value indicating the axis computation mode.
o GetCenter
-
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( | CATIGSMDirection_var& | ohDir) = 0 |
-
Returns the direction if specified at the time of creation of axes.
o GetLimitation
public virtual HRESULT GetLimitation( | CATIGSMCircleLimitation& | oLimit) = 0 |
-
Gets the limitation type for the circle (see CATIGSMCircleLimitation enumeration).
- Parameters:
-
- oLimit
- circle limitation
o GetRadius
-
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
-
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
-
Sets the start and end angles.
Angles are used only when limitation type is "Angles".
- Parameters:
-
- iStart
- start length
- iEnd
- end length
o SetAxisComputationMode
-
Sets the axis computation Mode.
- Parameters:
-
- iMode
- TRUE - Computes the axis, FALSE - removes the axes.
o SetDirection
-
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 CATIGSMCircleLimitation | iLimit) = 0 |
-
Sets the limitation type for the circle (see CATIGSMCircleLimitation enumeration).
- Parameters:
-
- iLimit
- Type of Plane
enum CATIGSMCircleLimitation {Angles, Whole ,Trimmed , Complementary = 3};
Enumerated Types
o CATIGSMCircleLimitation
-
enum CATIGSMCircleLimitation {
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: CATIGSMCircle.h
If needed, your Imakefile.mk should include the module: CATGitInterfaces