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

Inheritance diagram for NXOpen::CAE::BCSelectionDisplayBuilder:

Public Member Functions
void	AddToSelectedBCsList (const std::vector< NXOpen::CAE::SimBC * > &bcs)
	Add BCs to the Selected BCs List Created in NX10.0.0. More...

void	AskBCsByFilter (bool loadFilter, bool constraintFilter, bool simObjFilter, const NXString &familyFilterNames, std::vector< NXOpen::CAE::SimBC * > &bcs)
	Return the BCs in the active solution using the specified filters Created in NX10.0.0. More...

void	AskBCsByFilter (bool loadFilter, bool constraintFilter, bool simObjFilter, const char familyFilterNames, std::vector< NXOpen::CAE::SimBC > &bcs)
	Return the BCs in the active solution using the specified filters Created in NX10.0.0. More...

std::vector< NXString >	AskFamilyNamesByFilter (bool loadFilter, bool constraintFilter, bool simObjFilter)
	Returns the list of BC family names used in the current solution. More...

void	AskOverlappingBCs (const std::vector< NXOpen::CAE::SimBC * > &bcs, std::vector< NXOpen::CAE::SimBC * > &overlappingBCs)
	Returns those BCs which have defined geometries overlapping within the input BCs list Created in NX10.0.0. More...

void	AskSelectedBCsList (std::vector< NXOpen::CAE::SimBC * > &bcs)
	Ask all BCs in the Selected BCs List Created in NX10.0.0. More...

NXOpen::NXColor *	ExcludesColor ()
	Returns the excludes target sets displayed color Created in NX10.0.0. More...

NXOpen::NXColor *	OverlappingColor ()
	Returns the overlapping target sets displayed color Created in NX10.0.0. More...

void	RemoveFromSelectedBCsList (const std::vector< NXOpen::CAE::SimBC * > &bcs)
	Remove BCs from the Selected BCs List Created in NX10.0.0. More...

void	SetExcludesColor (NXOpen::NXColor *excludesColor)
	Sets the excludes target sets displayed color Created in NX10.0.0. More...

void	SetOverlappingColor (NXOpen::NXColor *overlappingColor)
	Sets the overlapping target sets displayed color Created in NX10.0.0. More...

void	SetShowExcludes (bool showExcludesToggle)
	Sets a value indicating how the BCs excluded Model objects will be displayed with the color set by NXOpen::CAE::BCSelectionDisplayBuilder::SetExcludesColor , if True they be displayed using the Excludes Color , if false they be displayed with default color Created in NX10.0.0. More...

void	SetUnspecifiedColor (NXOpen::NXColor *unspecifiedColor)
	Sets the unspecified color for target sets Created in NX10.0.0. More...

void	SetUseUnspecified (bool useUnspecifiedToggle)
	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. More...

bool	ShowExcludes ()
	Returns a value indicating how the BCs excluded Model objects will be displayed with the color set by NXOpen::CAE::BCSelectionDisplayBuilder::SetExcludesColor , if True they be displayed using the Excludes Color , if false they be displayed with default color Created in NX10.0.0. More...

NXOpen::NXColor *	UnspecifiedColor ()
	Returns the unspecified color for target sets Created in NX10.0.0. More...

bool	UseUnspecified ()
	Returns 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. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. 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

void NXOpen::CAE::BCSelectionDisplayBuilder::AddToSelectedBCsList ( const std::vector< NXOpen::CAE::SimBC * > & bcs )

Add BCs to the Selected BCs List
Created in NX10.0.0.

License requirements : None

Parameters

bcs bcs

void NXOpen::CAE::BCSelectionDisplayBuilder::AskBCsByFilter	(	bool	loadFilter,
		bool	constraintFilter,
		bool	simObjFilter,
		const NXString &	familyFilterNames,
		std::vector< NXOpen::CAE::SimBC * > &	bcs
	)

Return the BCs in the active solution using the specified filters
Created in NX10.0.0.

License requirements : None

Parameters

loadFilter	The load filter status
constraintFilter	The constraint filter status
simObjFilter	The simulation object filter status
familyFilterNames	Family filter name, they can be found using CAE::BCSelectionDisplayBuilder::AskFamilyNamesByFilter
bcs	bcs

void NXOpen::CAE::BCSelectionDisplayBuilder::AskBCsByFilter	(	bool	loadFilter,
		bool	constraintFilter,
		bool	simObjFilter,
		const char *	familyFilterNames,
		std::vector< NXOpen::CAE::SimBC * > &	bcs
	)

Return the BCs in the active solution using the specified filters
Created in NX10.0.0.

