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.IUnknownSystem.IDispatchSystem.CATBaseUnknownSystem.CATBaseDispatchSystem.AnyObjectCaptureThe 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 TPSViewRetrieves the active view for the capture.
- Return type:
- property active_view_state: bool¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
- o Property ActiveViewState() As booleanRetrieves the Active View state, saved or Not. The Active View statedescribes what happens when Capture is displayed, if TRUE, the active view ofthe 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 AnnotationsRetrieves the TPSs that are visualy managed by this Capture.
- Return type:
- property camera: Camera3D¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
- o Property Camera() As Camera3DRetrieves or sets a camera.
- Return type:
- property clipping_plane: bool¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
- o Property ClippingPlane() As booleanRetrieves the clipping plane state, activated or Not. The Clipping planestate describes what happens when Capture is displayed, if TRUE, the activeview is used to define a clipping plane. If FALSE, there is no clipping planeapplied.Parameters:oClipPlaneThe 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 booleanRetrieves the Capture state, current or Not.Parameters:oCurrentStateCapture state. if TRUE the capture is current.that means that afterthe creation of the capture, the future TPSs that would be added to thedocument 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 annotationsmanagement.Parameters:outboolean ibApplyMirror [out] Annotations mirroring management: TRUE:The annotations mirroring is activated. FALSE: The annotations mirroring isdesactivated.
- Parameters:
ib_apply_mirror (bool) –
- 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 booleanManages the visibility of Part instances, bodies and geometrical setsacross the Capture.Parameters:obManageHideShowBodyTRUE: If Hide/Show of these elements will be managed FALSE: IfHide/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:
- tps_parallel_on_screen() TPSParallelOnScreen ¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
- o Func TPSParallelOnScreen() As TPSParallelOnScreenGets the annotation on TPSParallelOnScreen interface.
- Return type:
- property tps_views: TPSViews¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
- o Property TPSViews() As TPSViewsRetrieves the TPS Views that are visualy managed by this Capture.
- Return type:
- property view_point: bool¶
Note
- CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
- o Property ViewPoint() As booleanRetrieves the ViewPoint state, saved or Not. The ViewPoint state describeswhat happens when Capture is displayed, if TRUE, the 3D Camera of the Captureis used to change the 3D ViewPoint.
- Return type:
bool