SelectFacetRegion Class¶
-
class
NXOpen.BlockStyler.
SelectFacetRegion
¶ Bases:
NXOpen.BlockStyler.UIBlock
Represents a Select Region Selection block
New in version NX12.0.0.
Properties¶
Property | Description |
---|---|
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 |
Cue | Returns or sets the Cue |
Enable | Returns or sets the Enable. |
EnabledFacetCollectionRules | Returns or sets these are the selection intent rules enabled for the facet selection region block |
Expanded | Returns or sets the Expanded |
FacetCollector | Returns or sets the owning facet collector is an object of class FacetCollector that holds collected facets of the block |
Group | Returns or sets the Group |
Label | Returns or sets the Label |
LabelString | Returns or sets the LabelString |
Name | Returns the name of the block or BlockID |
SelectedFacetCollectionRule | Returns or sets the active facet collection rule |
Show | Returns or sets the Visibility of block. |
StepStatusAsString | Returns or sets the StepStatus as string |
SupportedFacetTypes | Returns or sets these are type of facets enabled in filters for select facet region block |
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 |
GetLastDeselectedObjects | Gets the LastDeselectedFacetRegions |
GetLastSelectedObjects | Gets the LastSelectedFacetRegions |
GetProperties | Returns the properties of the block |
GetSelectedObjects | Gets the SelectedFacetRegions |
GetStepStatusMembers | Gets the StepStatus members |
SetSelectedObjects | Sets the SelectedFacetRegions |
Property Detail¶
AutomaticProgression¶
-
SelectFacetRegion.
AutomaticProgression
¶ Returns or sets the AutomaticProgression
-------------------------------------
Getter Method
Signature
AutomaticProgression
Returns: Return type: bool New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AutomaticProgression
Parameters: automaticProgression (bool) – New in version NX12.0.0.
License requirements: None.
BalloonTooltipImage¶
-
SelectFacetRegion.
BalloonTooltipImage
¶ Returns or sets the BalloonTooltipImage
-------------------------------------
Getter Method
Signature
BalloonTooltipImage
Returns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BalloonTooltipImage
Parameters: imageString (str) – New in version NX12.0.0.
License requirements: None.
BalloonTooltipLayoutAsString¶
-
SelectFacetRegion.
BalloonTooltipLayoutAsString
¶ Returns or sets the BalloonTooltipLayout as string
-------------------------------------
Getter Method
Signature
BalloonTooltipLayoutAsString
Returns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BalloonTooltipLayoutAsString
Parameters: enumString (str) – New in version NX12.0.0.
License requirements: None.
BalloonTooltipText¶
-
SelectFacetRegion.
BalloonTooltipText
¶ Returns or sets the BalloonTooltipText
-------------------------------------
Getter Method
Signature
BalloonTooltipText
Returns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BalloonTooltipText
Parameters: balloonTooltipText (str) – New in version NX12.0.0.
License requirements: None.
Bitmap¶
-
SelectFacetRegion.
Bitmap
¶ Returns or sets the Bitmap
-------------------------------------
Getter Method
Signature
Bitmap
Returns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Bitmap
Parameters: bitmapString (str) – New in version NX12.0.0.
License requirements: None.
Cue¶
-
SelectFacetRegion.
Cue
¶ Returns or sets the Cue
-------------------------------------
Getter Method
Signature
Cue
Returns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Cue
Parameters: cue (str) – New in version NX12.0.0.
License requirements: None.
EnabledFacetCollectionRules¶
-
SelectFacetRegion.
EnabledFacetCollectionRules
¶ Returns or sets these are the selection intent rules enabled for the facet selection region block
It returns the following bit values,
- 0x1 if only Single Facet rule is enabled,
- 0x2 if only Face Facets rule is enabled,
- 0x3 if only Flood Fill rule is enabled,
- 0x4 if only Color Region rule is enabled
-------------------------------------
Getter Method
Signature
EnabledFacetCollectionRules
Returns: bit value specifying enabled facet selection rules Return type: int New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
EnabledFacetCollectionRules
Parameters: rulesEnabled (int) – bit value specifying enabled facet selection rules New in version NX12.0.0.
License requirements: None.
FacetCollector¶
-
SelectFacetRegion.
FacetCollector
¶ Returns or sets the owning facet collector is an object of class
FacetCollector
that holds collected facets of the block-------------------------------------
Getter Method
Signature
FacetCollector
Returns: the facet collector object holding collection of the block Return type: NXOpen.FacetCollector
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FacetCollector
Parameters: facetCollector ( NXOpen.FacetCollector
) – the facet collector object holding collection of the blockNew in version NX12.0.0.
License requirements: None.
LabelString¶
-
SelectFacetRegion.
LabelString
¶ Returns or sets the LabelString
-------------------------------------
Getter Method
Signature
LabelString
Returns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LabelString
Parameters: labelString (str) – New in version NX12.0.0.
License requirements: None.
SelectedFacetCollectionRule¶
-
SelectFacetRegion.
SelectedFacetCollectionRule
¶ Returns or sets the active facet collection rule
-------------------------------------
Getter Method
Signature
SelectedFacetCollectionRule
Returns: value specifying selected facet selection rule Return type: int New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SelectedFacetCollectionRule
Parameters: selectedRule (int) – bit value specifying selected facet selection rule New in version NX12.0.0.
License requirements: None.
StepStatusAsString¶
-
SelectFacetRegion.
StepStatusAsString
¶ Returns or sets the StepStatus as string
-------------------------------------
Getter Method
Signature
StepStatusAsString
Returns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StepStatusAsString
Parameters: enumString (str) – New in version NX12.0.0.
License requirements: None.
SupportedFacetTypes¶
-
SelectFacetRegion.
SupportedFacetTypes
¶ Returns or sets these are type of facets enabled in filters for select facet region block
It returns following bits,
- 0x1 if only convergent facets are enabled,
- 0x2 if only NX facets are enabled,
- 0x3 if both convergent as well as NX facets are enabled.
-------------------------------------
Getter Method
Signature
SupportedFacetTypes
Returns: bit value specifying the desired types of facets to enable in filter Return type: int New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SupportedFacetTypes
Parameters: typesEnabled (int) – bit value specifying the desired types of facets to enable in filter New in version NX12.0.0.
License requirements: None.
ToolTip¶
-
SelectFacetRegion.
ToolTip
¶ Returns or sets the ToolTip
-------------------------------------
Getter Method
Signature
ToolTip
Returns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToolTip
Parameters: toolTip (str) – New in version NX12.0.0.
License requirements: None.
Method Detail¶
GetBalloonTooltipLayoutMembers¶
-
SelectFacetRegion.
GetBalloonTooltipLayoutMembers
¶ Gets the BalloonTooltipLayout members
Signature
GetBalloonTooltipLayoutMembers()
Returns: Value to get from the property. Return type: list of str New in version NX12.0.0.
License requirements: None.
GetLastDeselectedObjects¶
-
SelectFacetRegion.
GetLastDeselectedObjects
¶ Gets the LastDeselectedFacetRegions
Signature
GetLastDeselectedObjects()
Returns: Value to get from the property Return type: list of NXOpen.TaggedObject
New in version NX12.0.0.
License requirements: None.
GetLastSelectedObjects¶
-
SelectFacetRegion.
GetLastSelectedObjects
¶ Gets the LastSelectedFacetRegions
Signature
GetLastSelectedObjects()
Returns: Value to get from the property Return type: list of NXOpen.TaggedObject
New in version NX12.0.0.
License requirements: None.
GetSelectedObjects¶
-
SelectFacetRegion.
GetSelectedObjects
¶ Gets the SelectedFacetRegions
Signature
GetSelectedObjects()
Returns: Value to get from the property Return type: list of NXOpen.TaggedObject
New in version NX12.0.0.
License requirements: None.
GetStepStatusMembers¶
-
SelectFacetRegion.
GetStepStatusMembers
¶ Gets the StepStatus members
Signature
GetStepStatusMembers()
Returns: Value to get from the property Return type: list of str New in version NX12.0.0.
License requirements: None.
SetSelectedObjects¶
-
SelectFacetRegion.
SetSelectedObjects
¶ Sets the SelectedFacetRegions
Signature
SetSelectedObjects(objectVector)
Parameters: objectVector (list of NXOpen.TaggedObject
) – Value to set for the propertyNew in version NX12.0.0.
License requirements: None.