pycatia3dx.interfaces.selection

Module initially auto generated using DSYAutomation files from CATIA 3DX R2025x on 2025-09-13 15:35:27.265802

Warning

The notes denoted “3DEXPERIENCE Automation 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 pycatia3dx.interfaces.selection.Selection(com_object)
add(i_object: AnyObject) → None
Parameters:

i_object (AnyObject)

Returns:

None

clear() → None
Returns:

None

copy() → None
Returns:

None

property count: int
Returns:

int

property count2: int
Returns:

int

cut() → None
Returns:

None

delete() → None
Returns:

None

filter_correspondence(i_filter_type: tuple) → bool
Parameters:

i_filter_type (tuple)

Returns:

bool

find_object(i_object_type: str) → AnyObject
Parameters:

i_object_type (str)

Returns:

AnyObject

indicate_or_select_element_2d(i_message: str, i_filter_type: tuple, i_may_skip_interactive_selection: bool, i_tooltip: bool, i_triggering_on_mouse_move: bool, o_object_selected: bool, o_window_location: tuple) → str
Parameters:
  • i_message (str)

  • i_filter_type (tuple)

  • i_may_skip_interactive_selection (bool)

  • i_tooltip (bool)

  • i_triggering_on_mouse_move (bool)

  • o_object_selected (bool)

  • o_window_location (tuple)

Returns:

str

indicate_or_select_element_3d(i_planar_geometric_object: AnyObject, i_message: str, i_filter_type: tuple, i_may_skip_interactive_selection: bool, i_tooltip: bool, i_triggering_on_mouse_move: bool, o_object_selected: bool, o_window_location_2d: tuple, o_window_location_3d: tuple) → str
Parameters:
  • i_planar_geometric_object (AnyObject)

  • i_message (str)

  • i_filter_type (tuple)

  • i_may_skip_interactive_selection (bool)

  • i_tooltip (bool)

  • i_triggering_on_mouse_move (bool)

  • o_object_selected (bool)

  • o_window_location_2d (tuple)

  • o_window_location_3d (tuple)

Returns:

str

item(i_index: int) → SelectedElement
Parameters:

i_index (int)

Returns:

SelectedElement

item2(i_index: int) → SelectedElement
Parameters:

i_index (int)

Returns:

SelectedElement

paste() → None
Returns:

None

paste_from(i_objects: tuple) → None
Parameters:

i_objects (tuple)

Returns:

None

paste_special(i_format: str) → None
Parameters:

i_format (str)

Returns:

None

remove(i_index: int) → None
Parameters:

i_index (int)

Returns:

None

remove2(i_index: int) → None
Parameters:

i_index (int)

Returns:

None

search(i_string_bstr: str) → None
Parameters:

i_string_bstr (str)

Returns:

None

select_element(i_filter_type: tuple, i_message: str, i_may_skip_interactive_selection: bool) → str
Parameters:
  • i_filter_type (tuple)

  • i_message (str)

  • i_may_skip_interactive_selection (bool)

Returns:

str

select_element2(i_filter_type: tuple, i_message: str, i_object_selection_before_command_use_possibility: bool) → str
Parameters:
  • i_filter_type (tuple)

  • i_message (str)

  • i_object_selection_before_command_use_possibility (bool)

Returns:

str

select_element3(i_filter_type: tuple, i_message: str, i_object_selection_before_command_use_possibility: bool, i_multi_selection_mode: CATMultiSelectionMode, i_tooltip: bool) → str
Parameters:
  • i_filter_type (tuple)

  • i_message (str)

  • i_object_selection_before_command_use_possibility (bool)

  • i_multi_selection_mode (CATMultiSelectionMode)

  • i_tooltip (bool)

Returns:

str

select_element_other_editor(i_filter_type: tuple, i_active_editor_message: str, i_non_active_editor_message: str, i_tooltip: bool, o_editor: Editor) → str
Parameters:
  • i_filter_type (tuple)

  • i_active_editor_message (str)

  • i_non_active_editor_message (str)

  • i_tooltip (bool)

  • o_editor (Editor)

Returns:

str

select_multiple_elements(i_filter_type: tuple, i_message: str, i_may_skip_interactive_selection: bool, i_multi_selection_mode: CATMultiSelectionMode, i_tooltip: bool) → str
Parameters:
  • i_filter_type (tuple)

  • i_message (str)

  • i_may_skip_interactive_selection (bool)

  • i_multi_selection_mode (CATMultiSelectionMode)

  • i_tooltip (bool)

Returns:

str

property vis_properties: VisPropertySet
Returns:

VisPropertySet