Selection Class

class NXOpen.Selection

Bases: object

Defines an interface object for executing selection operations

To obtain an instance of this class, refer to NXOpen.UI

New in version NX3.0.0.

Methods

Method Description
AddToSelectionList Add objects to the selection list.
AddToTaggedObjectsSelectionList Add objects to the selection list.
AskSelectionCursorPosition Returns the view and absolute coordinates of the cursor position for the associated selection.
AskSelectionDescriptor Returns the information in SelectionSelectionDescriptor_Struct describing the selection that was just performed.
AskSelectionListCount Returns the number of objects currently selected.
AskSelectionObjectList Returns the number of objects selected and a pointer to an array of tags of the objects selected.
AskSelectionRectanglePosition Returns the absolute coordinates of the rectangle cursor positions.
AskSelectionTaggedObjectList Returns the number of tagged objects selected and a pointer to an array of tags of the objects selected.
ClearGlobalSelectionList Clears the Global Selection list
CreateSelectionSubscriber Creates a Selection Subscriber
GetNumSelectedObjects Returns the number of objects currently selected
GetSelectedObject Returns the n’th object on the selection list
GetSelectedTaggedObject Returns the n’th tagged object on the selection list
GetSelectionStatusOfUserDefinedClass Gets whether or not the user defined class is available for selection.
IsGlobalSelectionActive Inquires whether or not Global Selection is active (no active dialog)
IsObjectInSelectionList Inquires if object is selected.
RemoveAllFromSelectionList Removes all the objects from the selection list and optionally unhighlights them.
RemoveFromSelectionList Removes objects from the selection list.
RemoveTaggedObjectsFromSelectionList Removes tagged objects from the selection list.
RequestDeselections Submit a request to the current selection owner to deselect the given objects.
RequestSelections Submit a request to the current selection owner to select the given objects.
SelectFeatures Select features
SelectObject Select single object.
SelectObjects Select objects.
SelectScreenPosition Select screen position on graphics display
SelectTaggedObject Select single tagged object.
SelectTaggedObjects Select tagged objects.
SetSelectType Sets the selection type.
SetSelectionCallbacks Specify selection filter callback for additional filtering based on application specific criteria, and/or selection callback to perform application specific processing for each selection gesture processed.
SetSelectionMask Sets the types of objects that are selectable.
SetSelectionStatusOfUserDefinedClass Sets whether or not the user defined class is available for selection.
SetTaggedObjectSelectionCallbacks Specify selection filter callback for additional filtering of tagged objects based on application specific criteria, and/or selection callback to perform application specific processing for each selection gesture processed.

Enumerations

SelectionDialogResponse Enumeration Specify the user response for general dialogs.
SelectionResponse Enumeration Specify the user response for the selection operation.
SelectionSelectionAction Enumeration Indicates the type of action to perform when an object is selected.
SelectionSelectionFeatureType Enumeration Specify the type of features to select.
SelectionSelectionScope Enumeration Indicates the scope for selecting objects.
SelectionSelectionType Enumeration Indicates the general class of object to filter selection.
SelectionUistylerSelectionType Enumeration Indicates the general class of object to filter selection.

Structs

SelectionMaskTriple_Struct Struct Used in selection methods to set the types of objects that are selectable.
SelectionSelectionDescriptor_Struct Struct For a rectangle deselection, the fields ** Deselection **, ** MultipleSelection **, ** Rectangle ** bits would be set.

Method Detail

AddToSelectionList

Selection.AddToSelectionList

Add objects to the selection list.

Any objects already in the selection list are ignored. Use this function with UIStyler dialogs. You can call this from the constructor callback/selection initialization procedure to begin the dialog with objects already selected. The user can then review these objects, and if desired, deselect them.

The application selection callback can also call this function to add other objects to the selection list based on the objects(s) just selected. The selection filter procedure cannot call this function. Based on the object(s) just selected, other objects may need to be selected. For example, all edges of the selected face or all faces tangent to the selected face.

Signature AddToSelectionList(select, objs, highlightFlag)

Parameters:

New in version NX5.0.0.

Deprecated since version NX8.0.0: Use Selection.AddToTaggedObjectsSelectionList() instead

License requirements: None.

AddToTaggedObjectsSelectionList

Selection.AddToTaggedObjectsSelectionList

Add objects to the selection list.

