All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATSketcherUseItf Interface CATISktUse2DEllipse

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

interface CATISktUse2DEllipse

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(CATISktUse2DPoint_var&): Defines the ellipse's center.
o SetEllipseData(double*,double*,double): Defines the ellipse's parameters.

Methods

o GetCenter

public virtual GetCenter( iGenerate =1)

Returns the ellipse's center.

Parameters:

iGenerate: [in] Optional parameter which force center point creation if it does not exists.

Returns:

CATISktUse2DPoint_var A handler on the returned center point.

o SetCenter

public virtual SetCenter( const iPoint)

Defines the ellipse's center.

Parameters:

iPoint: [in] A handler on the point to define as center.

Returns:

CATISktUse2DConstraint_var A handler on the 2D constraint which links the center point and the ellipse (concentricity).

o SetEllipseData

public virtual SetEllipseData(	const	`iPoint`,
	const	`iMajorAxis`,
		`iMinorMajorRatio`)

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: CATISktUse2DEllipse.h
If needed, your Imakefile.mk should include the module: CATSketcherUseItf