BCSelectionDisplayBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# BCSelectionDisplayBuilder Class

class `NXOpen.CAE.``BCSelectionDisplayBuilder`

  Bases: `NXOpen.Builder`

  This class provides BC Selection Visual Display support, use this class to get the BC types in current solution, adds special BCs to list, and display the BC’s selection geometry with the BC’s color to do visually check

  To create a new instance of this class, use `NXOpen.CAE.SimSimulation.CreateBcSelectionDisplayBuilder()`

  Default values.

  Property | Value
  --- | ---
  ShowExcludes | 0
  UseUnspecified | 1

  New in version NX10.0.0.

# Properties

Property | Description
--- | ---
ExcludesColor | Returns or sets the excludes target sets displayed color
OverlappingColor | Returns or sets the overlapping target sets displayed color
ShowExcludes | Returns or sets a value indicating how the BCs excluded Model objects will be displayed with the color set by `NXOpen.CAE.BCSelectionDisplayBuilder.ExcludesColor()`, if True they be displayed using the Excludes Color , if false they be displayed with default color
Tag | Returns the Tag for this object.
UnspecifiedColor | Returns or sets the unspecified color for target sets
UseUnspecified | Returns or sets a value indicating whether the builder will display polygonal geometry or mesh, which do not have these BCs specified on them, with the unspecified color

# Methods

Method | Description
--- | ---
AddToSelectedBCsList | Add BCs to the Selected BCs List
AskBCsByFilter | Return the BCs in the active solution using the specified filters
AskFamilyNamesByFilter | Returns the list of BC family names used in the current solution.
AskOverlappingBCs | Returns those BCs which have defined geometries overlapping within the input BCs list
AskSelectedBCsList | Ask all BCs in the Selected BCs List
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetObject | Returns the object currently being edited by this builder.
RemoveFromSelectedBCsList | Remove BCs from the Selected BCs List
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## ExcludesColor

`BCSelectionDisplayBuilder.``ExcludesColor`

  Returns or sets the excludes target sets displayed color

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

  Getter Method

  Signature `ExcludesColor`

  Returns: |
  Return type: | Id

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ExcludesColor`

  Parameters: | excludesColor (Id) –

  New in version NX10.0.0.

  License requirements: None.

## OverlappingColor

`BCSelectionDisplayBuilder.``OverlappingColor`

  Returns or sets the overlapping target sets displayed color

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

  Getter Method

  Signature `OverlappingColor`

  Returns: |
  Return type: | Id

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OverlappingColor`

  Parameters: | overlappingColor (Id) –

  New in version NX10.0.0.

  License requirements: None.

## ShowExcludes

`BCSelectionDisplayBuilder.``ShowExcludes`

  Returns or sets a value indicating how the BCs excluded Model objects will be displayed with the color set by `NXOpen.CAE.BCSelectionDisplayBuilder.ExcludesColor()`, if True they be displayed using the Excludes Color , if false they be displayed with default color

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

  Getter Method

  Signature `ShowExcludes`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ShowExcludes`

  Parameters: | showExcludesToggle (bool) –

  New in version NX10.0.0.

  License requirements: None.

## UnspecifiedColor

`BCSelectionDisplayBuilder.``UnspecifiedColor`

  Returns or sets the unspecified color for target sets

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

  Getter Method

  Signature `UnspecifiedColor`

  Returns: |
  Return type: | Id

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UnspecifiedColor`

  Parameters: | unspecifiedColor (Id) –

  New in version NX10.0.0.

  License requirements: None.

## UseUnspecified

`BCSelectionDisplayBuilder.``UseUnspecified`

  Returns or sets a value indicating whether the builder will display polygonal geometry or mesh, which do not have these BCs specified on them, with the unspecified color

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

  Getter Method

  Signature `UseUnspecified`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UseUnspecified`

  Parameters: | useUnspecifiedToggle (bool) –

  New in version NX10.0.0.

  License requirements: None.

# Method Detail

## AddToSelectedBCsList

`BCSelectionDisplayBuilder.``AddToSelectedBCsList`

  Add BCs to the Selected BCs List

  Signature `AddToSelectedBCsList(bcs)`

  Parameters: | bcs (list of `NXOpen.CAE.SimBC`) –

  New in version NX10.0.0.

  License requirements: None.

## AskBCsByFilter

`BCSelectionDisplayBuilder.``AskBCsByFilter`

  Return the BCs in the active solution using the specified filters

  Signature `AskBCsByFilter(loadFilter, constraintFilter, simObjFilter, familyFilterNames)`

  Parameters:

  - loadFilter (bool) – The load filter status
  - constraintFilter (bool) – The constraint filter status
  - simObjFilter (bool) – The simulation object filter status
  - familyFilterNames (str) – Family filter name, they can be found using `CAE.BCSelectionDisplayBuilder.AskFamilyNamesByFilter()`

  Returns: |
  Return type: | list of `NXOpen.CAE.SimBC`

  New in version NX10.0.0.

  License requirements: None.

## AskFamilyNamesByFilter

`BCSelectionDisplayBuilder.``AskFamilyNamesByFilter`

  Returns the list of BC family names used in the current solution.

  Use the returned names as a filter in `BCSelectionDisplayBuilder.AskBCsByFilter()` to get all the BCs with the same family name

  Signature `AskFamilyNamesByFilter(loadFilter, constraintFilter, simObjFilter)`

  Parameters:

  - loadFilter (bool) – If True, load family names will be included
  - constraintFilter (bool) – If True, constraint family names will be included
  - simObjFilter (bool) – If True, simulation object family names will be included

  Returns: | Current family names list, the first filter name will be “All”
  Return type: | list of str

  New in version NX10.0.0.

  License requirements: None.

## AskOverlappingBCs

`BCSelectionDisplayBuilder.``AskOverlappingBCs`

  Returns those BCs which have defined geometries overlapping within the input BCs list

  Signature `AskOverlappingBCs(bcs)`

  Parameters: | bcs (list of `NXOpen.CAE.SimBC`) – Candidate `CAE.SimBC` objects
  Returns: | Overlapping `CAE.SimBC` objects
  Return type: | list of `NXOpen.CAE.SimBC`

  New in version NX10.0.0.

  License requirements: None.

## AskSelectedBCsList

`BCSelectionDisplayBuilder.``AskSelectedBCsList`

  Ask all BCs in the Selected BCs List

  Signature `AskSelectedBCsList()`

  Returns: |
  Return type: | list of `NXOpen.CAE.SimBC`

  New in version NX10.0.0.

  License requirements: None.

## RemoveFromSelectedBCsList

`BCSelectionDisplayBuilder.``RemoveFromSelectedBCsList`

  Remove BCs from the Selected BCs List

  Signature `RemoveFromSelectedBCsList(bcs)`

  Parameters: | bcs (list of `NXOpen.CAE.SimBC`) –

  New in version NX10.0.0.

  License requirements: None.

## Validate

`BCSelectionDisplayBuilder.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.