pycatia.drafting_interfaces.drawing_weldings

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_weldings.DrawingWeldings(com_object)

Note

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

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.Collection
DrawingWeldings

A collection of all the drawing weldings currently managed by a drawing view of
drawing sheet in a drawing document.
add(i_symbol: int, i_position_x: float, i_position_y: float) → DrawingWelding

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func Add(CatWeldingSymbol iSymbol,
double iPositionX,
double iPositionY) As DrawingWelding

Creates a drawing welding and adds it to the drawing weldings collection.
This drawing welding becomes the active one.

Parameters:

iSymbol
The drawing welding symbol to assign to the drawing welding

iPositionX,iPositionY
The drawing welding x and y coordinates, expressed in millimeters,
and expressed with respect to the view coordinate system


Returns:
The created drawing welding

Example:
The following example creates a drawing welding, retrieved in MyWelding, in
the MyView drawing view. This view belongs to the drawing view collection of
the drawing sheet.

Dim MyView As DrawingView
Set MyView = MySheet.Views.ActiveView
Dim MyWelding As DrawingWelding
Set MyWelding =
MyView.Weldings.Add(catSquareWelding, 0., 0.)
Parameters:

  • i_symbol (int) – enum cat_welding_symbol

  • i_position_x (float) –

  • i_position_y (float) –

Return type:

DrawingWelding

item(i_index: int) → DrawingWelding

Note

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

Returns a drawing welding using its index from the drawing weldings
collection.

Parameters:

iIndex
The index of the drawing welding to retrieve from the collection of
drawing weldings. As a numerics, this index is the rank of the drawing welding
in the collection. The index of the first drawing welding in the collection is
1, and the index of the last drawing welding is Count.


Returns:
The retrieved drawing welding

Example:
This example retrieves in ThisDrawingWelding the second drawing welding, in
the drawing welding collection of the active view in the active sheet, in the
active document supposed to be a drawing document.

Dim MyView As DrawingView
Set MyView = MySheet.Views.ActiveView
Dim ThisDrawingWelding As DrawingWelding
Set ThisDrawingWelding = MyView.Weldings.Item(2)
Parameters:

i_index (int) –

Return type:

DrawingWelding

remove(i_index: int) → None

Note

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

Removes a drawing welding from the drawing weldings
collection.

Parameters:

iIndex
The index of the drawing welding to remove from the collection of
drawing weldings. As a numerics, this index is the rank of the drawing text in
the collection. The index of the first drawing welding in the collection is 1,
and the index of the last drawing welding is Count.


Example:
The following example removes the third drawing welding from the
drawing welding collection of the active view of the active document, supposed
to be a drawing document.

Dim MyView As DrawingView
Set MyView = MySheet.Views.ActiveView
MyView.Drawing.Remove(3)
Parameters:

i_index (int) –

Return type:

None