pycatia.drafting_interfaces.drawing_dim_ext_line

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.drafting_interfaces.drawing_dim_ext_line.DrawingDimExtLine(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
DrawingDimExtLine

Manages extension lines of a dimension in drawing view.

This interface is obtained from DrawingDimension.GetExtLine
method.
add_interrupt(i_index: int, i_two_points: tuple) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub AddInterrupt(long iIndex,
CATSafeArrayVariant iTwoPoints)

Add an interrupt to an extension line.

Parameters:

iIndex
1: first extension line 2: second extension line
iTwoPoints
Defines the first and second point of the gap to create.

Example:
This example adds an interrupt to MyExtLine path.

MyExtLine.AddInterrupt(iIndex, iTwoPoints)
Parameters:

  • i_index (int) –

  • i_two_points (tuple) –

Return type:

None

property color: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property Color() As long

Returns or sets color of extension line.

Example:
This example retrieves color of extension line MyExtLine drawing
dimension.

oColorExtLine = MyExtLine.Color
Return type:

int

property ext_line_slant: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property ExtLineSlant() As double

Returns or sets slant angle of extension line.

Example:
This example retrieves slant angle of extension line MyExtLine drawing
dimension.

oExtLineSlant = MyExtLine.ExtLineSlant
Return type:

float

property ext_line_type: int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property ExtLineType() As long (Read Only)

Returns extension line type of dimension.

Example:
This example retrieves extension line type of dimension MyExtLine
drawing dimension.

oExtLineType = MyExtLine.ExtLineType
Return type:

int

get_funnel(i_index: int, o_mode: int, o_angle: float, o_height: float, o_width: float) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub GetFunnel(long iIndex,
long oMode,
double oAngle,
double oHeight,
double oWidth)

Get funnel information of dimension extension line.

Parameters:

iIndex
1: first extension line 2: second extension line
oMode
funnel inside/outside mode.
oAngle
funnel angle.
oHeight
funnel height.
oWidth
funnel width.
Example:
This example gets funnel information of MyExtLine
path.

MyExtLine.GetFunnel(iIndex, oMode, oAngle, oHeight,
oWidth)
Parameters:

  • i_index (int) –

  • o_mode (int) –

  • o_angle (float) –

  • o_height (float) –

  • o_width (float) –

Return type:

None

get_gap(i_index: int) → float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func GetGap(long iIndex) As double

Get gap of dimension extension line.

Parameters:

iIndex
1: first extension line 2: second extension line
oGap
Gap.
Example:
This example gets gap of MyExtLine path.

Gap = MyExtLine.GetGap(iIndex)
Parameters:

i_index (int) –

Return type:

float

get_geom_info(i_index: int, o_geom_infos: tuple) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub GetGeomInfo(long iIndex,
CATSafeArrayVariant oGeomInfos)

Get geometrical information of dimension extension line.

Parameters:

iIndex
1: first extension line 2: second extension line
oGeomInfos
List of geometric coordinates (X1,Y1,X2,Y2,X3,Y3).

Example:
This example gets geometrical information of MyExtLine
path.

MyExtLine.GetGeomInfo(iIndex, oGeomInfos)
Parameters:

  • i_index (int) –

  • o_geom_infos (tuple) –

Return type:

None

get_interrupt(i_index: int) → int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func GetInterrupt(long iIndex) As long

Get the number of interruptions stored in each extension
lines.

Parameters:

iIndex
1: first extension line 2: second extension line
oNbIntOnExtLine
The number of interruptions.
Example:
This example gets the number of interruptions of MyExtLine
path.

NbIntOnExtLine = MyExtLine.GetInterrupt(iIndex)
Parameters:

i_index (int) –

Return type:

int

get_overrun(i_index: int) → float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func GetOverrun(long iIndex) As double

Get overrun of dimension extension line.

Parameters:

iIndex
1: first extension line 2: second extension line
oOverrun
Overrun
Example:
This example gets overrun of MyExtLine path.

Overrun = MyExtLine.GetOverrun(iIndex)
Parameters:

i_index (int) –

Return type:

float

get_visibility(i_index: int) → int

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func GetVisibility(long iIndex) As long

Get visibility of dimension extension line.

Parameters:

iIndex
1: first extension line 2: second extension line
oGap
Gap.
Example:
This example gets visibility of MyExtLine path.

ExtlineVisibility = MyExtLine.GetVisibility(iIndex)
Parameters:

i_index (int) –

Return type:

int

remove_interrupt(i_index: int) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub RemoveInterrupt(long iIndex)

Remove interruption on extension lines.

Parameters:

iIndex
1: first extension line 2: second extension line
Example:
This example Remove interruption on MyExtLine
path.

MyExtLine.RemoveInterrupt(iIndex)
Parameters:

i_index (int) –

Return type:

None

set_funnel(i_index: int, i_mode: int, i_angle: float, i_height: float, i_width: float) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub SetFunnel(long iIndex,
long iMode,
double iAngle,
double iHeight,
double iWidth)

Set funnel information of dimension extension line.

Parameters:

iIndex
1: first extension line 2: second extension line
iMode
funnel inside/outside mode.
iAngle
funnel angle.
iHeight
funnel height.
iWidth
funnel width.
Example:
This example sets funnel information of MyExtLine
path.

MyExtLine.SetFunnel(iIndex, iMode, iAngle, iHeight,
iWidth)
Parameters:

  • i_index (int) –

  • i_mode (int) –

  • i_angle (float) –

  • i_height (float) –

  • i_width (float) –

Return type:

None

set_gap(i_index: int, i_gap: float) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub SetGap(long iIndex,
double iGap)

Set gap of dimension extension line.

Parameters:

iIndex
1: first extension line 2: second extension line
iGap
gap
Example:
This example sets gap of MyExtLine path.

MyExtLine.SetGap(iIndex, iGap)
Parameters:

  • i_index (int) –

  • i_gap (float) –

Return type:

None

set_overrun(i_index: int, i_overrun: float) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub SetOverrun(long iIndex,
double iOverrun)

Set overrun of dimension extension line.

Parameters:

iIndex
1: first extension line 2: second extension line
iOverrun
Overrun
Example:
This example sets overrun of MyExtLine path.

MyExtLine.SetOverrun(iIndex, iOverrun)
Parameters:

  • i_index (int) –

  • i_overrun (float) –

Return type:

None

set_visibility(i_index: int, i_extline_visibility: int) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub SetVisibility(long iIndex,
long iExtlineVisibility)

Set visibility of dimension extension line.

Parameters:

iIndex
1: first extension line 2: second extension line
iExtlineVisibility
visibility
Example:
This example sets visibility of MyExtLine path.

MyExtLine.SetVisibility(iIndex,
iExtlineVisibility)
Parameters:

  • i_index (int) –

  • i_extline_visibility (int) –

Return type:

None

property thickness: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property Thickness() As double

Returns or sets thickness of extension line.

Example:
This example retrieves thickness of extension line MyExtLine drawing
dimension.

oThickExtLine = MyExtLine.Thickness
Return type:

float