pycatia.smt_interfaces.swept_volumes

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.swept_volumes.SweptVolumes(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
SweptVolumes

Interface to compute swept volumes.
add(replay: Replay, i_products_to_swept: tuple, i_product_reference: Product, i_lod_mode: int, i_accuracy: float, i_shape_name: str, i_activated_shape: int, i_default_shape: int) → SweptVolume

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func Add(Replay replay,
CATSafeArrayVariant iProductsToSwept,
Product iProductReference,
long iLODMode,
double iAccuracy,
CATBSTR iShapeName,
long iActivatedShape,
long iDefaultShape) As SweptVolume

Creates a new SweptVolume and adds it to the SweptVolumes collection. This
function is deprecated.

Returns:
The created SweptVolume
Example:
The following example creates a SweptVolume newSweptVolume in the
SweptVolume collection.

Set SweptVolume = SweptVolumes.Add
Parameters:

  • replay (Replay) –

  • i_products_to_swept (tuple) –

  • i_product_reference (Product) –

  • i_lod_mode (int) –

  • i_accuracy (float) –

  • i_shape_name (str) –

  • i_activated_shape (int) –

  • i_default_shape (int) –

Return type:

SweptVolume

add_from_swept_able(i_swept_able: AnyObject, i_products_to_swept: tuple, i_product_reference: Product, i_lod_mode: int, i_accuracy: float, i_shape_name: str, i_activated_shape: int, i_default_shape: int) → SweptVolume

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddFromSweptAble(CATBaseDispatch iSweptAble,
CATSafeArrayVariant iProductsToSwept,
Product iProductReference,
long iLODMode,
double iAccuracy,
CATBSTR iShapeName,
long iActivatedShape,
long iDefaultShape) As SweptVolume

Creates a new SweptVolume and adds it to the SweptVolumes collection. This
function is deprecated.

Returns:
The created SweptVolume
Parameters:

  • i_swept_able (AnyObject) –

  • i_products_to_swept (tuple) –

  • i_product_reference (Product) –

  • i_lod_mode (int) –

  • i_accuracy (float) –

  • i_shape_name (str) –

  • i_activated_shape (int) –

  • i_default_shape (int) –

Return type:

SweptVolume

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_swept_volume(i_replay: Replay, i_swept_able: AnyObject, i_products_to_swept: tuple, i_product_reference: Product, i_lod_mode: int, i_accuracy: float, i_wrapping_grain: float, i_wrapping_ratio: float, i_simplify_accuracy: float) → Document

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func ComputeASweptVolume(Replay iReplay,
CATBaseDispatch iSweptAble,
CATSafeArrayVariant iProductsToSwept,
Product iProductReference,
long iLODMode,
double iAccuracy,
double iWrappingGrain,
double iWrappingRatio,
double iSimplifAccuracy) As Document

Computes a swept volume. This function is deprecated.

Returns:
The created SweptVolume
Parameters:

  • i_replay (Replay) –

  • i_swept_able (AnyObject) –

  • i_products_to_swept (tuple) –

  • i_product_reference (Product) –

  • i_lod_mode (int) –

  • i_accuracy (float) –

  • i_wrapping_grain (float) –

  • i_wrapping_ratio (float) –

  • i_simplify_accuracy (float) –

Return type:

Document

compute_a_swept_volume_from_replay(i_replay: Replay, i_products_to_swept: tuple, i_product_reference: Product, i_lod_mode: int, i_accuracy: float, i_wrapping_grain: float, i_wrapping_ratio: float, i_simplif_accuracy: float) → Document

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func ComputeASweptVolumeFromReplay(Replay iReplay,
CATSafeArrayVariant iProductsToSwept,
Product iProductReference,
long iLODMode,
double iAccuracy,
double iWrappingGrain,
double iWrappingRatio,
double iSimplifAccuracy) As Document

Computes a swept volume. This function is deprecated.

Returns:
The created SweptVolume
Parameters:

  • i_replay (Replay) –

  • i_products_to_swept (tuple) –

  • i_product_reference (Product) –

  • i_lod_mode (int) –

  • i_accuracy (float) –

  • i_wrapping_grain (float) –

  • i_wrapping_ratio (float) –

  • i_simplif_accuracy (float) –

Return type:

Document

compute_a_swept_volume_from_sweptable(i_swept_able: AnyObject, i_products_to_swept: tuple, i_product_reference: Product, i_lod_mode: int, i_accuracy: float, i_wrapping_grain: float, i_wrapping_ratio: float, i_simplify_accuracy: float) → Document

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func ComputeASweptVolumeFromSweptable(CATBaseDispatch
iSweptAble,
CATSafeArrayVariant iProductsToSwept,
Product iProductReference,
long iLODMode,
double iAccuracy,
double iWrappingGrain,
double iWrappingRatio,
double iSimplifAccuracy) As Document

Computes a swept volume. This function is deprecated.

Returns:
The created SweptVolume
Parameters:

  • i_swept_able (AnyObject) –

  • i_products_to_swept (tuple) –

  • i_product_reference (Product) –

  • i_lod_mode (int) –

  • i_accuracy (float) –

  • i_wrapping_grain (float) –

  • i_wrapping_ratio (float) –

  • i_simplify_accuracy (float) –

Return type:

Document

compute_swept_volumes(i_replay: Replay, i_swept_able: AnyObject, i_products_to_swept: tuple, i_product_reference: Product, i_lod_mode: int, i_accuracy: float, i_perform_wrapping: int, i_perform_simplif: int, i_wrapping_grain: float, i_wrapping_ratio: float, i_simplify_accuracy: float, o_swept_volume_documents: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ComputeSweptVolumes(Replay iReplay,
CATBaseDispatch iSweptAble,
CATSafeArrayVariant iProductsToSwept,
Product iProductReference,
long iLODMode,
double iAccuracy,
long iPerformWrapping,
long iPerformSimplif,
double iWrappingGrain,
double iWrappingRatio,
double iSimplifAccuracy,
CATSafeArrayVariant oSweptVolumeDocuments)

Computes a swept volume, from a replay or a track.

Parameters:

iReplay
Replay on which we perfom the swept volume. Can be NULL.

iSweptAble
Track (or any other thing that implements CATISweptAble) on which
we perfom the swept volume. Can be NULL.
iProductsToSwept
Selection of products to sweep.
iProductReference
Product taken as a reference.
iLODMode
Do we want levels of details or not?
iAccuracy
Filtering positions parameter.
iPerformWrapping
Do we perform a wrapping?
iPerformSimplif
Do we perform a simplification?
iWrappingGrain
Grain for wrapping.
iWrappingRatio
Offset ratio for wrapping.
iSimplifAccuracy
Accuracy for simplification.

Returns:
oSweptVolumeDocuments: Documents containing the results.
Parameters:

  • i_replay (Replay) –

  • i_swept_able (AnyObject) –

  • i_products_to_swept (tuple) –

  • i_product_reference (Product) –

  • i_lod_mode (int) –

  • i_accuracy (float) –

  • i_perform_wrapping (int) –

  • i_perform_simplify (int) –

  • i_wrapping_grain (float) –

  • i_wrapping_ratio (float) –

  • i_simplif_accuracy (float) –

  • o_swept_volume_documents (tuple) –

Return type:

None

compute_swept_volumes_from_replay(i_replay: Replay, i_products_to_swept: tuple, i_product_reference: Product, i_lod_mode: int, i_accuracy: float, i_perform_wrapping: int, i_perform_simplify: int, i_wrapping_grain: float, i_wrapping_ratio: float, i_simplif_accuracy: float, o_swept_volume_documents: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ComputeSweptVolumesFromReplay(Replay iReplay,
CATSafeArrayVariant iProductsToSwept,
Product iProductReference,
long iLODMode,
double iAccuracy,
long iPerformWrapping,
long iPerformSimplif,
double iWrappingGrain,
double iWrappingRatio,
double iSimplifAccuracy,
CATSafeArrayVariant oSweptVolumeDocuments)

Computes a swept volume from a replay.

Parameters:

iReplay
Replay on which we perfom the swept volume.
iProductsToSwept
Selection of products to sweep.
iProductReference
Product taken as a reference.
iLODMode
Do we want levels of details or not?
iAccuracy
Filtering positions parameter.
iPerformWrapping
Do we perform a wrapping?
iPerformSimplif
Do we perform a simplification?
iWrappingGrain
Grain for wrapping.
iWrappingRatio
Offset ratio for wrapping.
iSimplifAccuracy
Accuracy for simplification.

Returns:
oSweptVolumeDocuments: Documents containing the results.
Parameters:

  • i_replay (Replay) –

  • i_products_to_swept (tuple) –

  • i_product_reference (Product) –

  • i_lod_mode (int) –

  • i_accuracy (float) –

  • i_perform_wrapping (int) –

  • i_perform_simplify (int) –

  • i_wrapping_grain (float) –

  • i_wrapping_ratio (float) –

  • i_simplif_accuracy (float) –

  • o_swept_volume_documents (tuple) –

Return type:

None

compute_swept_volumes_from_sweptable(i_swept_able: AnyObject, i_products_to_swept: tuple, i_product_reference: Product, i_lod_mode: int, i_accuracy: float, i_perform_wrapping: int, i_perform_simplify: int, i_wrapping_grain: float, i_wrapping_ratio: float, i_simplify_accuracy: float, o_swept_volume_documents: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub ComputeSweptVolumesFromSweptable(CATBaseDispatch
iSweptAble,
CATSafeArrayVariant iProductsToSwept,
Product iProductReference,
long iLODMode,
double iAccuracy,
long iPerformWrapping,
long iPerformSimplif,
double iWrappingGrain,
double iWrappingRatio,
double iSimplifAccuracy,
CATSafeArrayVariant oSweptVolumeDocuments)

Computes a swept volume from a track.

Parameters:

iSweptAble
Track (or any other thing that implements CATISweptAble) on which
we perfom the swept volume.
iProductsToSwept
Selection of products to sweep.
iProductReference
Product taken as a reference.
iLODMode
Do we want levels of details or not?
iAccuracy
Filtering positions parameter.
iPerformWrapping
Do we perform a wrapping?
iPerformSimplif
Do we perform a simplification?
iWrappingGrain
Grain for wrapping.
iWrappingRatio
Offset ratio for wrapping.
iSimplifAccuracy
Accuracy for simplification.

Returns:
oSweptVolumeDocuments: Documents containing the results.
Parameters:

  • i_swept_able (AnyObject) –

  • i_products_to_swept (tuple) –

  • i_product_reference (Product) –

  • i_lod_mode (int) –

  • i_accuracy (float) –

  • i_perform_wrapping (int) –

  • i_perform_simplify (int) –

  • i_wrapping_grain (float) –

  • i_wrapping_ratio (float) –

  • i_simplify_accuracy (float) –

  • o_swept_volume_documents (tuple) –

Return type:

None

set_silhouette(on_off: int) → None

Note

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

Adds the possibility to make a silhouette before the swept volume
Parameters:

on_off (int) –

Return type:

None

set_spatial_split(on_off: int) → None

Note

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

Adds the possibility to parallelize swept&wrapping after a spatial split.
This gains in memory but not in CPU usage (takes longer.)
Parameters:

on_off (int) –

Return type:

None