Any objects already in the selection list are ignored. Use this function with UIStyler dialogs. You can call this from the constructor callback/selection initialization procedure to begin the dialog with objects already selected. The user can then review these objects, and if desired, deselect them.

The application selection callback can also call this function to add other objects to the selection list based on the objects(s) just selected. The selection filter procedure cannot call this function. Based on the object(s) just selected, other objects may need to be selected. For example, all edges of the selected face or all faces tangent to the selected face.

Signature AddToTaggedObjectsSelectionList(select, objs, highlightFlag)

Parameters:

New in version NX7.5.4.

License requirements: None.

AskSelectionCursorPosition

Selection.AskSelectionCursorPosition

Returns the view and absolute coordinates of the cursor position for the associated selection.

If an object was selected, the view returned is the view in which the object was selected. For single position, the view is the view of the cursor. If the object was selected by name, view = None and the cursor position is undefined.

Signature AskSelectionCursorPosition(select)

Parameters:select (NXOpen.SelectionHandle) – Selection handle
Returns:a tuple
Return type:A tuple consisting of (position, view). position is a NXOpen.Point3d. view is a NXOpen.View.

New in version NX5.0.0.

License requirements: None.

AskSelectionDescriptor

Selection.AskSelectionDescriptor

Returns the information in SelectionSelectionDescriptor_Struct describing the selection that was just performed.

Signature AskSelectionDescriptor(select)

Parameters:select (NXOpen.SelectionHandle) –
Returns:
Return type:NXOpen.SelectionSelectionDescriptor_Struct

New in version NX5.0.0.

License requirements: None.

AskSelectionListCount

Selection.AskSelectionListCount

Returns the number of objects currently selected.

Use this function with UIStyler dialogs.

Signature AskSelectionListCount(select)

Parameters:select (NXOpen.SelectionHandle) – Selection handle
Returns:Count of objects selected
Return type:int

New in version NX5.0.0.

License requirements: None.

AskSelectionObjectList

Selection.AskSelectionObjectList

Returns the number of objects selected and a pointer to an array of tags of the objects selected.

Use this function with UIStyler dialogs.

Signature AskSelectionObjectList(select)

Parameters:select (NXOpen.SelectionHandle) – Selection handle
Returns:Selected objects.
Return type:list of NXOpen.NXObject

New in version NX5.0.0.

Deprecated since version NX8.0.0: Use Selection.AskSelectionTaggedObjectList() instead

License requirements: None.

AskSelectionRectanglePosition

Selection.AskSelectionRectanglePosition

Returns the absolute coordinates of the rectangle cursor positions.

The view that returns is the view of the button down position.

button down position - is the position where you press and hold mouse button 1. button up position - is the position where you release mouse button 1.

Pos1 and Pos2 are the absolute coordinates of the button down and button up positions respectively. Pos3 is the absolute coordinates of the rectangle corner which, as viewed on the screen, is horizontal with pos1. Pos4 is the absolute coordinates of the rectangle corner which, as viewed on the screen, is horizontal with pos2. Returns an error if the last gesture was not rectangle.

Signature AskSelectionRectanglePosition(select)

Parameters:select (NXOpen.SelectionHandle) – Selection handle
Returns:a tuple
Return type:A tuple consisting of (view, position1, position2, position3, position4). view is a NXOpen.View. View of button down position position1 is a NXOpen.Point3d. Absolute coordinates of the button down position position2 is a NXOpen.Point3d. Absolute coordinates of the button up position position3 is a NXOpen.Point3d. Absolute coordinates of corner of screen rectangle which is horizontal with button down positionposition4 is a NXOpen.Point3d. Absolute coordinates of corner of screen rectangle which is horizontal with button up position

New in version NX5.0.0.

License requirements: None.

AskSelectionTaggedObjectList

Selection.AskSelectionTaggedObjectList

Returns the number of tagged objects selected and a pointer to an array of tags of the objects selected.

Use this function with UIStyler dialogs.

Signature AskSelectionTaggedObjectList(select)

Parameters:select (NXOpen.SelectionHandle) – Selection handle
Returns:Selected objects.
Return type:list of NXOpen.TaggedObject

New in version NX7.5.4.

License requirements: None.

ClearGlobalSelectionList

Selection.ClearGlobalSelectionList

Clears the Global Selection list

Signature ClearGlobalSelectionList()

New in version NX11.0.0.

License requirements: None.

