NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Properties | List of all members
NXOpen.CAE.BCSelectionDisplayBuilder Class Reference

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 More...

Inheritance diagram for NXOpen.CAE.BCSelectionDisplayBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Member Functions

unsafe void AddToSelectedBCsList (NXOpen.CAE.SimBC[] bcs)
 Add BCs to the Selected BCs List More...
 
unsafe void AskBCsByFilter (bool loadFilter, bool constraintFilter, bool simObjFilter, string familyFilterNames, out NXOpen.CAE.SimBC[] bcs)
 Return the BCs in the active solution using the specified filters More...
 
unsafe string[] AskFamilyNamesByFilter (bool loadFilter, bool constraintFilter, bool simObjFilter)
 Returns the list of BC family names used in the current solution. More...
 
unsafe void AskOverlappingBCs (NXOpen.CAE.SimBC[] bcs, out NXOpen.CAE.SimBC[] overlappingBCs)
 Returns those BCs which have defined geometries overlapping within the input BCs list More...
 
unsafe void AskSelectedBCsList (out NXOpen.CAE.SimBC[] bcs)
 Ask all BCs in the Selected BCs List More...
 
unsafe void RemoveFromSelectedBCsList (NXOpen.CAE.SimBC[] bcs)
 Remove BCs from the Selected BCs List More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe NXOpen.NXColor ExcludesColor [get, set]
 Returns or sets the excludes target sets displayed color More...
 
unsafe NXOpen.NXColor OverlappingColor [get, set]
 Returns or sets the overlapping target sets displayed color More...
 
unsafe bool ShowExcludes [get, set]
 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 More...
 
unsafe NXOpen.NXColor UnspecifiedColor [get, set]
 Returns or sets the unspecified color for target sets More...
 
unsafe bool UseUnspecified [get, set]
 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 More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

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

Created in NX10.0.0

Member Function Documentation

unsafe void NXOpen.CAE.BCSelectionDisplayBuilder.AddToSelectedBCsList ( NXOpen.CAE.SimBC[]  bcs)
inline

Add BCs to the Selected BCs List

Created in NX10.0.0

License requirements: None.

Parameters
bcs
unsafe void NXOpen.CAE.BCSelectionDisplayBuilder.AskBCsByFilter ( bool  loadFilter,
bool  constraintFilter,
bool  simObjFilter,
string  familyFilterNames,
out NXOpen.CAE.SimBC[]  bcs 
)
inline

Return the BCs in the active solution using the specified filters

Created in NX10.0.0

License requirements: None.

Parameters
loadFilterThe load filter status
constraintFilterThe constraint filter status
simObjFilterThe simulation object filter status
familyFilterNamesFamily filter name, they can be found using CAE.BCSelectionDisplayBuilder.AskFamilyNamesByFilter
bcs
unsafe string [] NXOpen.CAE.BCSelectionDisplayBuilder.AskFamilyNamesByFilter ( bool  loadFilter,
bool  constraintFilter,
bool  simObjFilter 
)
inline

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

Created in NX10.0.0

License requirements: None.

Parameters
loadFilterIf True, load family names will be included
constraintFilterIf True, constraint family names will be included
simObjFilterIf True, simulation object family names will be included
Returns
Current family names list, the first filter name will be "All"
unsafe void NXOpen.CAE.BCSelectionDisplayBuilder.AskOverlappingBCs ( NXOpen.CAE.SimBC[]  bcs,
out NXOpen.CAE.SimBC[]  overlappingBCs 
)
inline

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

Created in NX10.0.0

License requirements: None.

Parameters
bcsCandidate CAE.SimBC objects
overlappingBCsOverlapping CAE.SimBC objects
unsafe void NXOpen.CAE.BCSelectionDisplayBuilder.AskSelectedBCsList ( out NXOpen.CAE.SimBC[]  bcs)
inline

Ask all BCs in the Selected BCs List

Created in NX10.0.0

License requirements: None.

Parameters
bcs
unsafe void NXOpen.CAE.BCSelectionDisplayBuilder.RemoveFromSelectedBCsList ( NXOpen.CAE.SimBC[]  bcs)
inline

Remove BCs from the Selected BCs List

Created in NX10.0.0

License requirements: None.

Parameters
bcs

Property Documentation

unsafe NXOpen.NXColor NXOpen.CAE.BCSelectionDisplayBuilder.ExcludesColor
getset

Returns or sets the excludes target sets displayed color

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.NXColor NXOpen.CAE.BCSelectionDisplayBuilder.OverlappingColor
getset

Returns or sets the overlapping target sets displayed color

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.CAE.BCSelectionDisplayBuilder.ShowExcludes
getset

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

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.NXColor NXOpen.CAE.BCSelectionDisplayBuilder.UnspecifiedColor
getset

Returns or sets the unspecified color for target sets

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.CAE.BCSelectionDisplayBuilder.UseUnspecified
getset

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

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.