pycatia.drafting_interfaces.drawing_components

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_components.DrawingComponents(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
DrawingComponents

A collection of all the drawing components (ditto) currently managed by a
drawing view of drawing sheet in a drawing document.
add(i_drawing_component_ref: DrawingView, i_position_x: float, i_position_y: float) → DrawingComponent

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func Add(DrawingView iDrawingComponentRef,
double iPositionX,
double iPositionY) As DrawingComponent

Creates a drawing component instance and adds it to the DrawingComponents
collection.

Parameters:

iDrawingComponentRef
The view (i.e. the detail) that is the component reference . This
view also called a detail MUST belong to a sheet of component references (i.e.
details)
iPositionX,iPositionY
The drawing component x and y coordinates, expressed in
millimeters, with respect to the drawing view coordinate system


Returns:
The created drawing component instance

Example:
The following example creates a drawing component instance with a given
component reference MyComponentRef coming from a Sheet of component references
(i.e. details) SheetComponentRef and retrieved in MyComponentInst in the
drawing view collection of the MyView drawing view. This view belongs to the
drawing view collection of the drawing sheet

Dim MyComponentRef As DrawingView
Set MyComponentRef = SheetComponentRef.Views.Item(1)
Dim MyView As DrawingView
Set MyView = MySheet.Views.ActiveView
Dim MyComponentInst As DrawingComponent
Set MyComponentInst = MyView.Components.Add(MyComponentRef, 100., 50.)
Parameters:

  • i_drawing_component_ref (DrawingView) –

  • i_position_x (float) –

  • i_position_y (float) –

Return type:

DrawingComponent

item(i_index: cat_variant) → DrawingComponent

Note

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

Returns a drawing component instance using its index or its name from the
DrawingComponents collection.

Parameters:

iIndex
The index or the name of the drawing component instance to retrieve
from the collection of drawing components. As a numerics, this index is the
rank of the drawing component instance in the collection. The index of the
first drawing component instance in the collection is 1, and the index of the
last drawing component instance is Count. As a string, it is the name you
assigned to the drawing component instance using the


AnyObject.Name property
Returns:
The retrieved drawing component instance

Example:
This example retrieves in ThisDrawingComponent the second drawing component
instance, MyView in the drawing view collection of the active sheet in the
active document, supposed to be a drawing document.

Dim MySheet As DrawingSheet
Set MySheet = CATIA.ActiveDocument.Sheets.ActiveSheet
Dim MyView As DrawingView
Set MyView = MySheet.Views.ActiveView
Dim ThisDrawingComponent As DrawingComponent
Set ThisDrawingComponent = MyView.Components.Item(2)
Parameters:

i_index (cat_variant) –

Return type:

DrawingComponent

remove(i_index: cat_variant) → None

Note

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

Removes a drawing component from the DrawingComponents
collection.

Parameters:

iIndex
The index of the drawing component to remove from the collection of
drawing components. As a numerics, this index is the rank of the drawing
component in the collection. The index of the first drawing component instance
in the collection is 1, and the index of the last drawing component instance is
Count. As a string, it is the name you assigned to the drawing component using
the

AnyObject.Name property

Example:
The following example removes the third drawing component instance in the
drawing component 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.Components.Remove(3)
Parameters:

i_index (cat_variant) –

Return type:

None