All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATAnnotationUseItf Interface CATIDrwDimExtensionLine

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

interface CATIDrwDimExtensionLine

Manages the dimension extension line.
Role: This interface manages all parameters linked to extension-line(s).

Method Index

o AddInterrupt(double [2],double [2],int): Add an interrupt to an extension line.
o GetExtLineVisibility(int&,int&): Gets extension line visibility.
o GetGap(): Gets gap.
o GetGaps(double&,double&): Gets gaps.
o GetGraphicParameters(int&,double&): Gets graphic parameters.
o GetInterruptions(int&,CATListOfDouble&,int&,CATListOfDouble&): Computes and gets the visible extension line interruptions.
o GetOverRun(): Gets overrun.
o GetOverRuns(double&,double&): Gets overruns.
o GetPoints(double*,double*,double*): Gets extension line points.
o HasInterruptions(): Test whether the extension lines have interruptions or not.
o RemoveInterrupt(int,double*): Remove interruption on extension lines.
o SetExtLineVisibility(int,int): Sets extension line visibility.
o SetGap(double): Sets gap.
o SetGaps(double,double): Sets gaps.
o SetGraphicParameters(int,double): Sets graphic parameters.
o SetOverRun(double): Sets overrun.
o SetOverRuns(double,double): Sets overruns.
o SetPoints(double*,double*,double*): Sets extension line points.

Methods

o AddInterrupt

public virtual AddInterrupt(	`iFirstIndPoint`,
	`iLastIndPoint`,
	`iExtLine`	`= 3`)

Add an interrupt to an extension line. The extension line which is interrupted is the nearest of the iFirstIndPoint. This point is reprojected when the dimension is modified.

Parameters:

iFirstIndPoint: Defines the first point of the gap to create.
iLastIndPoint: Defines the second point of the gap to create.
iExtLine: Defines the ExtLine to interrupt.
0 : Both
1 : Left
2 : Right
3 : Nearest (default)

Returns:

S_OK if the interrupt is added.
E_FAIL if the interrupt cannot be added.

o GetExtLineVisibility

public virtual GetExtLineVisibility(		`left`,
		`right`)

Gets extension line visibility.

Parameters:

left: left extension line visibility (1=show, 0=hide).
right: right extension line visibility (1=show, 0=hide).

o GetGap

public virtual GetGap(

)

Gets gap.

Returns:: Gap value.

o GetGaps

public virtual GetGaps(		`g1`,
		`g2`)

Gets gaps.

Parameters:

g1: Extension line 1 gap.
g2: Extension line 2 gap.

o GetGraphicParameters

public virtual GetGraphicParameters(		`oColor`,
		`oThickness`)

Gets graphic parameters.

Parameters:

oColor: Color.
oThickness: Thickness.

o GetInterruptions

public virtual GetInterruptions(		`oNumberOfInterruptionsOnFirst`,
		`oListOfInterruptionsOnFirst`,
		`oNumberOfInterruptionsOnSecond`,
		`oListOfInterruptionsOnSecond`)

Computes and gets the visible extension line interruptions.
Role: This method computes the interruptions of this DimExtensionLine. For each extension line, it gets the number of interruptions and the related points.

Parameters:

oNumberOfInterruptionsOnFirst: [out] The number of interruptions on the first extension line.
oListOfInterruptionsOnFirst: [out] The list of interruptions on the first extension line (oNumberOfInterruptionsOnFirst*4 sized).

oNumberOfInterruptionsOnSecond

[out] The number of interruptions on the second extension line.

oListOfInterruptionsOnSecond

[out] The list of interruptions on the second extension line (oNumberOfInterruptionsOnSecond*4 sized).

Returns:

S_OK if everything ran ok, E_INVALIDARGS if all preconditions were not fulfilled, E_UNEXPECTED if an unexpected error occured.

o GetOverRun

public virtual GetOverRun(

)

Gets overrun.

Returns:: Overrun value.

o GetOverRuns

public virtual GetOverRuns(		`or1`,
		`or2`)

Gets overruns.

Parameters:

or1: Extension line 1 overrun.
or2: Extension line 2 overrun.

o GetPoints

public virtual GetPoints(	`oPtLdr1`,
	`oPtLdr2`,
	`center`	`=NULL`)

Gets extension line points.

Parameters:

oPtLdr1: First extension line point.
oPtLdr2: Second extension line point.
center: Center extension line point.
Value is NULL if not circular extension line.

o HasInterruptions

public virtual HasInterruptions(

)

Test whether the extension lines have interruptions or not.
Role: This method ask the model for presence of interruptions definition. Please note that the interruptions defined in the model can be invisible.

Returns:: CATBoolean TRUE if an extension line has interruptions, FALSE if extention lines have no interruption.

o RemoveInterrupt

public virtual RemoveInterrupt(		`iExtLine`	`= 0` ,
		`iIndicationPoint`	`= NULL`)

Remove interruption on extension lines.

Parameters:

iExtLine: 0 : (default) erase all interruptions on all extension lines.
1, 2 : erase all interruptions on the extension line 1 or 2.
3 : erase all interrupts on the nearest extension line.
iIndicationPoint: The point to compute the nearest extension line if iExtLine equals 3.

Returns:

S_OK if the interrupt are deleted.
S_FALSE if there is no interrupt on the extension line.
E_FAIL if another problem occurs. (if iExtLine=3 and iIndicationPoint=NULL for example)

o SetExtLineVisibility

public virtual SetExtLineVisibility(		`left`,
		`right`)

Sets extension line visibility.

Parameters:

left: left extension line visibility (1=show, 0=hide).
right: right extension line visibility (1=show, 0=hide).

o SetGap

public virtual SetGap( const gap)

Sets gap.

Parameters:

gap: Gap value.

o SetGaps

public virtual SetGaps(		`g1`,
		`g2`)

Sets gaps.

Parameters:

g1: Extension line 1 gap.
g2: Extension line 2 gap.

o SetGraphicParameters

public virtual SetGraphicParameters(	const	`iColor`,
	const	`iThickness`)

Sets graphic parameters.

Parameters:

iColor: Color.
iThickness: Thickness.

o SetOverRun

public virtual SetOverRun( const overRun)

Sets overrun.

Parameters:

overRun: Overrun value.

o SetOverRuns

public virtual SetOverRuns(		`or1`,
		`or2`)

Sets overruns.

Parameters:

or1: Extension line 1 overrun.
or2: Extension line 2 overrun.

o SetPoints

public virtual SetPoints(	`iPtLdr1`,
	`iPtLdr2`,
	`center`	`=NULL`)

Sets extension line points.

Parameters:

iPtLdr1: First extension line point.
iPtLdr2: Second extension line point.
center: Center extension line point.
Default value is NULL.

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