pycatia.arrangement_interfaces.arrangement_rectangles

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

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.arrangement_interfaces.arrangement_rectangles.ArrangementRectangles(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.Collection
ArrangementRectangles

A Collection object for ArrangementRectangle objects.
Role: Use this object to manage (create, retrieve and remove)
ArrangementRectangle objects.
add_rectangle(i_rel_axis: Move, i_position: tuple, i_width: float, i_length: float) → ArrangementRectangle

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddRectangle(Move iRelAxis,
CATSafeArrayVariant iPosition,
double iWidth,
double iLength) As ArrangementRectangle

Creates an ArrangementRectangle and adds it to the
collection.

Parameters:

iRelAxis
Relative Axis to be considered.
iPosition
Position information for the Rectangle (rotation and location).

iWidth
Width of the Rectangle.
iLength
Length of the Rectangle.

Returns:
Returns the newly created ArrangementRectangle and adds it to the
collection.
Parameters:

  • i_rel_axis (Move) –

  • i_position (tuple) –

  • i_width (float) –

  • i_length (float) –

Return type:

ArrangementRectangle

item(i_index: cat_variant) → ArrangementRectangle

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func Item(CATVariant iIndex) As ArrangementRectangle

Returns the specified ArrangementRectangle item of the collection
object.

Parameters:

iIndex
The index or the name of the ArrangementRectangle to retrieve from
this collection.

To retrieve a specific object by number, use the rank of the
ArrangementRectangle in that collection.
Note that the index of the first element in the collection is
1, and the index of the last element is Count. To retrieve a specific
ArrangementRectangle by name, use name that you assigned using the


AnyObject.Name property.
Returns:
The retrieved ArrangementRectangle object.
Parameters:

i_index (cat_variant) –

Return type:

ArrangementRectangle

remove(i_index: cat_variant) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Remove(CATVariant iIndex)

Removes the specified ArrangementRectangle object from the
collection.

Parameters:

iIndex
The index or the name of the ArrangementRectangle to remove from
this collection.

To remove a specific object by number, use the rank of the
ArrangementRectangle in that collection.
Note that the index of the first element in the collection is
1, and the index of the last element is Count. To remove a specific
ArrangementRectangle by name, use name that you assigned using the


AnyObject.Name property.
Parameters:

i_index (cat_variant) –

Return type:

None