Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATSketcherUseItf Interface CATISktUseSketch

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

interface CATISktUseSketch

The methods of this interface provide the client with the functionality for handling a sketch.
Role:

Method Index

o AttachToPlane(CATBaseUnknown_var&,int,int): Defines the planar support of the sketch (the sketch becomes Sliding).
o GetAbsolute2DAxis(CATISktUse2DAxis_var&): Returns the absolute axis of the sketch.
o GetAxisData(double*,double*,double*): Returns the position of the sketch in space.
o GetComponents(CATIdent,CATLISTV(CATISktUse2DWFGeometry_var)&): Retrieves all geometries.
o GetCurrentCenterLine(): Returns the (unique) center line of the sketch.
o GetPlanarSupport(CATIMmiMechanicalFeature_var&): Returns the planar support of the sketch.
o GetProfile(CATLISTV(CATISktUse2DWFGeometry_var)&,int&,CATListOfInt*,int*): Returns the first profile found in the sketch.
o GetSolvingStatus(int&): Returns the solving diagnostic of the sketch.
o GetSupport(): Returns a handler on the absolute axis of the sketch.
o IsEmpty(): Tells if the sketch is empty.
o Isolate(): Isolates the projected and intersected Geometries.
o ResetOrientation(): Unsets absolute axis orientation management for the next update.
o SetAxisData(double*,double*,double*): Defines the position of the sketch in space.
o SetCurrentCenterLine(CATISktUse2DLine_var&): Defines the (unique) center line of the sketch.

Methods

o AttachToPlane

public virtual AttachToPlane(	const	`iPlane`,
	const	`iKeepRelativOrientation`	`=0`,
	const	`iSlidingMode`	`=-1`)

Defines the planar support of the sketch (the sketch becomes Sliding).

o GetAbsolute2DAxis

public virtual GetAbsolute2DAxis( oAxis)

Returns the absolute axis of the sketch.

o GetAxisData

public virtual GetAxisData(		`oRootPoint`,
		`oHAxis`,
		`oVAxis`)

Returns the position of the sketch in space.

o GetComponents

public virtual GetComponents(	const	`iIntfName`,
		`ioGeomLst`)

Retrieves all geometries.

Parameters:

const: CATIdent iIntfName [in] To get only geometries answering to iIntfName interface.
CATLISTV: (CATISktUse2DWFGeometry_var)& ioGeomLst [inout] The list of geometries.

o GetCurrentCenterLine

public virtual GetCurrentCenterLine(

)

Returns the (unique) center line of the sketch.

o GetPlanarSupport

public virtual GetPlanarSupport( oPlane_output)

Returns the planar support of the sketch.

o GetProfile

public virtual GetProfile(	`oGeomList`,
	`IsClosed`,
	`oSenseList`	`=NULL`,
	`oDiagnostic`	`=NULL`)

Returns the first profile found in the sketch.

Parameters:

oGeomList: [out] Curves of the profile.
IsClosed: [out] > 0 in case of a closed profile.
oSenseList: [out] Gives the sense of each curves in the profile.
oDiagnostic: [out] Unused.

o GetSolvingStatus

public virtual GetSolvingStatus( ioStatus)

Returns the solving diagnostic of the sketch.

Parameters:

ioStatus: [in] Possible status is : 1 = OverDefined, 2 = Inconsistent, 3 = UnderDefined, 4 = WellDefined.

o GetSupport

public virtual GetSupport(

)

Returns a handler on the absolute axis of the sketch. Note: Please use GetAbsolute2DAxis() method instead of this one.

o IsEmpty

public virtual IsEmpty(

)

Tells if the sketch is empty.

Returns:

int

1: The shetch is empty.
0: The sketch is not empty.

o Isolate

public virtual Isolate(

)

Isolates the projected and intersected Geometries.

o ResetOrientation

public virtual ResetOrientation(

)

Unsets absolute axis orientation management for the next update.

o SetAxisData

public virtual SetAxisData(	const	`iRootPoint`,
	const	`iHAxis`,
	const	`iVAxis`)

Defines the position of the sketch in space.

o SetCurrentCenterLine

public virtual SetCurrentCenterLine( const iLine)

Defines the (unique) center line of the sketch.

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