pycatia.smt_interfaces.silhouettes

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.silhouettes.Silhouettes(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
Silhouettes

Interface to compute Silhouettes.
add(i_product_to_silhouette: Product, i_accuracy: float, i_azimuts: tuple, i_shape_name: str, i_activated_shape: int, i_default_shape: int) → Silhouette

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func Add(Product iProductToSilhouette,
double iAccuracy,
CATSafeArrayVariant iAzimuts,
CATBSTR iShapeName,
long iActivatedShape,
long iDefaultShape) As Silhouette

Creates a new Silhouette and adds it to the Silhouettes collection. This
function is deprecated.

Returns:
The created Silhouette
Example:
The following example creates a Silhouette newSilhouette in the
Silhouette collection.

Set newSilhouette = Silhouettes.Add
Parameters:

  • i_product_to_silhouette (Product) –

  • i_accuracy (float) –

  • i_azimuts (tuple) –

  • i_shape_name (str) –

  • i_activated_shape (int) –

  • i_default_shape (int) –

Return type:

Silhouette

clean_up() → None

Note

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

Performs some clean-up.
Return type:

None

compute_a_silhouette(group_of_selected_products: Group, i_view_points: tuple, i_accuracy: float, i_accuracy_for_simplification: float) → Document

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func ComputeASilhouette(Group GroupOfSelectedProducts,
CATSafeArrayVariant iViewPoints,
double iAccuracy,
double iAccuracyForSimplification) As Document

Computes a silhouette on the selected products.

Parameters:

GroupOfSelectedProducts
The selected products on which you want to perform the silhouette.

iViewPoints
Array containing the viewpoints (cameras) used to perform the
silhouette.
iAccuracy
Grain value for the voxels.
iAccuracyForSimplification
Accuracy for simplification of the silhouette. Let it null for no
simplification.

Returns:
SilhouetteDocument: Document containing the result.
Parameters:

  • group_of_selected_products (Group) –

  • i_view_points (tuple) –

  • i_accuracy (float) –

  • i_accuracy_for_simplification (float) –

Return type:

Document

compute_a_silhouette_with_a_reference(i_group_of_selected_products: Group, i_reference_product: Product, i_view_points: tuple, i_accuracy: float, i_accuracy_for_simplification: float) → Document

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func ComputeASilhouetteWithAReference(Group
iGroupOfSelectedProducts,
Product iReferenceProduct,
CATSafeArrayVariant iViewPoints,
double iAccuracy,
double iAccuracyForSimplification) As Document

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

Parameters:

iGroupOfSelectedProducts
The selected products on which you want to perform the silhouette.

iReferenceProduct
Product taken as a reference.
iViewPoints
Array containing the viewpoints (cameras) used to perform the
silhouette.
iAccuracy
Grain value for the voxels.
iAccuracyForSimplification
Accuracy for simplification of the silhouette. Let it null for no
simplification.

Returns:
SilhouetteDocument: Document containing the result.
Parameters:

  • i_group_of_selected_products (Group) –

  • i_reference_product (Product) –

  • i_view_points (tuple) –

  • i_accuracy (float) –

  • i_accuracy_for_simplification (float) –

Return type:

Document

silhouette_shape_name() → str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func SilhouetteShapeName() As CATBSTR

Returns the name of the associated shape.
Return type:

str