CreateSelectionSubscriber

Selection.CreateSelectionSubscriber

Creates a Selection Subscriber

Signature CreateSelectionSubscriber()

Returns:
Return type:NXOpen.SelectionSubscriber

New in version NX11.0.0.

License requirements: None.

GetNumSelectedObjects

Selection.GetNumSelectedObjects

Returns the number of objects currently selected

Signature GetNumSelectedObjects()

Returns:The number of objects currently selected
Return type:int

New in version NX3.0.0.

License requirements: None.

GetSelectedObject

Selection.GetSelectedObject

Returns the n’th object on the selection list

Signature GetSelectedObject(index)

Parameters:index (int) – The index. Should be between 0 and GetNumSelectedObjects()
Returns:The object at the given position on the selection list. Returns None if the index parameter

is greater than the length of the list :rtype: NXOpen.NXObject

New in version NX3.0.0.

Deprecated since version NX8.0.0: Use Selection.GetSelectedTaggedObject() instead

License requirements: None.

GetSelectedTaggedObject

Selection.GetSelectedTaggedObject

Returns the n’th tagged object on the selection list

Signature GetSelectedTaggedObject(index)

Parameters:index (int) – The index. Should be between 0 and GetNumSelectedObjects()
Returns:The object at the given position on the selection list. Returns None if the index parameter

is greater than the length of the list :rtype: NXOpen.TaggedObject

New in version NX7.5.4.

License requirements: None.

GetSelectionStatusOfUserDefinedClass

Selection.GetSelectionStatusOfUserDefinedClass

Gets whether or not the user defined class is available for selection.

Signature GetSelectionStatusOfUserDefinedClass(udoClass)

Parameters:udoClass (NXOpen.UserDefinedObjects.UserDefinedClass) – The UserDefinedClass in question
Returns:Allow the selection of this UserDefinedClass
Return type:bool

New in version NX5.0.0.

License requirements: None.

IsGlobalSelectionActive

Selection.IsGlobalSelectionActive

Inquires whether or not Global Selection is active (no active dialog)

Signature IsGlobalSelectionActive()

Returns:True if Global Selection is active (no active dialog)
Return type:bool

New in version NX11.0.0.

License requirements: None.

IsObjectInSelectionList

Selection.IsObjectInSelectionList

Inquires if object is selected.

Use this function with UIStyler dialogs.

Signature IsObjectInSelectionList(select, object)

Parameters:
Returns:

If true, object is in the selection list, else false.
Return type:

bool

New in version NX5.0.0.

License requirements: None.

RemoveAllFromSelectionList

Selection.RemoveAllFromSelectionList

Removes all the objects from the selection list and optionally unhighlights them.

Use this function with UIStyler dialogs.

Signature RemoveAllFromSelectionList(select, unhighlight)

Parameters:

New in version NX5.0.0.

License requirements: None.

RemoveFromSelectionList

Selection.RemoveFromSelectionList

Removes objects from the selection list.

Use this function with UIStyler dialogs. It can be called from the selection callback. It cannot be called from the selection filter procedure.

If any of the objects are not in the list, an error is returned and NO objects are removed from the list.

It could be called by the selection callback to remove objects from the selection list. For example, based on objects just deselected, the application may need to remove other associated objects from the selection list.

Signature RemoveFromSelectionList(select, objs, unhighlight)

Parameters:

New in version NX5.0.0.

Deprecated since version NX8.0.0: Use Selection.RemoveTaggedObjectsFromSelectionList() instead

License requirements: None.

RemoveTaggedObjectsFromSelectionList

Selection.RemoveTaggedObjectsFromSelectionList

Removes tagged objects from the selection list.

Use this function with UIStyler dialogs. It can be called from the selection callback. It cannot be called from the selection filter procedure.

If any of the objects are not in the list, an error is returned and NO objects are removed from the list.

It could be called by the selection callback to remove objects from the selection list. For example, based on objects just deselected, the application may need to remove other associated objects from the selection list.

Signature RemoveTaggedObjectsFromSelectionList(select, objs, unhighlight)

Parameters:

New in version NX7.5.4.

License requirements: None.

RequestDeselections

Selection.RequestDeselections

Submit a request to the current selection owner to deselect the given objects.

Note that the selection owner may not allow some objects to be deselected.

Signature RequestDeselections(deselectList)

