All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATSketcherUseItf Interface CATISktUseSketchEditor

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

interface CATISktUseSketchEditor

The methods of this interface provide the client with the functionality for handling the sketch's geometry.
Role: This interface is used to manage the geometry with the variational constraint solver.

Method Index

o CloseEdition(int,int): Close edition.
o Evaluate(): Evaluation of geometric elements with respect to constraints.
o Evaluate(CATISktUse2DWFGeometry_var&): Geometry evaluation with a soft reference.
o Evaluate(CATLISTV(CATISktUse2DWFGeometry_var)&): Geometry evaluation with soft reference.
o InEdition(): Tells if edition is opened.
o OpenEdition(int): Open edition.
o ResetGroup(int): Reset the current group of geometric elements.
o SaveEdition(): Save edition.
o SetGroup(CATLISTV(CATISktUse2DWFGeometry_var)&,int,double*): Set the current group of geometric elements.
o Transform(CATLISTV(CATISktUse2DWFGeometry_var)&,CATMathTransformation2D*,double*,double*): Transformation and evaluation of a group of geometric element.
o TransformGroup(CATMathTransformation2D&,CAT2DSolvingMode,double*): Transformation of the current group of geometric elements under constraints.

Methods

o CloseEdition

public virtual CloseEdition(	const	`iUnload`	`=0`,
	const	`iValuateAttr`	`=0`)

Close edition.

Returns:: HRESULT

o Evaluate

public virtual Evaluate(

)

Evaluation of geometric elements with respect to constraints.

Returns:: HRESULT

o Evaluate

public virtual Evaluate( const iGeom)

Geometry evaluation with a soft reference.

Parameters:

const: CATISktUse2DWFGeometry_var &iGeom [in] The geometry corresponding to the soft reference element. The solver tries to keep fixed this element.

Returns:

HRESULT

o Evaluate

public virtual Evaluate( const iSoftReferences)

Geometry evaluation with soft reference.

Parameters:

const: CATLISTV(CATISktUse2DWFGeometry_var) &iSoftReference [in] The list of handlers corresponding to the soft reference elements. The solver tries to keep fixed these elements (the first one is the more prioritary).

Returns:

HRESULT

o InEdition

public virtual InEdition(

)

Tells if edition is opened.

Returns:

int

1: The shetch is in edition.
0: The sketch is not in edition.

o OpenEdition

public virtual OpenEdition( const iValuateAttr =0)

Open edition.

Returns:: HRESULT

o ResetGroup

public virtual ResetGroup( const iContext =0)

Reset the current group of geometric elements.

Parameters:

const

int iContext [in] The manipulation ending mode.

0: The manipulation ends as usual.

Returns:

HRESULT

o SaveEdition

public virtual SaveEdition(

)

Save edition.

Returns:: HRESULT

o SetGroup

public virtual SetGroup(	const	`iGeoms`,
	const	`iContext`	`=1`,
	const	`iDragPoint`	`=NULL` )

Set the current group of geometric elements.

Parameters:

const

CATLISTV(CATISktUse2DWFGeometry_var) &iGeoms [in] The list of handlers corresponding to the elements to be manipulated.

const

int iContext [in] The manipulation mode.

0: The movable geometric elements are considered.
1: The end-points of movable curves are automatically added.

Returns:

HRESULT

o Transform

public virtual Transform(	const	`iGeoms`,
		`pTransfos`,
		`iRadiiX`	`=NULL`,
		`iRadiiY`	`=NULL`)

Transformation and evaluation of a group of geometric element.

Parameters:

const: CATLISTV(CATISktUse2DWFGeometry_var) &iGeoms [in] The list of handlers corresponding to geometric elements to transform.
CATMathTransformation2D: *ioTransfos [in] The array of transformations to apply to geometric elements (same size than the list). The transformations should be rotations or translations. Using a transformation of any other kind, e.g. scaling, may not have the desired effect.
double: *iRadiiX [in] The array of (major-)radii to modify on circles and ellipses (same size than the list). This argument is optional.
double: *iRadiiY [in] The array of minor-radii to modify on ellipses (same size than the list). This argument is optional.

Returns:

HRESULT

o TransformGroup

public virtual TransformGroup(		`ioTransfo`,
	const	`iSolvingMode`	`=Solving2DMode_MinimumMove`,
	const	`iRadius`	`=NULL`)

Transformation of the current group of geometric elements under constraints.

Parameters:

CATMathTransformation2D: &ioTransfo [inout] The 2D transformation to apply if possible. The transformation should be a rotation or a translation. Using a transformation of any other kind, e.g. scaling, may not have the desired effect.
const: CAT2DSolvingMode iSolvingMode [in] The solving mode. This argument is optional.

Returns:

HRESULT

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