pycatia.cat_tps_interfaces.capture

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.cat_tps_interfaces.capture.Capture(com_object)

Note

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

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

Capture

The interface to access a CATIACapture

property active_view: TPSView

Note

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

o Property ActiveView() As TPSView

Retrieves the active view for the capture.

Return type:

TPSView

property active_view_state: bool

Note

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

o Property ActiveViewState() As boolean

Retrieves the Active View state, saved or Not. The Active View state

describes what happens when Capture is displayed, if TRUE, the active view of

the tolerancing set is replaced by the active view of the capture.

Return type:

bool

property annotations: Annotations

Note

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

o Property Annotations() As Annotations

Retrieves the TPSs that are visualy managed by this Capture.

Return type:

Annotations

property camera: Camera3D

Note

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

o Property Camera() As Camera3D

Retrieves or sets a camera.

Return type:

Camera3D

property clipping_plane: bool

Note

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

o Property ClippingPlane() As boolean

Retrieves the clipping plane state, activated or Not. The Clipping plane

state describes what happens when Capture is displayed, if TRUE, the active

view is used to define a clipping plane. If FALSE, there is no clipping plane

applied.

Parameters:

oClipPlane

The clipping plane state.

Return type:

bool

property current: bool

Note

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

o Property Current() As boolean

Retrieves the Capture state, current or Not.

Parameters:

oCurrentState

Capture state. if TRUE the capture is current.that means that after

the creation of the capture, the future TPSs that would be added to the

document will belong to the capture.

Return type:

bool

display_capture() → None

Note

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

o Sub DisplayCapture()

Displays the Capture.

Return type:

None

display_capture_2(ib_apply_mirror: bool) → None

Note

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

o Sub DisplayCapture2(boolean ibApplyMirror)

Displays the Capture with mirroring annotations

management.

Parameters:

out

boolean ibApplyMirror [out] Annotations mirroring management: TRUE:

The annotations mirroring is activated. FALSE: The annotations mirroring is

desactivated.

Parameters:

ib_apply_mirror (bool) –

Return type:

None

get_nbr_of_part_inst_and_body() → int

Introduced in V5-6R2022.

Note

CAA V5 Visual Basic Help (2026-02-21 15:26:49.309967)

Func GetNbrOfPartInstAndBody() As long

Reads the number of Body and Part Instances assigned to this Capture. This

call is to be called just before @GetPartInstAndBody to allocate the array with

the accurate size. This call is working properly only if ManageHideShowBody is

set to True.

Parameters:

oEntityCount

The number of Part Instance(s) and/or Body(ies) associated with the

Capture.

Return type:

int

get_part_inst_and_body(o_list_of_elements: tuple) → None

Introduced in V5-6R2022.

Note

CAA V5 Visual Basic Help (2026-02-21 15:26:49.309967)

Sub GetPartInstAndBody(CATSafeArrayVariant oListOfElements)

Returns the list of Body and Part Instances. This call is working properly

only if ManageHideShowBody is set to True.

Parameters:

oListOfElements

The list of Part Instance(s) and Body(s) bound to this Capture. It

is returned as an array of SafeArrayVariant whose size is given by

GetNbrOfPartInstAndBody.

Note: You can access each constraint as follows:

1 is in oListOfElements(0)

2 is in oListOfElements(1)

oEntityCount is in oListOfElements(oEntityCount-1)

Parameters:

o_list_of_elements (tuple) –

Return type:

None

property manage_hide_show_body: bool

Note

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

o Property ManageHideShowBody() As boolean

Manages the visibility of Part instances, bodies and geometrical sets

across the Capture.

Parameters:

obManageHideShowBody

TRUE: If Hide/Show of these elements will be managed FALSE: If

Hide/Show of these elements will not be managed

Return type:

bool

property set: AnnotationSet

Note

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

o Property Set() As AnnotationSet (Read Only)

Retrieves tolerancing set the Capture belongs too.

Return type:

AnnotationSet

set_part_inst_and_body(i_list_of_elements: tuple, i_entity_count: int) → None

Introduced in V5-6R2022.

Note

CAA V5 Visual Basic Help (2026-02-21 15:26:49.309967)

Sub SetPartInstAndBody(CATSafeArrayVariant iListOfElements,long

iEntityCount)

Sets the list of Body and Part Instances. This call is working properly

only if ManageHideShowBody is set to True.

Parameters:

iListOfElements

The list of Part Instance(s) and Body(s) to assign to this Capture.

iEntityCount of elements are taken for the SafeArrayVariant.

iEntityCount

The number of items in the given stack.

Parameters:

• i_list_of_elements (tuple) –

• i_entity_count (int) –

Return type:

None

tps_parallel_on_screen() → TPSParallelOnScreen

Note

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

o Func TPSParallelOnScreen() As TPSParallelOnScreen

Gets the annotation on TPSParallelOnScreen interface.

Return type:

TPSParallelOnScreen

property tps_views: TPSViews

Note

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

o Property TPSViews() As TPSViews

Retrieves the TPS Views that are visualy managed by this Capture.

Return type:

TPSViews

property view_point: bool

Note

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

o Property ViewPoint() As boolean

Retrieves the ViewPoint state, saved or Not. The ViewPoint state describes

what happens when Capture is displayed, if TRUE, the 3D Camera of the Capture

is used to change the 3D ViewPoint.

Return type:

bool