pycatia.smt_interfaces.dmo_offsets

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.dmo_offsets.DMOOffsets(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

DMOOffsets

Interface to access a CATIADMOOffsets and compute Offsets

add(i_product_to_offset: Product, i_offset1: float, i_use_constraints: int, i_constraints: tuple, i_shape_name: str, i_activated_shape: int, i_default_shape: int) → DMOOffset

Note

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

o Func Add(Product iProductToOffset,

double iOffset1,

long iUseConstraints,

CATSafeArrayVariant iConstraints,

CATBSTR iShapeName,

long iActivatedShape,

long iDefaultShape) As DMOOffset

Creates a new Offset and adds it to the DMOOffsets collection. This

function is deprecated.

Returns:

The created offset

Example:

The following example creates an offset newOffset in the Offset

collection.

Set newOffset = DMOOffsets.Add

Parameters:

• i_product_to_offset (Product) –

• i_offset1 (float) –

• i_use_constraints (int) –

• i_constraints (tuple) –

• i_shape_name (str) –

• i_activated_shape (int) –

• i_default_shape (int) –

Return type:

DMOOffset

add_offset_from_vectors(i_product_to_offset: Product, i_offset_vectors: tuple, i_offset_values: tuple, i_shape_name: str, i_activated_shape: int, i_default_shape: int) → DMOOffset

Note

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

o Func AddOffsetFromVectors(Product iProductToOffset,

CATSafeArrayVariant iOffsetVectors,

CATSafeArrayVariant iOffsetValues,

CATBSTR iShapeName,

long iActivatedShape,

long iDefaultShape) As DMOOffset

Creates a new Offset from a set of vectors, and adds it to the DMOOffsets

collection. This function is deprecated.

Returns:

The created offset

Example:

The following example creates an offset newOffset in the Offset

collection.

Set newOffset = DMOOffsets.Add

Parameters:

• i_product_to_offset (Product) –

• i_offset_vectors (tuple) –

• i_offset_values (tuple) –

• i_shape_name (str) –

• i_activated_shape (int) –

• i_default_shape (int) –

Return type:

DMOOffset

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_an_offset(group_of_selected_products: Group, i_offset: float, i_use_constraints: int, i_constraints: tuple) → Document

Note

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

o Func ComputeAnOffset(Group GroupOfSelectedProducts,

double iOffset,

long iUseConstraints,

CATSafeArrayVariant iConstraints) As Document

Compute a offset on the selected products.

Parameters:

GroupOfSelectedProducts

The selected products on which you want to perform the offset.

iOffset

Offset value.

iUseConstraints

Do we use normals constraints or not ?

iConstraints

Constraints array.

Returns:

OffsetDocument: Document containing the result.

Parameters:

• group_of_selected_products (Group) –

• i_offset (float) –

• i_use_constraints (int) –

• i_constraints (tuple) –

Return type:

Document

compute_an_offset_from_vectors(group_of_selected_products: Group, i_offset_vectors: tuple, i_offset_values: tuple) → Document

Note

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

o Func ComputeAnOffsetFromVectors(Group

GroupOfSelectedProducts,

CATSafeArrayVariant iOffsetVectors,

CATSafeArrayVariant iOffsetValues) As Document

Compute an offset on the selected products, according to some

vectors

Parameters:

GroupOfSelectedProducts

The selected products on which you want to perform the offset.

iOffsetVectors

Vectors taken into account for the computation

iOffsetValues

Offset values.

Returns:

OffsetDocument: Document containing the result.

Parameters:

• group_of_selected_products (Group) –

• i_offset_vectors (tuple) –

• i_offset_values (tuple) –

Return type:

Document

compute_an_offset_from_vectors_with_a_reference(i_group_of_selected_products: Group, i_reference_product: Product, i_offset_vectors: tuple, i_offset_values: tuple) → Document

Note

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

o Func ComputeAnOffsetFromVectorsWithAReference(Group

iGroupOfSelectedProducts,

Product iReferenceProduct,

CATSafeArrayVariant iOffsetVectors,

CATSafeArrayVariant iOffsetValues) As Document

Compute an offset on the selected products, according to some vectors and a

reference product.

Parameters:

iGroupOfSelectedProducts

The selected products on which you want to perform the offset.

iReferenceProduct

The reference product.

iOffsetVectors

Vectors taken into account for the computation

iOffsetValues

Offset values.

Returns:

OffsetDocument: Document containing the result.

Parameters:

• i_group_of_selected_products (Group) –

• i_reference_product (Product) –

• i_offset_vectors (tuple) –

• i_offset_values (tuple) –

Return type:

Document

compute_an_offset_with_a_reference(i_group_of_selected_products: Group, i_reference_product: Product, i_offset: float, i_use_constraints: int, i_constraints: tuple) → Document

Note

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

o Func ComputeAnOffsetWithAReference(Group

iGroupOfSelectedProducts,

Product iReferenceProduct,

double iOffset,

long iUseConstraints,

CATSafeArrayVariant iConstraints) As Document

Compute an offset on the selected products, according to a reference

product.

Parameters:

iGroupOfSelectedProducts

The selected products on which you want to perform the offset.

iReferenceProduct

The reference product.

iOffset

Offset value.

iUseConstraints

Do we use normals constraints or not ?

iConstraints

Constraints array.

Returns:

OffsetDocument: Document containing the result.

Parameters:

• i_group_of_selected_products (Group) –

• i_reference_product (Product) –

• i_offset (float) –

• i_use_constraints (int) –

• i_constraints (tuple) –

Return type:

Document

offset_shape_name() → str

Note

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

o Func OffsetShapeName() As CATBSTR

Returns the name of the associated shape.

Return type:

str