All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DraftingInterfaces Interface CATIDrwDimExtensionLine

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---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 GetNbInterrupt(int*,int*)
Returns the number of interruptions stored in each extension lines.
o GetOverRun()
Gets overrun.
o GetOverRuns(double&,double&)
Gets overruns.
o GetPoints(double*,double*,double*)
Gets extension line points.
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 HRESULT AddInterrupt(double [2] iFirstIndPoint,
double [2] iLastIndPoint,
int iExtLine= 3) = 0
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 void GetExtLineVisibility(int& left,
int& right)= 0
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 double GetGap()const = 0
Gets gap.
Returns:
Gap value.
o GetGaps
public virtual void GetGaps(double& g1,
double& g2)const = 0
Gets gaps.
Parameters:
g1
Extension line 1 gap.
g2
Extension line 2 gap.
o GetGraphicParameters
public virtual void GetGraphicParameters(int& oColor,
double& oThickness) const = 0
Gets graphic parameters.
Parameters:
oColor
Color.
oThickness
Thickness.
o GetNbInterrupt
public virtual HRESULT GetNbInterrupt(int* oNbInterruptOnExtLine1,
int* oNbInterruptOnExtLine2) = 0
Returns the number of interruptions stored in each extension lines. Interruptions stored could be invisible, so this number is only the maximum number of interrupts that can be visible on each extension line.
Parameters:
oNbInterruptOnExtLine1
oNbInterruptOnExtLine2
Returns:
S_OK No problem occurs.
E_FAIL if a problem occurs.
o GetOverRun
public virtual double GetOverRun()const = 0
Gets overrun.
Returns:
Overrun value.
o GetOverRuns
public virtual void GetOverRuns(double& or1,
double& or2)const = 0
Gets overruns.
Parameters:
or1
Extension line 1 overrun.
or2
Extension line 2 overrun.
o GetPoints
public virtual void GetPoints(double* oPtLdr1,
double* oPtLdr2,
double* center=NULL) = 0
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 RemoveInterrupt
public virtual HRESULT RemoveInterrupt(int iExtLine= 0 ,
double* iIndicationPoint= NULL) = 0
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 void SetExtLineVisibility(int left,
int right)= 0
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 void SetGap( const double gap)= 0
Sets gap.
Parameters:
gap
Gap value.
o SetGaps
public virtual void SetGaps(double g1,
double g2)= 0
Sets gaps.
Parameters:
g1
Extension line 1 gap.
g2
Extension line 2 gap.
o SetGraphicParameters
public virtual void SetGraphicParameters( const int iColor,
const double iThickness) = 0
Sets graphic parameters.
Parameters:
iColor
Color.
iThickness
Thickness.
o SetOverRun
public virtual void SetOverRun( const double overRun)= 0
Sets overrun.
Parameters:
overRun
Overrun value.
o SetOverRuns
public virtual void SetOverRuns(double or1,
double or2)= 0
Sets overruns.
Parameters:
or1
Extension line 1 overrun.
or2
Extension line 2 overrun.
o SetPoints
public virtual void SetPoints(double* iPtLdr1,
double* iPtLdr2,
double* center=NULL) = 0
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: CATDraftingInterfaces

Copyright © 2003, Dassault Systèmes. All rights reserved.