FaceCollector Class — NXOpen Python API Reference 12.0.0 documentation

# FaceCollector Class

class `NXOpen.BlockStyler.``FaceCollector`

  Bases: `NXOpen.BlockStyler.UIBlock`

  Represents a Face Collector

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
AllowConvergentObject | Returns or sets the AllowConvergentObject
AutomaticProgression | Returns or sets the AutomaticProgression.
BalloonTooltipImage | Returns or sets the BalloonTooltipImage
BalloonTooltipLayoutAsString | Returns or sets the BalloonTooltipLayout as string
BalloonTooltipText | Returns or sets the BalloonTooltipText
Bitmap | Returns or sets the Bitmap
BlendVirtualCurveOverlay | Returns or sets the BlendVirtualCurveOverlay
CreateInterpartLink | Returns or sets the CreateInterpartLink
Cue | Returns or sets the Cue
DefaultFaceRulesAsString | Returns or sets the DefaultFaceRules as string
Enable | Returns or sets the Enable.
EntityType | Returns or sets the EntityType
Expanded | Returns or sets the Expanded
FaceRules | Returns or sets the FaceRules
Group | Returns or sets the Group
InterpartSelectionAsString | Returns or sets the InterpartSelection as string
Label | Returns or sets the Label
LabelString | Returns or sets the LabelString
MaximumScopeAsString | Returns or sets the MaximumScope
Name | Returns the name of the block or BlockID
PopupMenuEnabled | Returns or sets the PopupMenuEnabled
SelectModeAsString | Returns or sets the SelectMode as string
Show | Returns or sets the Visibility of block.
StepStatusAsString | Returns or sets the StepStatus as string
Tag | Returns the Tag for this object.
ToolTip | Returns or sets the ToolTip
Type | Returns the type of block

# Methods

Method | Description
--- | ---
Focus | Focuses on the block.
GetBalloonTooltipLayoutMembers | Gets the BalloonTooltipLayout members
GetDefaultFaceRulesMembers | Gets the DefaultFaceRules members
GetInterpartSelectionMembers | Gets the InterpartSelection members
GetProperties | Returns the properties of the block
GetSelectModeMembers | Gets the SelectMode members
GetSelectedObjects | Gets the SelectedObjects
GetStepStatusMembers | Gets the StepStatus members
SetSelectedObjects | Sets the SelectedObjects

# Property Detail

## AllowConvergentObject

`FaceCollector.``AllowConvergentObject`

  Returns or sets the AllowConvergentObject

  `-------------------------------------`

  Getter Method

  Signature `AllowConvergentObject`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `AllowConvergentObject`

  Parameters: | allowConvergentObject (bool) –

  New in version NX11.0.0.

  License requirements: None.

## AutomaticProgression

`FaceCollector.``AutomaticProgression`

  Returns or sets the AutomaticProgression.

  If true, focus automatically progresses to the next selection block.

  `-------------------------------------`

  Getter Method

  Signature `AutomaticProgression`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `AutomaticProgression`

  Parameters: | automaticProgression (bool) –

  New in version NX8.5.0.

  License requirements: None.

## BalloonTooltipImage

`FaceCollector.``BalloonTooltipImage`

  Returns or sets the BalloonTooltipImage

  `-------------------------------------`

  Getter Method

  Signature `BalloonTooltipImage`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `BalloonTooltipImage`

  Parameters: | imageString (str) –

  New in version NX8.5.0.

  License requirements: None.

## BalloonTooltipLayoutAsString

`FaceCollector.``BalloonTooltipLayoutAsString`

  Returns or sets the BalloonTooltipLayout as string

  `-------------------------------------`

  Getter Method

  Signature `BalloonTooltipLayoutAsString`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `BalloonTooltipLayoutAsString`

  Parameters: | enumString (str) –

  New in version NX8.5.0.

  License requirements: None.

## BalloonTooltipText

`FaceCollector.``BalloonTooltipText`

  Returns or sets the BalloonTooltipText

  `-------------------------------------`

  Getter Method

  Signature `BalloonTooltipText`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `BalloonTooltipText`

  Parameters: | balloonTooltipText (str) –

  New in version NX8.5.0.

  License requirements: None.

## Bitmap

`FaceCollector.``Bitmap`

  Returns or sets the Bitmap

  `-------------------------------------`

  Getter Method

  Signature `Bitmap`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Bitmap`

  Parameters: | bitmapString (str) –

  New in version NX8.5.0.

  License requirements: None.

## BlendVirtualCurveOverlay

`FaceCollector.``BlendVirtualCurveOverlay`

  Returns or sets the BlendVirtualCurveOverlay

  `-------------------------------------`

  Getter Method

  Signature `BlendVirtualCurveOverlay`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `BlendVirtualCurveOverlay`

  Parameters: | blendCurve (bool) –

  New in version NX8.5.0.

  License requirements: None.

## CreateInterpartLink

`FaceCollector.``CreateInterpartLink`

  Returns or sets the CreateInterpartLink

  `-------------------------------------`

  Getter Method

  Signature `CreateInterpartLink`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CreateInterpartLink`

  Parameters: | createLink (bool) –

  New in version NX8.5.0.

  License requirements: None.

## Cue

