All Frameworks Class Hierarchy This Framework Previous Next Indexes
SketcherInterfaces Interface CATI2DEllipse
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---SketcherInterfaces.IDMEllipse2D
|
+---CATI2DEllipse
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATI2DEllipse
2D Ellipse definition.
Role: This interface describes the ellipse in 2D space. Its methods
provide access to the ellipse's parameters, which fully describe the ellipse.
Method Index
- o
GetCenter(int)
- Returns the ellipse's center.
- o
SetCenter(CATI2DPoint_var&)
- Defines the ellipse's center.
- o
SetEllipseData(double*,double*,double)
- Defines the ellipse's parameters.
Methods
o GetCenter
-
Returns the ellipse's center.
- Parameters:
-
- iGenerate
- [in] Optional parameter which force center point creation if it does not exists.
- Returns:
- CATI2DPoint_var A handler on the returned center point.
o SetCenter
-
Defines the ellipse's center.
- Parameters:
-
- iPoint
- [in] A handler on the point to define as center.
- Returns:
- CATI2DConstraint_var A handler on the 2D constraint which links the center point and the ellipse (concentricity).
o SetEllipseData
public virtual HRESULT SetEllipseData( | const double* | iPoint, |
| const double* | iMajorAxis, |
| double | iMinorMajorRatio) = 0 |
-
Defines the ellipse's parameters.
- Parameters:
-
- iPoint
- [in] The centre point of the ellipse.
- iMajorAxis
- [in] The ellipse orientation as a 2D vector. The length of the vector is the major radius.
- iMinorMajorRatio
- [in] The ratio of the length of the minor axis over the major axis.
- Returns:
- HRESULT
This object is included in the file: CATI2DEllipse.h
If needed, your Imakefile.mk should include the module: CATSketcherInterfaces