License requirements : None

Parameters

loadFilter	The load filter status
constraintFilter	The constraint filter status
simObjFilter	The simulation object filter status
familyFilterNames	Family filter name, they can be found using CAE::BCSelectionDisplayBuilder::AskFamilyNamesByFilter
bcs	bcs

std::vector<NXString> NXOpen::CAE::BCSelectionDisplayBuilder::AskFamilyNamesByFilter	(	bool	loadFilter,
		bool	constraintFilter,
		bool	simObjFilter
	)

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

Returns: Current family names list, the first filter name will be "All"
Created in NX10.0.0.

License requirements : None

Parameters

loadFilter	If True, load family names will be included
constraintFilter	If True, constraint family names will be included
simObjFilter	If True, simulation object family names will be included

void NXOpen::CAE::BCSelectionDisplayBuilder::AskOverlappingBCs	(	const std::vector< NXOpen::CAE::SimBC * > &	bcs,
		std::vector< NXOpen::CAE::SimBC * > &	overlappingBCs
	)

Returns those BCs which have defined geometries overlapping within the input BCs list
Created in NX10.0.0.

License requirements : None

Parameters

bcs	Candidate CAE::SimBC objects
overlappingBCs	Overlapping CAE::SimBC objects

void NXOpen::CAE::BCSelectionDisplayBuilder::AskSelectedBCsList ( std::vector< NXOpen::CAE::SimBC * > & bcs )

Ask all BCs in the Selected BCs List
Created in NX10.0.0.

License requirements : None

Parameters

bcs bcs

NXOpen::NXColor* NXOpen::CAE::BCSelectionDisplayBuilder::ExcludesColor ( )

Returns the excludes target sets displayed color
Created in NX10.0.0.

License requirements : None

NXOpen::NXColor* NXOpen::CAE::BCSelectionDisplayBuilder::OverlappingColor ( )

Returns the overlapping target sets displayed color
Created in NX10.0.0.

License requirements : None

void NXOpen::CAE::BCSelectionDisplayBuilder::RemoveFromSelectedBCsList ( const std::vector< NXOpen::CAE::SimBC * > & bcs )

Remove BCs from the Selected BCs List
Created in NX10.0.0.

License requirements : None

Parameters

bcs bcs

void NXOpen::CAE::BCSelectionDisplayBuilder::SetExcludesColor ( NXOpen::NXColor * excludesColor )

Sets the excludes target sets displayed color
Created in NX10.0.0.

License requirements : None

Parameters

excludesColor excludescolor

void NXOpen::CAE::BCSelectionDisplayBuilder::SetOverlappingColor ( NXOpen::NXColor * overlappingColor )

Sets the overlapping target sets displayed color
Created in NX10.0.0.

License requirements : None

Parameters

overlappingColor overlappingcolor

void NXOpen::CAE::BCSelectionDisplayBuilder::SetShowExcludes ( bool showExcludesToggle )

Sets a value indicating how the BCs excluded Model objects will be displayed with the color set by NXOpen::CAE::BCSelectionDisplayBuilder::SetExcludesColor , if True they be displayed using the Excludes Color , if false they be displayed with default color
Created in NX10.0.0.

License requirements : None

Parameters

showExcludesToggle showexcludestoggle

void NXOpen::CAE::BCSelectionDisplayBuilder::SetUnspecifiedColor ( NXOpen::NXColor * unspecifiedColor )

Sets the unspecified color for target sets
Created in NX10.0.0.

License requirements : None

Parameters

unspecifiedColor unspecifiedcolor

void NXOpen::CAE::BCSelectionDisplayBuilder::SetUseUnspecified ( bool useUnspecifiedToggle )

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 : None

Parameters

useUnspecifiedToggle useunspecifiedtoggle

bool NXOpen::CAE::BCSelectionDisplayBuilder::ShowExcludes ( )

Returns a value indicating how the BCs excluded Model objects will be displayed with the color set by NXOpen::CAE::BCSelectionDisplayBuilder::SetExcludesColor , if True they be displayed using the Excludes Color , if false they be displayed with default color
Created in NX10.0.0.

License requirements : None

NXOpen::NXColor* NXOpen::CAE::BCSelectionDisplayBuilder::UnspecifiedColor ( )

Returns the unspecified color for target sets
Created in NX10.0.0.

License requirements : None

bool NXOpen::CAE::BCSelectionDisplayBuilder::UseUnspecified ( )

Returns 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 : None

The documentation for this class was generated from the following file:

CAE_BCSelectionDisplayBuilder.hxx

Public Member Functions

Detailed Description

Member Function Documentation