pycatia.smt_interfaces.wrappings

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.wrappings.Wrappings(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

Wrappings

Interface to compute Wrappings

add(i_product_to_wrapping: Product, i_accuracy: float, i_ratio: float, i_shape_name: str, i_activated_shape: int, i_default_shape: int) → Wrapping

Note

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

o Func Add(Product iProductToWrapping,

double iAccuracy,

double iRatio,

CATBSTR iShapeName,

long iActivatedShape,

long iDefaultShape) As Wrapping

Compute a wrapping on the selected products. This method is

deprecated!

Parameters:

iProductToWrapping

The selected products on which you want to perform a wrapping.

iAccuracy

The grain accuracy.

iRatio

The ratio.

iShapeName

The associated shape name.

iActivatedShape

Do we activate the shape ?

iDefaultShape

Do we activate the shape as default shape ?

Returns:

oWrapping: Document containing the result.

Parameters:

• i_product_to_wrapping (Product) –

• i_accuracy (float) –

• i_ratio (float) –

• i_shape_name (str) –

• i_activated_shape (int) –

• i_default_shape (int) –

Return type:

Wrapping

clean_up() → None

Note

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

o Sub CleanUp()

Cleans up.

Return type:

None

compute_a_wrapping(group_of_selected_products: Group, i_accuracy: float, i_ration: float, i_accuracy_for_simplification: float) → Document

Note

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

o Func ComputeAWrapping(Group GroupOfSelectedProducts,

double iAccuracy,

double iRation,

double iAccuracyForSimplification) As Document

Compute a wrapping on the selected products.

Parameters:

GroupOfSelectedProducts

The selected products on which you want to perform a wrapping.

iAccuracy

The grain accuracy.

iRation

The ratio.

iAccuracyForSimplification

The accuracy for the simplification. equals -1 if no simplification

is to be performed.

Returns:

WrappingDocument: Document containing the result.

Parameters:

• group_of_selected_products (Group) –

• i_accuracy (float) –

• i_ration (float) –

• i_accuracy_for_simplification (float) –

Return type:

Document

compute_a_wrapping_with_a_reference(i_group_of_selected_products: Group, i_reference_product: Product, i_accuracy: float, i_ration: float, i_accuracy_for_simplification: float) → Document

Note

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

o Func ComputeAWrappingWithAReference(Group

iGroupOfSelectedProducts,

Product iReferenceProduct,

double iAccuracy,

double iRation,

double iAccuracyForSimplification) As Document

Compute a wrapping on the selected products, according to a reference

product.

Parameters:

GroupOfSelectedProducts

The selected products on which you want to perform a wrapping.

iReferenceProduct

Product taken as a reference.

iAccuracy

The grain accuracy.

iRation

The ratio.

iAccuracyForSimplification

The accuracy for the simplification. equals -1 if no simplification

is to be performed.

Returns:

WrappingDocument: Document containing the result.

Parameters:

• i_group_of_selected_products (Group) –

• i_reference_product (Product) –

• i_accuracy (float) –

• i_ration (float) –

• i_accuracy_for_simplification (float) –

Return type:

Document

compute_wrapping_with_convex_hull(i_group_of_selected_products: Group, i_reference_product: Product, i_accuracy: float, i_perform_simplification: bool, i_accuracy_for_simplification: float) → Document

Introduced in V5-6R2020.

Note

CAA V5 Visual Basic Help (2024-08-20 16:04:57.203445)

Func ComputeWrappingWithConvexHull(Group iGroupOfSelectedProducts,Product

iReferenceProduct,double iAccuracy,boolean iPerformSimplification,double

iAccuracyForSimplification) As Document

Compute a wrapping using convex hull algorithm on the selected products,

according to a reference product.

Parameters:

iGroupOfSelectedProducts

The selected products to wrap.

iReferenceProduct

Product taken as a reference.

iAccuracy

The grain accuracy (accuracy value > 0 and units in mm).

iPerformSimplification

set to true for simplification and set to false for no

simplification

iAccuracyForSimplification

The accuracy for the simplification (accuracy value > 0 and units

in mm). The accuracy value is taken into account only if the @param

iPerformSimplification is set to true.

Returns:

WrappingDocument: Document containing the result.

Parameters:

• i_group_of_selected_products (Group) –

• i_reference_product (Product) –

• i_accuracy (float) –

• i_perform_simplification (bool) –

• i_accuracy_for_simplification (float) –

Return type:

Document

wrapping_shape_name() → str

Note

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

o Func WrappingShapeName() As CATBSTR

Returns the name of the associated shape.

Return type:

str