SuperPoint Class — NXOpen Python API Reference 12.0.0 documentation

# SuperPoint Class

class `NXOpen.BlockStyler.``SuperPoint`

  Bases: `NXOpen.BlockStyler.UIBlock`

  Represents a Super Point block

  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
CurveRules | Returns or sets the CurveRules
DefaultCurveRulesAsString | Returns or sets the DefaultCurveRules as string
Enable | Returns or sets the Enable.
EntityType | Returns or sets the EntityType
Expanded | Returns or sets the Expanded
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
Name | Returns the name of the block or BlockID
PointOverlay | Returns or sets the PointOverlay
Show | Returns or sets the Visibility of block.
ShowFlowDirectionAndOriginCurve | Returns or sets the ShowFlowDirectionAndOriginCurve
SketchOnPath | Returns or sets the SketchOnPath
SnapPointTypesEnabled | Returns or sets the SnapPointTypesEnabled
SnapPointTypesOnByDefault | Returns or sets the SnapPointTypesOnByDefault
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
GetDefaultCurveRulesMembers | Gets the DefaultCurveRules members
GetInterpartSelectionMembers | Gets the InterpartSelection members
GetProperties | Returns the properties of the block
GetSelectedObjects | Gets the SelectedObjects
GetStepStatusMembers | Gets the StepStatus members
SetSelectedObjects | Sets the SelectedObjects

# Property Detail

## AllowConvergentObject

`SuperPoint.``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

`SuperPoint.``AutomaticProgression`

  Returns or sets the AutomaticProgression

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

  Getter Method

  Signature `AutomaticProgression`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AutomaticProgression`

  Parameters: | automaticProgression (bool) –

  New in version NX9.0.0.

  License requirements: None.

## BalloonTooltipImage

`SuperPoint.``BalloonTooltipImage`

  Returns or sets the BalloonTooltipImage

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

  Getter Method

  Signature `BalloonTooltipImage`

  Returns: |
  Return type: | str

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `BalloonTooltipImage`

  Parameters: | imageString (str) –

  New in version NX9.0.0.

  License requirements: None.

## BalloonTooltipLayoutAsString

`SuperPoint.``BalloonTooltipLayoutAsString`

  Returns or sets the BalloonTooltipLayout as string

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

  Getter Method

  Signature `BalloonTooltipLayoutAsString`

  Returns: |
  Return type: | str

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `BalloonTooltipLayoutAsString`

  Parameters: | enumString (str) –

  New in version NX9.0.0.

  License requirements: None.

## BalloonTooltipText

`SuperPoint.``BalloonTooltipText`

  Returns or sets the BalloonTooltipText

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

  Getter Method

  Signature `BalloonTooltipText`

  Returns: |
  Return type: | str

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `BalloonTooltipText`

  Parameters: | balloonTooltipText (str) –

  New in version NX9.0.0.

  License requirements: None.

## Bitmap

`SuperPoint.``Bitmap`

  Returns or sets the Bitmap

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

  Getter Method

  Signature `Bitmap`

  Returns: |
  Return type: | str

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Bitmap`

  Parameters: | bitmapString (str) –

  New in version NX9.0.0.

  License requirements: None.

## BlendVirtualCurveOverlay

`SuperPoint.``BlendVirtualCurveOverlay`

  Returns or sets the BlendVirtualCurveOverlay.

  If true, virtual curve is displayed during preselection.

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

  Getter Method

  Signature `BlendVirtualCurveOverlay`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `BlendVirtualCurveOverlay`

  Parameters: | blendCurve (bool) –

  New in version NX9.0.0.

  License requirements: None.

## CreateInterpartLink

`SuperPoint.``CreateInterpartLink`

  Returns or sets the CreateInterpartLink

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

  Getter Method

  Signature `CreateInterpartLink`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CreateInterpartLink`

  Parameters: | createLink (bool) –

  New in version NX9.0.0.

  License requirements: None.

## Cue

`SuperPoint.``Cue`

  Returns or sets the Cue

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

  Getter Method

  Signature `Cue`

  Returns: |
  Return type: | str

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Cue`

  Parameters: | cue (str) –

  New in version NX9.0.0.

  License requirements: None.

## CurveRules

`SuperPoint.``CurveRules`

  Returns or sets the CurveRules

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

  Getter Method

  Signature `CurveRules`

  Returns: |
  Return type: | int

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CurveRules`

  Parameters: | curveRules (int) –

  New in version NX9.0.0.

  License requirements: None.

## DefaultCurveRulesAsString