Parameters:deselectList (list of NXOpen.TaggedObject) –

New in version NX11.0.0.

License requirements: None.

RequestSelections

Selection.RequestSelections

Submit a request to the current selection owner to select the given objects.

Note that the selection owner may not allow some objects to be selected.

Signature RequestSelections(selectList)

Parameters:selectList (list of NXOpen.TaggedObject) –

New in version NX11.0.0.

License requirements: None.

SelectFeatures

Selection.SelectFeatures

Select features

Signature SelectFeatures(message, featType)

Parameters:
Returns:

a tuple
Return type:

A tuple consisting of (response, featureArray). response is a NXOpen.SelectionResponse. Ok, Back, or Cancel featureArray is a list of NXOpen.Features.Feature. The selected features

New in version NX3.0.0.

License requirements: None.

SelectObject

Selection.SelectObject

Overloaded method SelectObject

  • SelectObject(message, title, scope, includeFeatures, keepHighlighted)
  • SelectObject(message, title, scope, action, includeFeatures, keepHighlighted, maskArray)
  • SelectObject(message, title, scope, keepHighlighted, typeArray)

-------------------------------------

Select single object.

To enable selection of objects within drawing member views, use SetCursorView API available on UFUi.

Signature SelectObject(message, title, scope, includeFeatures, keepHighlighted)

Parameters:
  • message (str) – Cue line message to display
  • title (str) – Dialog title
  • scope (NXOpen.SelectionSelectionScope) – Selection scope
  • includeFeatures (bool) – Whether to allow the selection of features
  • keepHighlighted (bool) – Whether to keep the selection highlighted after it has been selected
Returns:

a tuple
Return type:

A tuple consisting of (response, object, cursor). response is a NXOpen.SelectionResponse. Ok, Back, Cancel, ObjectSelected, or ObjectSelectedByName object is a NXOpen.NXObject. The selected object cursor is a NXOpen.Point3d. Absolute coordinates of cursor position. This is undefined if object is selected by name

New in version NX3.0.0.

Deprecated since version NX8.0.0: Use Selection.SelectTaggedObject() instead

License requirements: None.

-------------------------------------

Select single object using filter defined by mask triples. To enable selection of objects within drawing member views, use SetCursorView API available on UFUi.

Signature SelectObject(message, title, scope, action, includeFeatures, keepHighlighted, maskArray)

Parameters:
  • message (str) – Cue line message to display
  • title (str) – Dialog title
  • scope (NXOpen.SelectionSelectionScope) – Selection scope
  • action (NXOpen.SelectionSelectionAction) – Indicates how the mask array will modify the selection filter
  • includeFeatures (bool) – Whether to allow the selection of features
  • keepHighlighted (bool) – Whether to keep the selection highlighted after it has been selected
  • maskArray (list of NXOpen.SelectionMaskTriple_Struct) – Modifies the list of object types that can be selected. How it modifies the list of object types is determined by the SelectionAction parameter.
Returns:

a tuple
Return type:

A tuple consisting of (response, object, cursor). response is a NXOpen.SelectionResponse. Ok, Back, Cancel, ObjectSelected, or ObjectSelectedByName object is a NXOpen.NXObject. The selected object cursor is a NXOpen.Point3d. Absolute coordinates of cursor position. This is undefined if object is selected by name

New in version NX3.0.0.

Deprecated since version NX8.0.0: Use Selection.SelectTaggedObject() instead

License requirements: None.

-------------------------------------

Select single object using filter defined by selection type.

To enable selection of objects within drawing member views, use SetCursorView API available on UFUi.

Signature SelectObject(message, title, scope, keepHighlighted, typeArray)

Parameters:
  • message (str) – Cue line message to display
  • title (str) – Dialog title
  • scope (NXOpen.SelectionSelectionScope) – Selection scope
  • keepHighlighted (bool) – Whether to keep the selection highlighted after it has been selected
  • typeArray (list of NXOpen.SelectionSelectionType) – The types of objects that can be selected
Returns:

a tuple
Return type:

A tuple consisting of (response, object, cursor). response is a NXOpen.SelectionResponse. Ok, Back, Cancel, ObjectSelected, or ObjectSelectedByName object is a NXOpen.NXObject. The selected object cursor is a NXOpen.Point3d. Absolute coordinates of cursor position. This is undefined if object is selected by name

New in version NX3.0.0.