`FaceCollector.``Cue`

  Returns or sets the Cue

  `-------------------------------------`

  Getter Method

  Signature `Cue`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Cue`

  Parameters: | cue (str) –

  New in version NX8.5.0.

  License requirements: None.

## DefaultFaceRulesAsString

`FaceCollector.``DefaultFaceRulesAsString`

  Returns or sets the DefaultFaceRules as string

  `-------------------------------------`

  Getter Method

  Signature `DefaultFaceRulesAsString`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DefaultFaceRulesAsString`

  Parameters: | enumString (str) –

  New in version NX8.5.0.

  License requirements: None.

## EntityType

`FaceCollector.``EntityType`

  Returns or sets the EntityType

  `-------------------------------------`

  Getter Method

  Signature `EntityType`

  Returns: |
  Return type: | int

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `EntityType`

  Parameters: | entityType (int) –

  New in version NX8.5.0.

  License requirements: None.

## FaceRules

`FaceCollector.``FaceRules`

  Returns or sets the FaceRules

  `-------------------------------------`

  Getter Method

  Signature `FaceRules`

  Returns: |
  Return type: | int

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `FaceRules`

  Parameters: | faceRules (int) –

  New in version NX8.5.0.

  License requirements: None.

## InterpartSelectionAsString

`FaceCollector.``InterpartSelectionAsString`

  Returns or sets the InterpartSelection as string

  `-------------------------------------`

  Getter Method

  Signature `InterpartSelectionAsString`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `InterpartSelectionAsString`

  Parameters: | enumString (str) –

  New in version NX8.5.0.

  License requirements: None.

## LabelString

`FaceCollector.``LabelString`

  Returns or sets the LabelString

  `-------------------------------------`

  Getter Method

  Signature `LabelString`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `LabelString`

  Parameters: | labelString (str) –

  New in version NX8.5.0.

  License requirements: None.

## MaximumScopeAsString

`FaceCollector.``MaximumScopeAsString`

  Returns or sets the MaximumScope

  `-------------------------------------`

  Getter Method

  Signature `MaximumScopeAsString`

  Returns: |
  Return type: | str

  New in version NX11.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `MaximumScopeAsString`

  Parameters: | enumString (str) –

  New in version NX11.0.0.

  License requirements: None.

## PopupMenuEnabled

`FaceCollector.``PopupMenuEnabled`

  Returns or sets the PopupMenuEnabled

  `-------------------------------------`

  Getter Method

  Signature `PopupMenuEnabled`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `PopupMenuEnabled`

  Parameters: | enabled (bool) –

  New in version NX8.5.0.

  License requirements: None.

## SelectModeAsString

`FaceCollector.``SelectModeAsString`

  Returns or sets the SelectMode as string

  `-------------------------------------`

  Getter Method

  Signature `SelectModeAsString`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SelectModeAsString`

  Parameters: | enumString (str) –

  New in version NX8.5.0.

  License requirements: None.

## StepStatusAsString

`FaceCollector.``StepStatusAsString`

  Returns or sets the StepStatus as string

  `-------------------------------------`

  Getter Method

  Signature `StepStatusAsString`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `StepStatusAsString`

  Parameters: | enumString (str) –

  New in version NX8.5.0.

  License requirements: None.

## ToolTip

`FaceCollector.``ToolTip`

  Returns or sets the ToolTip

  `-------------------------------------`

  Getter Method

  Signature `ToolTip`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ToolTip`

  Parameters: | toolTip (str) –

  New in version NX8.5.0.

  License requirements: None.

# Method Detail

## GetBalloonTooltipLayoutMembers

`FaceCollector.``GetBalloonTooltipLayoutMembers`

  Gets the BalloonTooltipLayout members

  Signature `GetBalloonTooltipLayoutMembers()`

  Returns: | Value to get from the property.
  Return type: | list of str

  New in version NX8.5.0.

  License requirements: None.

## GetDefaultFaceRulesMembers

`FaceCollector.``GetDefaultFaceRulesMembers`

  Gets the DefaultFaceRules members

  Signature `GetDefaultFaceRulesMembers()`

  Returns: | Value to get from the property
  Return type: | list of str

  New in version NX8.5.0.

  License requirements: None.

## GetInterpartSelectionMembers

`FaceCollector.``GetInterpartSelectionMembers`

  Gets the InterpartSelection members

  Signature `GetInterpartSelectionMembers()`

  Returns: | Value to get from the property
  Return type: | list of str

  New in version NX8.5.0.

  License requirements: None.

## GetSelectModeMembers

`FaceCollector.``GetSelectModeMembers`

  Gets the SelectMode members

  Signature `GetSelectModeMembers()`

  Returns: | Value to get from the property
  Return type: | list of str

  New in version NX8.5.0.

  License requirements: None.

## GetSelectedObjects

`FaceCollector.``GetSelectedObjects`

  Gets the SelectedObjects

  Signature `GetSelectedObjects()`

  Returns: | Value to get from the property
  Return type: | list of `NXOpen.TaggedObject`

  New in version NX8.5.0.

  License requirements: None.

## GetStepStatusMembers

`FaceCollector.``GetStepStatusMembers`

  Gets the StepStatus members

  Signature `GetStepStatusMembers()`

  Returns: | Value to get from the property
  Return type: | list of str

  New in version NX8.5.0.

  License requirements: None.

## SetSelectedObjects

`FaceCollector.``SetSelectedObjects`

  Sets the SelectedObjects

  Signature `SetSelectedObjects(objectVector)`

  Parameters: | objectVector (list of `NXOpen.TaggedObject`) – Value to set for the property

  New in version NX8.5.0.

  License requirements: None.