pycatia.smt_interfaces.three_d_cuts

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.smt_interfaces.three_d_cuts.ThreeDCuts(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
ThreeDCuts

Interface to compute 3D cuts
compute3_d_cut_with_a_reference(group_of_selected_products: Group, i_reference_product: Product, three_d_cut_document: Document) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Compute3DCutWithAReference(Group
GroupOfSelectedProducts,
Product iReferenceProduct,
Document ThreeDCutDocument)

Computes the 3DCut on the selected products, according to a reference
product.

Parameters:

GroupOfSelectedProducts
The selected products on which you want to perform the 3D cut.

iReferenceProduct
Product taken as a reference.

Returns:
ThreeDCutDocument: Document containing the result.
Parameters:

  • group_of_selected_products (Group) –

  • i_reference_product (Product) –

  • three_d_cut_document (Document) –

Return type:

None

compute_3d_cut(group_of_selected_products: Group, three_d_cut_document: Document) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Compute3DCut(Group GroupOfSelectedProducts,
Document ThreeDCutDocument)

Computes the 3DCut on the selected products.

Parameters:

GroupOfSelectedProducts
The selected products on which you want to perform the 3D cut.


Returns:
ThreeDCutDocument: Document containing the result.
Parameters:

  • group_of_selected_products (Group) –

  • three_d_cut_document (Document) –

Return type:

None

get_compute_3d_cut(group_of_selected_products: Group) → Document

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetCompute3DCut(Group GroupOfSelectedProducts) As
Document

Computes the 3DCut on the selected products (better
signature).

Parameters:

GroupOfSelectedProducts
The selected products on which you want to perform the 3D cut.


Returns:
ThreeDCutDocument: Document containing the result.
Parameters:

group_of_selected_products (Group) –

Return type:

Document

get_compute_3d_cut_with_a_reference(group_of_selected_products: Group, i_reference_product: Product) → Document

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetCompute3DCutWithAReference(Group
GroupOfSelectedProducts,
Product iReferenceProduct) As Document

Computes the 3DCut on the selected products, according to a reference
product (better signature).

Parameters:

GroupOfSelectedProducts
The selected products on which you want to perform the 3D cut.

iReferenceProduct
Product taken as a reference.

Returns:
ThreeDCutDocument: Document containing the result.
Parameters:

  • group_of_selected_products (Group) –

  • i_reference_product (Product) –

Return type:

Document

set_box(origin_x: float, origin_y: float, origin_z: float, vx: float, vy: float, vz: float) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetBox(double OriginX,
double OriginY,
double OriginZ,
double VX,
double VY,
double VZ)

Sets the RELATIVE box used for the 3D cut computation.
Be aware of the behavior:

Vz
^_________________
/| /|
/ / |
/ | / |
/ / |
/—-+———–/ |
| | |
| | * | |
| O | |
| | | |
| | |
| | | |
| * - - - - - + - -|> Vy
| Origin | /
| / | /
| | /
|/ |/
/—————-/
<
Vx

In the relative referential, O is (0,0,0)

This method sets the RELATIVE box : the rotation and translation matrix will then set the absolute position of O.
Remember where the center of the relative referential lies!
Can have unexpected results if you don’t use it properly.

Parameters:

OriginX
Origin coordinate (X)
OriginY
Origin coordinate (Y)
OriginZ
Origin coordinate (Z)
VX
Length of the box (along X)
VY
Length of the box (along Y)
VZ
Length of the box (along Z)
Parameters:

  • origin_x (float) –

  • origin_y (float) –

  • origin_z (float) –

  • vx (float) –

  • vy (float) –

  • vz (float) –

Return type:

None

set_matrix(i_components: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetMatrix(CATSafeArrayVariant iComponents)

Sets the rotation AND translation matrix.
Beware : After a SetBox, the matrix is not changed.

Parameters:

iComponents
Components of the 4x4 matrix, placed in rows.
Parameters:

i_components (tuple) –

Return type:

None

set_on_borders(on_borders: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetOnBorders(long OnBorders)

Sets the behavior on borders.

Parameters:

Type
0 : We keep partially included triangles
1 : We keep entirely included triangles
Parameters:

on_borders (int) –

Return type:

None

set_type(type: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetType(long Type)

Sets the type of cut we’re doing.

Parameters:

Type
0 : We keep the inner triangles
1 : We keep the outer triangles
Parameters:

type (int) –

Return type:

None

three_d_cut_shape_name(name: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ThreeDCutShapeName(CATBSTR Name)

Returns the name of the associated shape.
Parameters:

name (str) –

Return type:

None