Deprecated since version NX8.0.0: Use Selection.SelectTaggedObject() instead

License requirements: None.

-------------------------------------

SelectObjects

Selection.SelectObjects

Overloaded method SelectObjects

  • SelectObjects(message, title, scope, includeFeatures, keepHighlighted)
  • SelectObjects(message, title, scope, action, includeFeatures, keepHighlighted, maskArray)
  • SelectObjects(message, title, scope, keepHighlighted, typeArray)

-------------------------------------

Select objects.

To enable selection of objects within drawing member views, use SetCursorView API available on UFUi.

Signature SelectObjects(message, title, scope, includeFeatures, keepHighlighted)

Parameters:
  • message (str) – Cue line message to display
  • title (str) – Dialog title
  • scope (NXOpen.SelectionSelectionScope) – Selection scope
  • includeFeatures (bool) – Whether to allow the selection of features
  • keepHighlighted (bool) – Whether to keep the selection highlighted after it has been selected
Returns:

a tuple
Return type:

A tuple consisting of (response, objectArray). response is a NXOpen.SelectionResponse. Ok, Back, or Cancel objectArray is a list of NXOpen.NXObject. The selected objects

New in version NX3.0.0.

Deprecated since version NX8.0.0: Use Selection.SelectTaggedObjects() instead

License requirements: None.

-------------------------------------

Select objects using filter defined by mask triples.

To enable selection of objects within drawing member views, use SetCursorView API available on UFUi.

Signature SelectObjects(message, title, scope, action, includeFeatures, keepHighlighted, maskArray)

Parameters:
  • message (str) – Cue line message to display
  • title (str) – Dialog title
  • scope (NXOpen.SelectionSelectionScope) – Selection scope
  • action (NXOpen.SelectionSelectionAction) – Indicates how the mask array will modify the selection filter
  • includeFeatures (bool) – Whether to allow the selection of features
  • keepHighlighted (bool) – Whether to keep the selection highlighted after it has been selected
  • maskArray (list of NXOpen.SelectionMaskTriple_Struct) – Modifies the list of object types that can be selected. How it modifies the list of object types is determined by the SelectionAction parameter.
Returns:

a tuple
Return type:

A tuple consisting of (response, objectArray). response is a NXOpen.SelectionResponse. Ok, Back, or Cancel objectArray is a list of NXOpen.NXObject. The selected objects

New in version NX3.0.0.

Deprecated since version NX8.0.0: Use Selection.SelectTaggedObject() instead

License requirements: None.

-------------------------------------

Select objects using filter defined by selection type.

To enable selection of objects within drawing member views, use SetCursorView API available on UFUi.

Signature SelectObjects(message, title, scope, keepHighlighted, typeArray)

Parameters:
  • message (str) – Cue line message to display
  • title (str) – Dialog title
  • scope (NXOpen.SelectionSelectionScope) – Selection scope
  • keepHighlighted (bool) – Whether to keep the selection highlighted after it has been selected
  • typeArray (list of NXOpen.SelectionSelectionType) – The types that can be selected
Returns:

a tuple
Return type:

A tuple consisting of (response, objectArray). response is a NXOpen.SelectionResponse. Ok, Back, or Cancel objectArray is a list of NXOpen.NXObject. The selected objects

New in version NX3.0.0.

Deprecated since version NX8.0.0: Use Selection.SelectTaggedObject() instead

License requirements: None.

-------------------------------------

SelectScreenPosition

Selection.SelectScreenPosition

Select screen position on graphics display

Signature SelectScreenPosition(message)

Parameters:message (str) – Cue line message to display
Returns:a tuple
Return type:A tuple consisting of (response, object, screenPosition). response is a NXOpen.SelectionDialogResponse. Pick, Back, or Cancel object is a NXOpen.View. View of selected screen location screenPosition is a NXOpen.Point3d. Selected screen position

New in version NX3.0.0.

License requirements: None.

SelectTaggedObject

Selection.SelectTaggedObject

Overloaded method SelectTaggedObject

  • SelectTaggedObject(message, title, scope, includeFeatures, keepHighlighted)
  • SelectTaggedObject(message, title, scope, action, includeFeatures, keepHighlighted, maskArray)
  • SelectTaggedObject(message, title, scope, keepHighlighted, typeArray)

-------------------------------------

Select single tagged object.