`SuperPoint.``DefaultCurveRulesAsString`

  Returns or sets the DefaultCurveRules as string

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

  Getter Method

  Signature `DefaultCurveRulesAsString`

  Returns: |
  Return type: | str

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DefaultCurveRulesAsString`

  Parameters: | enumString (str) –

  New in version NX9.0.0.

  License requirements: None.

## EntityType

`SuperPoint.``EntityType`

  Returns or sets the EntityType

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

  Getter Method

  Signature `EntityType`

  Returns: |
  Return type: | int

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `EntityType`

  Parameters: | entityType (int) –

  New in version NX9.0.0.

  License requirements: None.

## InterpartSelectionAsString

`SuperPoint.``InterpartSelectionAsString`

  Returns or sets the InterpartSelection as string

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

  Getter Method

  Signature `InterpartSelectionAsString`

  Returns: |
  Return type: | str

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `InterpartSelectionAsString`

  Parameters: | enumString (str) –

  New in version NX9.0.0.

  License requirements: None.

## LabelString

`SuperPoint.``LabelString`

  Returns or sets the LabelString

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

  Getter Method

  Signature `LabelString`

  Returns: |
  Return type: | str

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `LabelString`

  Parameters: | labelString (str) –

  New in version NX9.0.0.

  License requirements: None.

## PointOverlay

`SuperPoint.``PointOverlay`

  Returns or sets the PointOverlay

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

  Getter Method

  Signature `PointOverlay`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PointOverlay`

  Parameters: | overlay (bool) –

  New in version NX9.0.0.

  License requirements: None.

## ShowFlowDirectionAndOriginCurve

`SuperPoint.``ShowFlowDirectionAndOriginCurve`

  Returns or sets the ShowFlowDirectionAndOriginCurve

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

  Getter Method

  Signature `ShowFlowDirectionAndOriginCurve`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ShowFlowDirectionAndOriginCurve`

  Parameters: | show (bool) –

  New in version NX9.0.0.

  License requirements: None.

## SketchOnPath

`SuperPoint.``SketchOnPath`

  Returns or sets the SketchOnPath

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

  Getter Method

  Signature `SketchOnPath`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SketchOnPath`

  Parameters: | sketchOnPath (bool) –

  New in version NX9.0.0.

  License requirements: None.

## SnapPointTypesEnabled

`SuperPoint.``SnapPointTypesEnabled`

  Returns or sets the SnapPointTypesEnabled

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

  Getter Method

  Signature `SnapPointTypesEnabled`

  Returns: |
  Return type: | int

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SnapPointTypesEnabled`

  Parameters: | snapPointType (int) –

  New in version NX9.0.0.

  License requirements: None.

## SnapPointTypesOnByDefault

`SuperPoint.``SnapPointTypesOnByDefault`

  Returns or sets the SnapPointTypesOnByDefault

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

  Getter Method

  Signature `SnapPointTypesOnByDefault`

  Returns: |
  Return type: | int

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SnapPointTypesOnByDefault`

  Parameters: | defaultSnapPointType (int) –

  New in version NX9.0.0.

  License requirements: None.

## StepStatusAsString

`SuperPoint.``StepStatusAsString`

  Returns or sets the StepStatus as string

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

  Getter Method

  Signature `StepStatusAsString`

  Returns: |
  Return type: | str

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `StepStatusAsString`

  Parameters: | enumString (str) –

  New in version NX9.0.0.

  License requirements: None.

## ToolTip

`SuperPoint.``ToolTip`

  Returns or sets the ToolTip

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

  Getter Method

  Signature `ToolTip`

  Returns: |
  Return type: | str

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ToolTip`

  Parameters: | toolTip (str) –

  New in version NX9.0.0.

  License requirements: None.

# Method Detail

## GetBalloonTooltipLayoutMembers

`SuperPoint.``GetBalloonTooltipLayoutMembers`

  Gets the BalloonTooltipLayout members

  Signature `GetBalloonTooltipLayoutMembers()`

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

  New in version NX9.0.0.

  License requirements: None.

## GetDefaultCurveRulesMembers

`SuperPoint.``GetDefaultCurveRulesMembers`

  Gets the DefaultCurveRules members

  Signature `GetDefaultCurveRulesMembers()`

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

  New in version NX9.0.0.

  License requirements: None.

## GetInterpartSelectionMembers

`SuperPoint.``GetInterpartSelectionMembers`

  Gets the InterpartSelection members

  Signature `GetInterpartSelectionMembers()`

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

  New in version NX9.0.0.

  License requirements: None.

## GetSelectedObjects

`SuperPoint.``GetSelectedObjects`

  Gets the SelectedObjects

  Signature `GetSelectedObjects()`

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

  New in version NX9.0.0.

  License requirements: None.

## GetStepStatusMembers

`SuperPoint.``GetStepStatusMembers`

  Gets the StepStatus members

  Signature `GetStepStatusMembers()`

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

  New in version NX9.0.0.

  License requirements: None.

## SetSelectedObjects

`SuperPoint.``SetSelectedObjects`

  Sets the SelectedObjects

  Signature `SetSelectedObjects(objectVector)`

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

  New in version NX9.0.0.

  License requirements: None.