pycatia.part_interfaces.trim

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.part_interfaces.trim.Trim(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

MecModInterfaces.Shape

PartInterfaces.BooleanShape

Trim

Represents the Trim, or union trim boolean operation.

It is performed between a body and the current shape.

add_face_to_keep(i_face_to_keep: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub AddFaceToKeep(Reference iFaceToKeep)

Adds a new face to be kept (if face is not divided by

operation).

Parameters:

iFaceToKeep

The new face to process

The following

Boundary object is supported: Face.

Example:

The following example adds the new face face to Keep for the Trim

firstTrim:

call firstTrim.AddFaceToKeep(face)

Parameters:

i_face_to_keep (Reference) –

Return type:

None

add_face_to_keep2(i_face_to_keep: Reference, i_face_adjacent_for_keep: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub AddFaceToKeep2(Reference iFaceToKeep,

Reference iFaceAdjacentForKeep)

Adds a new face to be kept (if face is divided by

operation).

Parameters:

iFaceToKeep

The new face to process

The following

Boundary object is supported: Face.

iFaceAdjacentForKeep

An adjacent face of iFaceToKeep belonging to the other

operand

The following Boundary object is supported: Face.

Example:

The following example adds the new face face to Keep for the Trim

firstTrim:

call firstTrim.AddFaceToKeep(face)

Parameters:

• i_face_to_keep (Reference) –

• i_face_adjacent_for_keep (Reference) –

Return type:

None

add_face_to_remove(i_face_to_remove: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub AddFaceToRemove(Reference iFaceToRemove)

Adds a new face to be Removed (if face not divided by

operation).

Parameters:

iFaceToRemove

The new face to process

The following

Boundary object is supported: Face.

Example:

The following example adds the new face face to Remove for the Trim

firstTrim:

call firstTrim.AddFaceToRemove(face)

Parameters:

i_face_to_remove (Reference) –

Return type:

None

add_face_to_remove2(i_face_to_remove: Reference, i_face_adjacent_for_remove: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub AddFaceToRemove2(Reference iFaceToRemove,

Reference iFaceAdjacentForRemove)

Adds a new face to be Removed (if face is divided by

operation).

Parameters:

iFaceToRemove

The new face to process

The following

Boundary object is supported: Face.

iFaceAdjacentForRemove

An adjacent face of iFaceToRemove belonging to the other

operand

The following Boundary object is supported: Face.

Example:

The following example adds the new face face to Remove for the Trim

firstTrim:

call firstTrim.AddFaceToRemove(face)

Parameters:

• i_face_to_remove (Reference) –

• i_face_adjacent_for_remove (Reference) –

Return type:

None

withdraw_face_to_keep(i_face_to_withdraw: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub WithdrawFaceToKeep(Reference iFaceToWithdraw)

Withdraws an existing Kept face (if face is not divided by operation)

.

Parameters:

iFaceToWithdraw

The face to withdraw

The following

Boundary object is supported: Face.

Example:

The following example withdraws the existing face Kept face from the Trim

firstTrim:

call firstTrim.WithdrawFaceToKeep(face)

Parameters:

i_face_to_withdraw (Reference) –

Return type:

None

withdraw_face_to_keep2(i_face_to_withdraw: Reference, i_face_adjacent_for_keep: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub WithdrawFaceToKeep2(Reference iFaceToWithdraw,

Reference iFaceAdjacentForKeep)

Withdraws an existing Kept face (if face is divided by

operation).

Parameters:

iFaceToWithdraw

The face to withdraw

The following

Boundary object is supported: Face.

iFaceAdjacentForKeep

An adjacent face of iFaceToKeep belonging to the other

operand

The following Boundary object is supported: Face.

Example:

The following example withdraws the existing face Kept face from the Trim

firstTrim:

call firstTrim.WithdrawFaceToKeep(face)

Parameters:

• i_face_to_withdraw (Reference) –

• i_face_adjacent_for_keep (Reference) –

Return type:

None

withdraw_face_to_remove(i_face_to_withdraw: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub WithdrawFaceToRemove(Reference iFaceToWithdraw)

Withdraws an existing Removed face (if face not divided by

operation).

Parameters:

iFaceToWithdraw

The face to withdraw

The following

Boundary object is supported: Face.

Example:

The following example withdraws the existing face Removed face from the

Trim firstTrim:

call firstTrim.WithdrawFaceToRemove(face)

Parameters:

i_face_to_withdraw (Reference) –

Return type:

None

withdraw_face_to_remove2(i_face_to_withdraw: Reference, i_face_adjacent_for_remove: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub WithdrawFaceToRemove2(Reference iFaceToWithdraw,

Reference iFaceAdjacentForRemove)

Withdraws an existing Removed face (if face is divided by

operation).

Parameters:

iFaceToWithdraw

The face to withdraw

The following

Boundary object is supported: Face.

iFaceAdjacentForRemove

An adjacent face of iFaceToRemove belonging to the other

operand

The following Boundary object is supported: Face.

Example:

The following example withdraws the existing face Removed face from the

Trim firstTrim:

call firstTrim.WithdrawFaceToRemove(face)

Parameters:

• i_face_to_withdraw (Reference) –

• i_face_adjacent_for_remove (Reference) –

Return type:

None