To enable selection of objects within drawing member views, use SetCursorView API available on UFUi.

Signature SelectTaggedObject(message, title, scope, includeFeatures, keepHighlighted)

Parameters:
  • message (str) – Cue line message to display
  • title (str) – Dialog title
  • scope (NXOpen.SelectionSelectionScope) – Selection scope
  • includeFeatures (bool) – Whether to allow the selection of features
  • keepHighlighted (bool) – Whether to keep the selection highlighted after it has been selected
Returns:

a tuple
Return type:

A tuple consisting of (response, object, cursor). response is a NXOpen.SelectionResponse. Ok, Back, Cancel, ObjectSelected, or ObjectSelectedByName object is a NXOpen.TaggedObject. The selected object cursor is a NXOpen.Point3d. Absolute coordinates of cursor position. This is undefined if object is selected by name

New in version NX7.5.4.

License requirements: None.

-------------------------------------

Select single tagged object using filter defined by mask triples. To enable selection of objects within drawing member views, use SetCursorView API available on UFUi.

Signature SelectTaggedObject(message, title, scope, action, includeFeatures, keepHighlighted, maskArray)

Parameters:
  • message (str) – Cue line message to display
  • title (str) – Dialog title
  • scope (NXOpen.SelectionSelectionScope) – Selection scope
  • action (NXOpen.SelectionSelectionAction) – Indicates how the mask array will modify the selection filter
  • includeFeatures (bool) – Whether to allow the selection of features
  • keepHighlighted (bool) – Whether to keep the selection highlighted after it has been selected
  • maskArray (list of NXOpen.SelectionMaskTriple_Struct) – Modifies the list of object types that can be selected. How it modifies the list of object types is determined by the SelectionAction parameter.
Returns:

a tuple
Return type:

A tuple consisting of (response, object, cursor). response is a NXOpen.SelectionResponse. Ok, Back, Cancel, ObjectSelected, or ObjectSelectedByName object is a NXOpen.TaggedObject. The selected object cursor is a NXOpen.Point3d. Absolute coordinates of cursor position. This is undefined if object is selected by name

New in version NX7.5.4.

License requirements: None.

-------------------------------------

Select single tagged object using filter defined by selection type.

To enable selection of objects within drawing member views, use SetCursorView API available on UFUi.

Signature SelectTaggedObject(message, title, scope, keepHighlighted, typeArray)

Parameters:
  • message (str) – Cue line message to display
  • title (str) – Dialog title
  • scope (NXOpen.SelectionSelectionScope) – Selection scope
  • keepHighlighted (bool) – Whether to keep the selection highlighted after it has been selected
  • typeArray (list of NXOpen.SelectionSelectionType) – The types of objects that can be selected
Returns:

a tuple
Return type:

A tuple consisting of (response, object, cursor). response is a NXOpen.SelectionResponse. Ok, Back, Cancel, ObjectSelected, or ObjectSelectedByName object is a NXOpen.TaggedObject. The selected object cursor is a NXOpen.Point3d. Absolute coordinates of cursor position. This is undefined if object is selected by name

New in version NX7.5.4.

License requirements: None.

-------------------------------------

SelectTaggedObjects

Selection.SelectTaggedObjects

Overloaded method SelectTaggedObjects

  • SelectTaggedObjects(message, title, scope, includeFeatures, keepHighlighted)
  • SelectTaggedObjects(message, title, scope, action, includeFeatures, keepHighlighted, maskArray)
  • SelectTaggedObjects(message, title, scope, keepHighlighted, typeArray)

-------------------------------------

Select tagged objects.

To enable selection of objects within drawing member views, use SetCursorView API available on UFUi.

Signature SelectTaggedObjects(message, title, scope, includeFeatures, keepHighlighted)

Parameters:
  • message (str) – Cue line message to display
  • title (str) – Dialog title
  • scope (NXOpen.SelectionSelectionScope) – Selection scope
  • includeFeatures (bool) – Whether to allow the selection of features
  • keepHighlighted (bool) – Whether to keep the selection highlighted after it has been selected
Returns:

a tuple
Return type:

A tuple consisting of (response, objectArray). response is a NXOpen.SelectionResponse. Ok, Back, or Cancel objectArray is a list of NXOpen.TaggedObject. The selected objects

New in version NX7.5.4.

License requirements: None.

-------------------------------------

Select tagged objects using filter defined by mask triples.

To enable selection of objects within drawing member views, use SetCursorView API available on UFUi.

Signature SelectTaggedObjects(message, title, scope, action, includeFeatures, keepHighlighted, maskArray)

Parameters:
  • message (str) – Cue line message to display
  • title (str) – Dialog title
  • scope (NXOpen.SelectionSelectionScope) – Selection scope
  • action (NXOpen.SelectionSelectionAction) – Indicates how the mask array will modify the selection filter
  • includeFeatures (bool) – Whether to allow the selection of features
  • keepHighlighted (bool) – Whether to keep the selection highlighted after it has been selected
  • maskArray (list of NXOpen.SelectionMaskTriple_Struct) – Modifies the list of object types that can be selected. How it modifies the list of object types is determined by the SelectionAction parameter.
Returns:

a tuple
Return type:

A tuple consisting of (response, objectArray). response is a NXOpen.SelectionResponse. Ok, Back, or Cancel objectArray is a list of NXOpen.TaggedObject. The selected objects

New in version NX7.5.4.

License requirements: None.

-------------------------------------

Select tagged objects using filter defined by selection type.

To enable selection of objects within drawing member views, use SetCursorView API available on UFUi.

Signature SelectTaggedObjects(message, title, scope, keepHighlighted, typeArray)

Parameters:
  • message (str) – Cue line message to display
  • title (str) – Dialog title
  • scope (NXOpen.SelectionSelectionScope) – Selection scope
  • keepHighlighted (bool) – Whether to keep the selection highlighted after it has been selected
  • typeArray (list of NXOpen.SelectionSelectionType) – The types that can be selected
Returns:

a tuple
Return type:

A tuple consisting of (response, objectArray). response is a NXOpen.SelectionResponse. Ok, Back, or Cancel objectArray is a list of NXOpen.TaggedObject. The selected objects

New in version NX7.5.4.

License requirements: None.

-------------------------------------

SetSelectType

Selection.SetSelectType

Sets the selection type.

It can be called from a callback to change the type of selection associated with the dialog.

Signature SetSelectType(select, type)

Parameters:

New in version NX5.0.0.

License requirements: None.

SetSelectionCallbacks

Selection.SetSelectionCallbacks

Specify selection filter callback for additional filtering based on application specific criteria, and/or selection callback to perform application specific processing for each selection gesture processed.

Both the filter callback and the selection callback are passed object to SelectionHandle which can be used to inquire other selection data or modify selection. This selection handle object is no longer valid after the filter callback or selection callback is exited.

Signature SetSelectionCallbacks(select, filterproc, selcb)

Parameters:
  • select (NXOpen.SelectionHandle) – Selection handle
  • filterproc (CallableObject) – Filter callback for additional user specificfiltering.
  • selcb (CallableObject) – Selection callback for application specificprocessing.

New in version NX5.0.0.

Deprecated since version NX8.0.0: Use NXOpen.Selection.SetTaggedObjectSelectionCallbacks() instead

License requirements: None.

SetSelectionMask

Selection.SetSelectionMask

Sets the types of objects that are selectable.

If this function is not called to set the mask, then the default mask is all standard types.

Signature SetSelectionMask(select, action, maskArray)

Parameters:

New in version NX5.0.0.

License requirements: None.

SetSelectionStatusOfUserDefinedClass

Selection.SetSelectionStatusOfUserDefinedClass

Sets whether or not the user defined class is available for selection.

Signature SetSelectionStatusOfUserDefinedClass(udoClass, selectionStatus)

Parameters:

New in version NX5.0.0.

License requirements: None.

SetTaggedObjectSelectionCallbacks

Selection.SetTaggedObjectSelectionCallbacks

Specify selection filter callback for additional filtering of tagged objects based on application specific criteria, and/or selection callback to perform application specific processing for each selection gesture processed.

Both the filter callback and the selection callback are passed object to SelectionHandle which can be used to inquire other selection data or modify selection. This selection handle tagged object is no longer valid after the filter callback or selection callback is exited.

Signature SetTaggedObjectSelectionCallbacks(select, filterproc, selcb)

Parameters:
  • select (NXOpen.SelectionHandle) – Selection handle
  • filterproc (CallableObject) – Filter callback for additional user specificfiltering.
  • selcb (CallableObject) – Selection callback for application specificprocessing.

New in version NX7.5.4.

License requirements: None.